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

Options for showing undocumented structures #129

Closed
juangamnik opened this issue Dec 26, 2014 · 4 comments · Fixed by #133
Closed

Options for showing undocumented structures #129

juangamnik opened this issue Dec 26, 2014 · 4 comments · Fixed by #133

Comments

@juangamnik
Copy link

There should be command-line flags for showing/hiding undocumented structures (separated by type like global function, global variable, selector/method, operator, class, structure, extension, ...). This way an API can be documented completely without having to write documentation to every structure (some are self-explanatory, but still name and type/signature are worthy information).

@jpsim
Copy link
Collaborator

jpsim commented Dec 26, 2014

I really like this idea!

@juangamnik
Copy link
Author

I couldn't test the new version until now (had installation problems #139). Every undocumented structure has now a text "Undocumented" like here:
jazzy_undoc

But if I add some really meaningless documentation I get much more information (the Swift declaration):
jazzy_decl

So why not use the declaration instead of the meaningless notion "Undocumented" (I would just omit it).

What do you think? Sorry for the big screens, took them with Retina display.

@segiddins
Copy link
Collaborator

@juangamnik thanks for pointing this out! I completely agree, can you please open up a separate issue?

@juangamnik
Copy link
Author

@segiddins done.

@pigeon-archive pigeon-archive 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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants