expressjs
fixes(#1283): Add documentation for Multer functions
PR Title:
docs: Add documentation for Multer functions
fixes: #1283
#1283
Description:
This pull request adds comprehensive documentation for various Multer functions, improving code readability and helping developers understand the purpose and usage of each function. The following functions have been documented:
-
allowAll -
Multer.prototype.single -
Multer.prototype.array -
Multer.prototype.fields -
Multer.prototype.none -
Multer.prototype.any -
Multer.prototype._makeMiddleware -
wrappedFileFilter
These additions aim to enhance the clarity of the codebase and provide better insight into the functionality of the Multer library.
Changes:
- Added JSDoc comments for all relevant functions.
- Provided detailed descriptions of each function's behavior and parameters.
- Improved inline documentation to support better developer experience.
Motivation and Context:
Clear documentation helps developers understand how to use the Multer library effectively. This PR aims to improve the usability and maintainability of the code.
Type of Change:
- Documentation update.
How to Test:
No testing required, as this is purely a documentation update. Review the code for clarity and accuracy of the added comments.
This adds a lot of changes, in internal methods as well. While the work is appreciated, I suggest changing the PR to DRAFT so that we do not accidentally land it before its ready as there's so much jsDoc to review.
cc: @UlisesGascon
