Skip to content

Swift-DocC-Plugin 1.4.0

Compare
Choose a tag to compare
@d-ronnqvist d-ronnqvist released this 23 Aug 08:34
· 5 commits to main since this release
a255bbd

What's Changed

  • You can now customize the minimal access level of symbols to include in your documentation. The default access level continues to be "public" for libraries and "internal" for executables. To specify a custom minimal access level, pass the new --symbol-graph-minimum-access-level flag:

    swift package generate documentation \
      --symbol-graph-minimum-access-level internal \
      --target [target-name]
    
  • You can now generate a combined documentation archive with the documentation for multiple targets when building with Swift 6.0 or later. Each target's documentation can link to its target dependencies' documentation. This is an opt-in, experimental feature that can used by passing the --enable-experimental-combined-documentation flag:

    swift package generate documentation \
      --enable-experimental-combined-documentation \
      --target [first-target-name] \
      --target [second-target-name] \
    
  • Using a custom --output-path when building documentation for more than one target no longer causes one target to write over the output of the other target. Instead, both targets write their output in subdirectories of the specified output path. When building documentation for a single target, or when building combined documentation, the plugin continues to write the output directly to the specified output path.

  • The help text in swift package generate-documentation --help now includes information about all the DocC options. The help text also organizes the symbol graph options into its own section.


The 1.4.0 release includes contributions from @natikgadzhi, @d-ronnqvist, @JessyCatterwaul, @joey-gm, @dabrahams, @parispittman, @SwiftCoderJoe, and @Kyle-Ye. Thank you!