search

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

Deprecated Objective-C methods not being marked as Deprecated #963

Open louwers opened 1 week ago

louwers commented 1 week ago

Feature Name

Interpret Objective-C Deprecated Attribute

Description

For example:

+ (instancetype)cameraLookingAtCenterCoordinate:(CLLocationCoordinate2D)centerCoordinate
                                   fromDistance:(CLLocationDistance)distance
                                          pitch:(CGFloat)pitch
                                        heading:(CLLocationDirection)heading
    __attribute__((deprecated("Use -cameraLookingAtCenterCoordinate:acrossDistance:pitch:heading: "
                              "or -cameraLookingAtCenterCoordinate:altitude:pitch:heading:.")));

Does not show up as deprecated in the documentation.

Motivation

Right now, it seems deprecated Objective-C methods (marked with an attribute) are not marked as such in the generated documentation.

Importance

Somewhat important for Objective-C documentation.

Alternatives Considered

I am not even sure how to work around this.