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.

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

docs: clean up jsdoc comments, namespace organization #4213

Merged
merged 2 commits into from
Apr 27, 2018

Conversation

aldeed
Copy link
Contributor

@aldeed aldeed commented Apr 25, 2018

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 and memberof values.

The generated API doc tree now follows this general pattern:

  • Organized at the top level by broad concepts, which loosely map to plugin and collection names, such as "Accounts", "Shop", "Orders", etc.
  • Within that, there are /GraphQL, /Methods, and /NoMeteorQueries subnamespaces, and occasionally some variations within those.

Also:

  • there is now a Collections namespace with all of the Meteor collections and the Schemas namespace has been cleaned up a bit
  • the Components namespace is now for React components only, and helpers have been moved to Components/Helpers namespace

Breaking changes

None

Testing

No code changes to test. Only jsdoc comments were changed.

  1. Check out this branch, and meteor npm install followed by npm run docs
  2. Go to file:///private/tmp/reaction-docs/index.html in a browser and check out the more organized left-side navigation tree.

Copy link
Contributor

@nnnnat nnnnat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! a few conflicts with release-1.12

@aldeed
Copy link
Contributor Author

aldeed commented Apr 27, 2018

@nnnnat I merged in release 1.12 and resolved conflicts

@nnnnat nnnnat merged commit 0ad4ac8 into release-1.12.0 Apr 27, 2018
@nnnnat nnnnat deleted the docs-aldeed-jsdoc-cleanup branch April 27, 2018 17:19
@spencern spencern mentioned this pull request May 31, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants