CHANGELOG.md

Master

Breaking

• None

Enhancements

• None

Bug Fixes

• None

2.0.1

• Updates required for Xcode 13.3 + Swift 5.6
• Bump dependencies

2.0.0

• Remove dependency on SwiftPM module for package dump decoding
• Updates required for Xcode 13

1.2.1

Bug Fixes

• Fix issue with System library renamed to ProcessRunner (#60)

1.2.0

Enhancements

• Add --no-clusters flag to toggle clusters on/off (#55)

Other

• Remove blockquote from docummentation summary

1.1.0

Breaking

• None

Enhancements

• New --all-modules parameter to generate documentation for all swift modules in a package (#49)
• New --reproducible-docs parameter to generate reproducible documentation (#51)

Bug Fixes

• Fix issue #50, where nested types where documented out of their parent context (#51)

1.0.0

Breaking

• Add SourceDocsLib so it can be used by other Swift tools to generate documentation.
• SourceDocs now requires Swift 5.1 or higher

Enhancements

• New package command to analytize and document Swift packages.
• Migrated from Commandant to Swift Argument Parser for command line parsing.

Bug Fixes

• Fix issue #43 preventing GitHub pages from being generated

0.6.1

Breaking

• None

Enhancements

• None

Bug Fixes

• Fix --min-acl parameter (#33)

0.6.0

Breaking

• SourceDocs now requires Swift 5.0 or higher

Enhancements

• 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)

Bug Fixes

• None

0.5.1

Breaking

• None

Enhancements

• None

Bug Fixes

• Cannot be installed via Homebrew on Mojave (#10)

0.5.0

Breaking

• None

Enhancements

• Enable collapsible blocks for a cleaner output with --collapsible.
• Enable table of contents for each type with --table-of-contents.

Bug Fixes

• None

0.4.0

Breaking

• 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.
• Update default output directory to Documentation/Reference

Enhancements

• 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-path to explicitly include module name in output path.

Bug Fixes

• Documentation links now work both on Markdown and rendered GitHub Pages.

0.3.0

Breaking

• None

Enhancements

• 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.

Bug Fixes

• None

0.2.0

Breaking

• Update output directory to Docs/Reference to follow Swift Package Manager naming conventions for the project folder structure.

Enhancements

• Add --clean option to remove Reference Docs folder
• Add --version option to display current version
• Update --help command
• Add Makefile for easier manual build and installation

Bug Fixes

• None

0.1.0

• Initial Release