Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
aboedo opened this issue Jan 17, 2023 · 0 comments
Open

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

aboedo opened this issue Jan 17, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@aboedo
Copy link

aboedo commented Jan 17, 2023

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.
@aboedo aboedo added the enhancement New feature or request label Jan 17, 2023
@aboedo aboedo mentioned this issue Jan 17, 2023
Merged
aboedo added a commit to RevenueCat/purchases-ios that referenced this issue Jan 18, 2023
@aboedo
set flag to extract objc info for swift symbols (#2218)
20454e1 
Added flag to extract objc info for swift symbols. 

<img width="1087" alt="image"
src="https://user-images.githubusercontent.com/3922667/213007781-a8758090-a8e6-4a68-987c-70108452e50c.png">


Sadly, this is only accessible when viewing the docs through Xcode, and
I couldn't find a way to set the equivalent thing when going through the
SPM DocC plugin swiftlang/swift-docc-plugin#47
@daniel-grumberg daniel-grumberg mentioned this issue Aug 30, 2024
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@aboedo