docs: clean up jsdoc comments, namespace organization #4213
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.
Resolves #4176
Impact: minor
Type: docs
Issue
The generated API documentation, particularly newer GraphQL functions, is not well organized.
Solution
This PR makes changes to the jsdoc comments in many files. Specifically, adding and changing
namespace
andmemberof
values.The generated API doc tree now follows this general pattern:
/GraphQL
,/Methods
, and/NoMeteorQueries
subnamespaces, and occasionally some variations within those.Also:
Collections
namespace with all of the Meteor collections and theSchemas
namespace has been cleaned up a bitComponents
namespace is now for React components only, and helpers have been moved toComponents/Helpers
namespaceBreaking changes
None
Testing
No code changes to test. Only jsdoc comments were changed.
meteor npm install
followed bynpm run docs