swift-doc v1.0.0-beta.6 Release Notes

Release Date: 2021-04-24 // 9 months ago
  • ➕ Added

    • ➕ Added support for generating documentation for extensions to external types. #230 by @Lukas-Stuehrk and @mattt.
    • ➕ Added support for generating documentation for operators. #228 by @Lukas-Stuehrk and @mattt.
    • ➕ Added end-to-end tests for command-line interface. #199 by @MaxDesiatov and @mattt.
    • ➕ Added --minimum-access-level option to generate and coverage commands. #219 by @Lukas-Stuehrk.
    • ➕ Added support for documenting default implementations. #221 by @Lukas-Stuehrk.
    • ➕ Added sourceRange property to Symbol. #237 by @mattt.

    🛠 Fixed

    • 🛠 Fixed public extensions exposing nested code of all access levels. #195 by @Tunous.
    • 🛠 Fixed broken links in the relationship graph. #226 by @Lukas-Stuehrk.

    🔄 Changed

    • 💥 Breaking Change Changed minimum Swift version requirements to 5.3 or later. #252 by @mattt.
    • 🔄 Changed display of code declarations in HTML. #204 by @mattt.
    • 🔄 Changed serialization of Symbol to encode and decode sourceRange key instead of sourceLocation key. #237 by @mattt.
    • 🔄 Changed commands to warn when invalid paths are passed. #242 by @Lukas-Stuehrk.

    🗄 Deprecated

    • 🗄 Deprecated Symbol.sourceLocation property. Use Symbol.sourceRange.start instead. #237 by @mattt.
    • 🔄 Changed the generate command to skip hidden files and top-level Tests directories. #229 by @mattt.

Previous changes from v1.0.0-beta.5

  • ➕ Added

    🛠 Fixed

    • 🛠 Fixed missing GraphViz dependency in Dockerfile.
      #180 by @MaxDesiatov.
    • 🛠 Fixed listing of function parameters, when generating CommonMark documentation.
      #170 by @domcorvasce.
    • 🛠 Fixed version number for swift-doc command.
      #159 by @mattt.
    • 🛠 Fixed relationship diagram to prevent linking to unknown symbols.
      #178 by @MattKiazyk.
    • 🛠 Fixed problems in CommonMark output related to escaping emoji shortcode.
      #167 by @mattt.

    🔄 Changed