[DOC beta] Enforce public/private declaration for API docs. #11362
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
rwjblue
force-pushed
the
enforce-documentation-access-specifics
branch
from
fc88bd5 to
06d1b0f
Compare
rwjblue
force-pushed
the
enforce-documentation-access-specifics
branch
from
06d1b0f to
6e1ad90
Compare
rwjblue
added a commit
that referenced
this pull request
Jun 7, 2015
…pecifics [DOC beta] Enforce public/private declaration for API docs.
This was referenced Jun 26, 2015
|
Hello @rwjblue, I come to haunt your Is there an issue or anything I can be pointed to to read more about the method access decisions? |
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.
This PR ensures that all YUIDoc comment blocks (those starting with
/**) are properly marked as either@privateor@public.A number of times throughout the Ember 1.x cycle we have internally struggled with what things are or are not public. This PR "solves" that by making it extremely clear.
In addition to documenting each comment block, a new JSCS rule has been added to ensure all documentation blocks are labeled properly in the future.
Please note: This PR makes an initial attempt based on my best understanding. These
@publicand@privatedeclarations can absolutely be reviewed and changed as needed.