Skip to content

Tags: swiftlang/swift-docc-plugin

Tags

1.4.3

Toggle 1.4.3's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Fix a bug where targets with multiple dependencies was only passed on…

…e dependency (#98)

* Refine command line argument types to define flag/option specific names

This means that flag/option specific API can leverage types instead of including "flag" or "option" in the API's name.
This also means that a named option requires a value to create an argument.

Co-authored-by: Sofía Rodríguez <sofia_rodriguez@apple.com>

* Support defining an option that supports an array of values.

Also, define `--dependency` as an array-of-values option.

Co-authored-by: Sofía Rodríguez <sofia_rodriguez@apple.com>

* Fix a logic bug where an alternate argument spellings with common prefixes would sometimes not extract a value.

* Move the inverse names configuration into CommandLineArgument.Flag

* Add integration test that verifies that targets are passed all their dependencies

* Use the CommandLineArguments type to construct the merge arguments

* Print the 'docc merge' call when the `--verbose` flag is passed

* Fix an unrelated code warning in Swift 5.7

* Fix an unrelated code warning and avoid undefined behavior in snippet-extract

* Correctly document updated parameters

Co-authored-by: Sofía Rodríguez <sofia_rodriguez@apple.com>

* Fix other unrelated documentation warnings

---------

Co-authored-by: Sofía Rodríguez <sofia_rodriguez@apple.com>

1.4.2

Toggle 1.4.2's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Fix backwards compatibility issue with Swift 5.7 (#96)

* Fix backwards compatibility issue with Swift 5.7.
swift-docc-plugin was not building with Swift 5.7 due to using newer syntax which did not exist yet. Fixes the compilation issues to use older Swift syntax.

* Set minimum supported version to Swift 5.7.
swift-docc-plugin does not support Swift 5.6 -- increasing the tool version in Package.swift to clearly indicate this.

---

Fixes #94 and rdar://134859979.

1.4.1

Toggle 1.4.1's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Avoid using `NSLock.withLock` because Linux doesn't support it before…

… Swift 6.0 (#93)

1.4.0

Toggle 1.4.0's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Support `--output-path` when building documentation for multiple targ…

…ets. (#89)

* Support using a custom `--output-path` when building a combined archive

Also, print all archive output paths at the end instead of during build

* Customize the synthesized landing page when DocC supports it

* Provide more information about the steps for each target's build task

* Support `--output-path` with multiple targets, even without combined documentation

* Add integration tests for building combined documentation

* Build documentation for different targets concurrently

* Code review feedback: move sorting archives to where it's used

* Remove unused local variable

* Code review feedback: simplify creation of DocCFeatures

* Code review feedback: move assertion for better locality with the potential bug.

* Fix bug in test helper where other log output was sometimes parsed as an archive output path

* Update integration tests to reflect new DocC behavior (synthesized landing pages for combined archives)

1.3.0

Toggle 1.3.0's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Make --include-extended-types default for Swift 5.9 (#57)

* make --include-extended-types default for Swift 5.9 and introduce --exclude-extended-types flag

* address review comments
 - mention default behavior earlier in docs
 - be more precise about method/function terminology in docs

1.2.0

Toggle 1.2.0's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Add experimental flag for skipping synthesized symbols (#28)

Adds support for the generation of DocC archives without synthesized
symbols by passing a new, experimental, plugin flag
`--experimental-skip-synthesized-symbols`.

Enabling this flag does not transform or post-process any of the passed
arguments but overrides the default value of
`symbolGraphOptions.includeSynthesized` that is provided to SwiftPM to false.

1.1.0

Toggle 1.1.0's commit message
Tag version 1.1.0

This time, with new upstream SymbolKit version 1.0.0.

1.0.0

Toggle 1.0.0's commit message
Initial release.