docs: Fixed jsdoc generation by marking private methods as @private #1976
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1976 +/- ##
=======================================
Coverage 97.04% 97.04%
=======================================
Files 218 218
Lines 40457 40493 +36
=======================================
+ Hits 39261 39297 +36
Misses 1196 1196
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
jsumners-nr
previously approved these changes
Jan 26, 2024
bizob2828
force-pushed
the
cleanup-js-doc
branch
from
c836b0b
to
afd91d8
Compare
jsumners-nr
approved these changes
Jan 26, 2024
Node.js Engineering Board
automation
moved this from Needs PR Review
to Done: Issues recently completed
Jan 26, 2024
svetlanabrennan
pushed a commit
to svetlanabrennan/node-newrelic
that referenced
this pull request
Feb 15, 2024
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.
Description
I noticed after refactoring message-shim and webframework-shim the API docs were not being properly generated.
One issue was the WebFrameworkShim and MessageShim docs are gone, this was because they are now subdirectories. But there was also a lot of global functions. This PR marks all private methods as such in jsdoc with
@private, but also fixes thepublic-docsscript to include the new subdirectories of the shim files.How to Test
It should have MessageShim and WebFrameworkShim in the Classes section. Also the global section should remove a lot of private functions.