refactor: add @fileoverview
s and structured comments to .js
files
#145
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 includes several documentation improvements and code organization changes across multiple files to enhance readability and maintainability. The most important changes include adding file-level JSDoc comments, organizing code sections with comments, and ensuring consistent exports.
Documentation improvements:
packages/clang-format-git-python/src/cli.js
: Added a file-level JSDoc comment to provide an overview of the file's purpose.packages/clang-format-git-python/src/index.js
: Added a file-level JSDoc comment to describe the entry file for the package.packages/clang-format-git-python/src/utils/gitClangFormatPath.js
: Added a file-level JSDoc comment to explain the APIs provided by the file.Code organization:
packages/clang-format-git/src/cli.js
: Added comments to separate require and execution sections, and included a file-level JSDoc comment.packages/clang-format-git/src/utils/getGitClangFormatPath.js
: Added comments to organize require, declaration, and export sections, and included a file-level JSDoc comment.