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

Documentations from the standard library not included in the generated HTML docs. #313

Closed
maybe-raven opened this issue Oct 4, 2015 · 7 comments
Assignees
Labels
Milestone

Comments

@maybe-raven
Copy link

I got a struct that conforms to SequenceType, and the documentation for the method generate() is provided in the standard library. I can even view it in Xcode.
2015-10-04 7 10 27
But in the HTML docs generated by jazzy, it says undocumented. Even the declaration is all wrong.
2015-10-04 7 19 27

I believe this is a bug. But if it's not, please tell me how should I set the settings so that (a) it includes standard library docs and (b) makes the declaration display correctly like it does in Xcode.

@segiddins
Copy link
Collaborator

Can you include some more information about the code you're trying to document so we can reproduce this ?

@maybe-raven
Copy link
Author

The code for the method I mentioned above is just like this. I didn't write any documentation or comment for it, because it's already provided in the standard library for SequenceType.
2015-10-04 11 21 14

This is the declaration for generate() in the generated header file for the standard library.
2015-10-04 11 23 28

By the way, I didn't set any parameter while I invoke jazzy. I just cd to my project directory and said jazzy.

@segiddins
Copy link
Collaborator

Ah. In that case, this is actually a feature request that's being tracked at #190.

@maybe-raven
Copy link
Author

Then what about the wrong declaration?
The declaration for generate() should be

public func generate() –> Generator

or

public func generate() –> CircularGenerator<T>

not

public struct CircularCollection<T> : SequenceType

At least, a method declaration should start with a func keyword not a struct, right?

@segiddins
Copy link
Collaborator

ah yeah I missed that bit

@jpsim
Copy link
Collaborator

jpsim commented Oct 5, 2015

@CCDSY you seem to have found a bug where if the declaration cannot be parsed, it falls back on the parent declaration.

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

jpsim commented Dec 30, 2015

Fixed in #441.

@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

4 participants