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

Extensions documentation is ignored #454

Closed
MattCheetham opened this issue Jan 10, 2016 · 8 comments
Closed

Extensions documentation is ignored #454

MattCheetham opened this issue Jan 10, 2016 · 8 comments

Comments

@MattCheetham
Copy link

I have an extension of NSDate in my project. It looks a little like this

/**
Useful extensions of NSDate that do things
*/
public extension NSDate {

}

Jazzy puts the NSDate extension into the documentation when generated but lists it as "Undocumented".

Not sure if I'm missing something obvious or of it's a bug.

@juliangrosshauser
Copy link

I'm having the same problem in an Obj-C project.

This category ends up being "Undocumented":

/// See PSPDFPresentationActions.h for compatible keys for `options`.
@interface PSPDFViewController (Presentation)

Whereas this category ends up being documented:

/// This defines shortcuts that will edit the `fontAttributes` dictionary.
/// Valid for PSPDFFreeTextAnnotation, PSPDFChoiceFormElement and PSPDF
@interface PSPDFAnnotation (Fonts)

@jverkoey
Copy link
Collaborator

jverkoey commented Apr 8, 2016

I'm also seeing anonymous categories incorrectly called out for being undocumented.

/** Some category */
@interface SomeClass ()

/** Some docs */
@property(nonatomic, copy) NSArray *anArray;

@end

Both SomeClass and SomeClass.anArray are marked as undocumented.

@JoshHrach
Copy link

I'm seeing this as well. I made an extension of UIDevice, provided documentation on it, but it also is ignored when skipping undocumented items.

norio-nomura added a commit to jpsim/SourceKitten that referenced this issue Jun 10, 2016
…MarkNamesCursorInfo()`

Their values are same with "key.nameoffset" and "key.namelength" in most case.
When kind is extension, their values locate **the type's declaration** in their declared file.
That may be different from the file declaring extension.

So, using them is wrong.
Is this related to realm/jazzy#454?
@pigeondotdev pigeondotdev self-assigned this Nov 23, 2016
@pigeondotdev
Copy link
Contributor

pigeondotdev commented Nov 23, 2016

Any updates on this?

@jpsim
Copy link
Collaborator

jpsim commented Nov 26, 2016

It'd be useful to check to see if this is still an issue.

@JoshHrach
Copy link

I generated documentation last Wednesday. We have extensions for Date, UILabel, UIDevice, and UIViewController. All have the same level of documentation. Only the Date extension is showing up in our documentation.

@jpsim
Copy link
Collaborator

jpsim commented Dec 7, 2016

@JoshHrach is this with jazzy 0.7.3? What steps exactly could I follow to trigger this issue?

@jpsim
Copy link
Collaborator

jpsim commented May 18, 2017

Fixed in #819

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants