apple / swift-docc

Documentation compiler that produces rich API reference documentation and interactive tutorials for your Swift framework or package.
https://swift.org/documentation/docc
Apache License 2.0
1.14k stars 118 forks source link

Add `*` support for `@Available` directive #969

Open anferbui opened 4 days ago

anferbui commented 4 days ago

Feature Name

Support platform name * in @Available directive

Description

We've added support for introduced and deprecated for the @Available directive in https://github.com/apple/swift-docc/pull/440 and https://github.com/apple/swift-docc/issues/441.

We should also add support for * as a value for the platform name, as currently it's not supported: https://github.com/apple/swift-docc/blob/f019ab8e2e0370d8f95921d4b8f1f7309c4eedbc/Sources/SwiftDocC/Semantics/Metadata/Availability.swift#L66-L69

This would potentially be used like:

@Available(*, introduced: "1.0")

Motivation

We should add support for * as a platform name to better reflect that a large number of packages work on Linux and Windows and anywhere else where Swift is supported.

More context here: https://github.com/apple/swift-docc/pull/851#issuecomment-2163550785

Importance

The @Available directive is missing some functionality until we implement this feature.

Alternatives Considered

No response