Update and fix a lot of doclets#1951
Merged
ricardograca merged 26 commits intomasterfrom Feb 20, 2019
Merged
Conversation
- The previous example was giving too much emphasis to the Collection#through() method instead. This clarifies that distinction.
- Uses the @Lends keyword to avoid having to explicitly add the name parameter to each doclet. - Also fixes a few mistakes in some doclets.
- The more complicated and unrelated aspects of the previous example will be moved to the Model guide.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Introduction
This fixes or adds missing information to a lot of JSDoc doclets.
Motivation
Some doclets were outdated and needed some extra info or clarification since some details weren't very obvious. Check the linked issue for more details.
Closes #800.
Current PR Issues
This isn't an extensive rewrite of all the doclets, so a lot of issues still remain. We should consolidate their styles at some point since they are all very different and sometimes hard to know how to format.