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.

Sign up for GitHub

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

Jump to bottom

Display documentation coverage #63

Closed
jpsim opened this issue Nov 1, 2014 · 5 comments
Closed

Display documentation coverage #63

jpsim opened this issue Nov 1, 2014 · 5 comments
Assignees
@jpsim
Labels
difficulty-moderate feature front-end priority-high ruby sourcekitten
Milestone
Before

Comments

@jpsim
Copy link
Collaborator

jpsim commented Nov 1, 2014

Would need sourcekitten support.
@jpsim
Copy link
Collaborator Author

jpsim commented Nov 12, 2014

sourcekitten now prints out documentation coverage for each file to STDERR as of this commit: jpsim/SourceKitten@a94eebf

@jpsim jpsim mentioned this issue Nov 14, 2014
Merged
@jpsim
Copy link
Collaborator Author

jpsim commented Nov 14, 2014

Added in 0.0.14.

@jpsim jpsim closed this as completed Nov 14, 2014
@beltex
Copy link
Contributor

beltex commented Dec 14, 2014

How is doc coverage defined exactly? I'm seeing 45% coverage on a project that seems to have nearly 100% coverage (init() is missing doc).

Example - http://beltex.github.io/SMCKit/docs/index.html

@jpsim
Copy link
Collaborator Author

jpsim commented Dec 14, 2014

jazzy is detecting the members of your private structs as undocumented (SMCVersion, SMCPLimitData, SMCKeyInfoData, SMCParamStruct). It's also detecting init() as undocumented, since the comment above it only has 2 slashes instead of the required 3 (// http://stackoverflow.com/a/25598333).

It's quite likely that you wish to ignore the private struct members, which will be possible (and the default behavior) once we implement #69.

@beltex
Copy link
Contributor

beltex commented Dec 15, 2014

aah I see. Thanks @jpsim!

@beltex beltex mentioned this issue Dec 15, 2014
Closed
@jessesquires jessesquires mentioned this issue Mar 16, 2015
Closed
@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
Assignees

@jpsim jpsim

Labels
difficulty-moderate feature front-end priority-high ruby sourcekitten
Projects
None yet
Milestone
Before
Development

No branches or pull requests
3 participants
@jpsim @beltex @pigeondotdev