jazzy: Docs for NSError extension (specifically) don't get parsed.
I have some extensions that are all being parsed correctly, for example, this gets detected with no issues and generates valid HTML docs:
public extension String {
//MARK: - String Extras
/// A capitalized address string.
/// e.g. `5TH AVENUE ST` returns `5th Avenue St`
public var capitalizedAddress: String {
But specifically my NSError extensions are being skipped for some reason and docs are never generated even though they follow the same format:
public extension NSError {
//MARK: - NSError Extras
/// Return a `THResponse` object corresponding to the current `NSError`.
public var asResponse: THResponse {
...
...
This is how it looks:
This is even weirder since jazzy outputs parsing of the file, but doesn’t generate the docs from it e.g. Parsing NSError.Exts.swift (27/47)
.
Would appreciate any help on this !
Kind Regards, Shai.
About this issue
- Original URL
- State: closed
- Created 8 years ago
- Comments: 34 (1 by maintainers)
Commits related to this issue
- Support documenting "substructures" such as Extensions. This should resolve issue #502. — committed to realm/jazzy by freak4pc 8 years ago
Let’s continue the conversation in #508. I’m not in my “jazzy head space” right now, so I haven’t fully understood the ramifications of such changes, but I’ll be able to review further once I can see the changes as discussed in #508.
Tracked it down, submitting a PR in a bit. 😉 Ruby isn’t my main language but I think it’s a good solution and it works for my very-heavy project.
Hehe, as I said, my use cases are very limited and it seems to have worked for me. Can you post an example project where this reproduces? I may try to look further tomorrow.