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

Documented extension is displayed as undocumented #230

Closed
emaloney opened this issue May 15, 2015 · 5 comments
Closed

Documented extension is displayed as undocumented #230

emaloney opened this issue May 15, 2015 · 5 comments
Assignees
Labels
Milestone

Comments

@emaloney
Copy link

At the top-level of an extension to a class, although I've provided a description for the extension, it shows as "Undocumented" when the documentation is generated.

The functions in the extension are also documented, and in that case, the documentation is being rendered as expected.

Here's my source:

screen shot 2015-05-14 at 10 36 07 pm

And here's a screenshot of the generated documentation, showing the extension itself as "Undocumented" while correctly showing documentation for the sameDayWithHour(_:, minute:, second:, nanosecond:) function:

screen shot 2015-05-14 at 10 38 40 pm

@segiddins
Copy link
Collaborator

Do you have an import Foundation or an import Foundation.NSDate above the extension?

@emaloney
Copy link
Author

I did not. However, I just tried adding it (both ways) & regenerating the docs, and in both cases, the result was the same: still showing the top-level NSDate extension as "Undocumented".

@emaloney
Copy link
Author

I should add this is version 0.2.0.

@tadija
Copy link

tadija commented Jul 14, 2015

I have the same problem in version 0.2.2.

@jpsim jpsim added the bug label Nov 24, 2015
@jpsim
Copy link
Collaborator

jpsim commented Nov 24, 2015

I believe this is addressed by jpsim/SourceKitten#104.

@jpsim jpsim closed this as completed Dec 30, 2015
@pigeondotdev pigeondotdev modified the milestone: The Past Nov 22, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants