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.

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

Document Objective-C extensions with DocC #843

Open
Frizlab opened this issue Feb 24, 2024 · 2 comments
Open

Document Objective-C extensions with DocC #843

Frizlab opened this issue Feb 24, 2024 · 2 comments
Labels
enhancement Improvements or enhancements to existing functionality

Comments

@Frizlab
Copy link

Frizlab commented Feb 24, 2024

Feature Name

Document Objective-C Extensions

Description

Implement #210, but this time for Objective-C.

Motivation

I have a project which is basically an extension on NSObject. Without the documentation on extended Objective-C objects, the doc generated by DocC is completely useless for my project.

Importance

I think this feature is relatively important. I am trying a very ugly workaround for the time being, but this would simply not work for a bigger project.
Extension-only frameworks are not uncommon and documenting them should, IMHO, be possible, even for Objective-C projects, especially since DocC has official support for Objective-C.

Alternatives Considered

For now I’m trying a workaround with a separate target where a custom object, subclass of NSObject is created and the extension on NSObject are done on this custom object just for the documentation.
It’s ugly and absolutely not scalable, and I’m currently not even sure it’ll work.

@Frizlab Frizlab added the enhancement Improvements or enhancements to existing functionality label Feb 24, 2024
@d-ronnqvist
Copy link
Contributor

@daniel-grumberg does this issue belong somewhere in the clang repo or here?

@daniel-grumberg
Copy link
Contributor

llvm/llvm-project#92240

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvements or enhancements to existing functionality
Projects
None yet
Development

No branches or pull requests

3 participants