swiftlang / swift-docc-plugin

Swift Package Manager command plugin for Swift-DocC
https://swiftpackageindex.com/apple/swift-docc-plugin/1.3.0/documentation/swiftdoccplugin
Apache License 2.0
316 stars 54 forks source link

Ability to generate Objective-C docs for Swift symbols #47

Open aboedo opened 1 year ago

aboedo commented 1 year ago

Feature Request: generate Objective-C documentation

Description:

When generating docs through Xcode, you can enable the DOCC_EXTRACT_OBJC_INFO_FOR_SWIFT_SYMBOLS build setting to get Objective-C documentation generated for Swift files.

Screenshot 2023-01-17 at 5 24 02 PM

I haven't found a way to achieve the same thing through this plugin, but the last comment in this thread (from March '22) says:

a further update with instructions will be shared once Objective-C doc generation can be used end-to-end. Also, one next step here will be to integrate this in the new DocC SwiftPM plugin 18.

https://forums.swift.org/t/extending-swift-docc-to-support-objective-c-documentation/53243/17

Motivation:

Being able to generate Objective-C symbols is very useful to the still large number of Objective-C developers out there.

Alternatives Considered

The alternative to this is to go back to the flow of generating the archive through Xcode, which would be a bummer since the plugin is a lot more useful.