Merging Obj-C property and custom setter docs
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 2.4k
- Forks
- 237
- PR merge metrics
- No merged PRs in 30d
Description
In our SDK we have readonly property:
@property (nonatomic, readonly) NSUInteger routeRequestInterval;
and custom non-void setter in order to return some error:
-(NMANavigationError)setRouteRequestInterval:(NSUInteger)interval;
Doc is generated only for property. Setter is not shown at all.
Looks like a SourceKitten filtering issue as docs are generated by Xcode when I Opt+click the property or setter.
We can not modify property or setter as they are in public header of SDK and will affect users.
Is there any workaround?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with SourceKitten's filtering behavior for the readonly property and custom non-void setter described in the issue, and compare it with the documentation Xcode displays for each declaration. Done means identifying a supported way to include the setter in generated documentation without modifying the SDK's public header.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- objective-c, swift
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100