Since tag support
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 2.4k
- Forks
- 237
- PR merge metrics
- No merged PRs in 30d
Description
Looking at
https://github.com/jpsim/SourceKitten/blob/492510245a177248319436c5c66551edfe863e72/Source/SourceKittenFramework/Clang%2BSourceKitten.swift#L181, it appears that it would be relatively straightforward to add an @since tag.
Appledoc appears to be able to support @since tag with something like
https://github.com/groue/GRMustache/blob/master/src/classes/GRMustache.h#L33.
Would be happy to open a PR to get this started if the maintainers of this library would be interested in merging it in.
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 at Source/SourceKittenFramework/Clang+SourceKitten.swift around line 181, where the issue identifies related tag handling. Compare the proposed @since support with the GRMustache example and determine the expected representation. Done means SourceKitten recognizes and exposes @since tags consistently with the existing documentation tags.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100