This repository was archived by the owner on Jun 1, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 98
Support for @available attributes Β #105
Copy link
Copy link
Open
Labels
designFunctionality with a design componentFunctionality with a design componentenhancementNew feature or requestNew feature or request
Milestone
Description
Currently, swift-doc only shows the @available(...
grouped together with the code
Would it be possible for swift-doc to support @available
attributes, so that end users can see which protocols, functions, etc are no longer supported?
I've come with some Acceptance Criteria of sorts that I think is needed.
@available(...
should be split out from the main code description- Certain attributes (like
deprecated
) should be shown with theDeprecated
marker similar to Apple Docs ex: https://developer.apple.com/documentation/uikit/uiactionsheet - Certain attributes (like
renamed
) should also show a warning section with the string at the top of the view. ex: https://developer.apple.com/documentation/security/secaccesscontrolcreateflags/1617988-touchidany - Anywhere we show the property and it's
deprecated
we should strikethrough. ex: https://developer.apple.com/documentation/uikit/uiactionsheet
sindresorhus
Metadata
Metadata
Assignees
Labels
designFunctionality with a design componentFunctionality with a design componentenhancementNew feature or requestNew feature or request