- None
- None
- None
- Updates required for Xcode 13.3 + Swift 5.6
- Bump dependencies
- Remove dependency on SwiftPM module for package dump decoding
- Updates required for Xcode 13
- Fix issue with
Systemlibrary renamed toProcessRunner(#60)
- Add
--no-clustersflag to toggle clusters on/off (#55)
- Remove blockquote from docummentation summary
- None
- New
--all-modulesparameter to generate documentation for all swift modules in a package (#49) - New
--reproducible-docsparameter to generate reproducible documentation (#51)
- Fix issue #50, where nested types where documented out of their parent context (#51)
- Add
SourceDocsLibso it can be used by other Swift tools to generate documentation. - SourceDocs now requires Swift 5.1 or higher
- New
packagecommand to analytize and document Swift packages. - Migrated from
CommandanttoSwift Argument Parserfor command line parsing.
- Fix issue #43 preventing GitHub pages from being generated
- None
- None
- Fix
--min-aclparameter (#33)
- SourceDocs now requires Swift 5.0 or higher
- Add ability to pass in link ending text as a parameter (#20)
- Add ability to specify input folder (#20)
- Add customizable file beginning (#20)
- Add 'min-acl' to let users determine the minimum access level to generate the documentation (#28)
- None
- None
- None
- Cannot be installed via Homebrew on Mojave (#10)
- None
- Enable collapsible blocks for a cleaner output with
--collapsible. - Enable table of contents for each type with
--table-of-contents.
- None
- Updated command line argument handling:
- Use
sourcedocs generate <options>to generate documentation. - Use
sourcedocs clean <options>to delete the output folder. - Use
sourcedocs help <command>for more help.
- Use
- Update default output directory to
Documentation/Reference
- Customize output folder with
--output-folder. - Clean output before generating documentation with
--clean. - Terminal output is now routed through stdout/stderr.
- Removed "Declaration" title to reduce noise.
- New flag
--module-name-pathto explicitly include module name in output path.
- Documentation links now work both on Markdown and rendered GitHub Pages.
- None
- Use MarkdownGenerator framework to generate Markdown output.
- Remove inferred type from output to reduce noise.
- Add contents table for structs, classes and enums.
- Comment output is now block-quoted for better formatting.
- Green checkmarks when writing Markdown files to disk.
- Remove
<sub>HTML tags for a cleaner Markdown output. - Remove horizontal guides to reduce noise.
- None
- Update output directory to
Docs/Referenceto follow Swift Package Manager naming conventions for the project folder structure.
- Add
--cleanoption to remove Reference Docs folder - Add
--versionoption to display current version - Update
--helpcommand - Add
Makefilefor easier manual build and installation
- None
- Initial Release