Skip to content

Add * support for @Available directive #969

Open
@anferbui

Description

@anferbui

Feature Name

Support platform name * in @Available directive

Description

We've added support for introduced and deprecated for the @Available directive in #440 and #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:
#851 (comment)

Importance

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

Alternatives Considered

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementImprovements or enhancements to existing functionality

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions