JSDoc Function Documentation for Codebase #686
Merged
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
modos189
added
enhancement
🤖 Pull request artifacts
|
modos189
changed the title
modos189
force-pushed
the
jsdoc
branch
2 times, most recently
from
6b349eb to
f99e841
Compare
modos189
force-pushed
the
jsdoc
branch
3 times, most recently
from
52a32b1 to
6e88661
Compare
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 pull request integrates existing function documentation into our codebase using JSDoc. Previously, our function documentation resided separately from the code, leading to challenges in keeping it updated and in sync with code changes.
By transitioning to JSDoc comments directly in the source code, we ensure that our function documentation remains current and evolves alongside our codebase.
It's important to note that this shift towards inline documentation does not replace our existing comprehensive project documentation. Instead, it complements it by providing detailed, context-specific information about our functions right where they are defined.
A similar method of documentation is already used in
lib-iitc-manager( https://iitc-ce.github.io/lib-iitc-manager/ )UP: Added JSDoc comments for most methods, configured website build with API method documentation