[DOC beta] Hide private classes from YUIDoc #4052
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
👍 |
|
(we use YUIDoc, but JSDoc and YUIDoc agree here) |
|
Seems like the website should filter out private classes? They are still marked as private on the website. |
|
@fivetanley - yes, https://github.com/emberjs/website/blob/master/lib/api_docs.rb should be better about not including private classes in the sidebar |
pangratz
changed the title
|
@pangratz do you mind also removing the 2nd |
It looks like marking classes as `@private` is not enough to hide them from showing up in the API doc at http://emberjs.com/api/data/. This commit changes the used comments to start with `/*`, which are definitely ignored by YUIDoc.
|
@bmac done |
bmac
added a commit
that referenced
this pull request
Jan 9, 2016
…-docs [DOC beta] Hide private classes from YUIDoc
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It looks like marking classes as
@privateis not enough to hide themfrom showing up in the API doc at http://emberjs.com/api/data/.
This commit changes the used comments to start with
/*, which aredefinitely ignored by JSDoc.