All Versions
12
Latest Version
Avg Release Cycle
94 days
Latest Release
963 days ago

Changelog History
Page 1

  • v1.2.1 Changes

    July 31, 2020

    🐛 Bug Fixes

    • 🚀 Prepare release 1.2.1 (#62)

  • v1.2.0 Changes

    June 04, 2020

    ✨ Enhancements

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

    Other

    • ✂ Remove blockquote from docummentation summary

  • v1.1.0 Changes

    May 27, 2020

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

  • v1.0.0 Changes

    May 11, 2020

    💥 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 analyze 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

  • v0.6.1 Changes

    November 03, 2019

    💥 Breaking

    • None

    ✨ Enhancements

    • None

    🐛 Bug Fixes

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

  • v0.6.0 Changes

    November 01, 2019

    💥 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

  • v0.5.1 Changes

    September 26, 2018

    💥 Breaking

    • None

    ✨ Enhancements

    • None

    🐛 Bug Fixes

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

  • v0.5.0 Changes

    November 14, 2017

    💥 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

  • v0.4.0 Changes

    October 25, 2017

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

  • v0.3.0 Changes

    October 09, 2017

    💥 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