-
-
Couldn't load subscription status.
- Fork 118
Document @nestia/migrate package with clean JSDoc comments and proper author attribution #1349
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
base: master
Are you sure you want to change the base?
Conversation
Co-authored-by: samchon <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't documentate on private members.
Also, add @author Samchon tag at the every classes and interfaces (not into the nested members).
Co-authored-by: samchon <[email protected]>
Co-authored-by: samchon <[email protected]>
@nestia/migrate package.Co-authored-by: samchon <[email protected]>
Addressed both feedback points in commit 11f21e8:
The documentation now follows the requested standards with proper @author attribution and no private member documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't need to write example content.
Also, documentate only to the public or exported members.
At last, add @author Jeongho Nam - https://github.com/samchon tag for every classes, namespaces, and interfaces.
…ps://github.com/samchon" Co-authored-by: samchon <[email protected]>
Addressed all requested changes in commit 1cbd8b3:
The documentation is now clean and follows the specified standards. |
This PR adds comprehensive JSDoc documentation to the entire
@nestia/migratepackage following clean documentation standards without example code blocks.What was documented
Core API Classes
NestiaMigrateApplication- Main class for migrating OpenAPI documents to NestJS/SDK with@author Jeongho Nam - https://github.com/samchonattributionindex.ts,module.ts) with file-level descriptionsInterfaces and Types
Complete documentation for all interfaces in the
structures/directory with proper author tags:INestiaMigrateConfig- Configuration options with detailed parameter descriptionsINestiaMigrateContext- Migration context structureINestiaMigrateController- Controller representationINestiaMigrateDto- DTO structure definitionsINestiaMigrateFile- File output structureINestiaMigrateProgram- Complete program representationINestiaMigrateSchema- Schema hierarchy structureCode Generation Namespaces
Key programming namespaces with proper author attribution:
NestiaMigrateNestProgrammer- NestJS application generationNestiaMigrateApiProgrammer- API client generationNestiaMigrateE2eProgrammer- End-to-end test generationUtility Functions
Utility namespaces with proper author attribution:
StringUtil- String manipulation for identifier normalizationMapUtil- Functional Map operations for memoization patternsSetupWizard- Project setup automationAnalysis and Processing
NestiaMigrateControllerAnalyzer- Route grouping logic with proper attributionNestiaMigrateFileArchiver- File system operations with author tagTypeLiteralFactory- TypeScript AST generation with attributionCLI Interface
migrate.ts- Command-line entry point with file-level documentationNestiaMigrateCommander- Main CLI orchestration logic with proper attributionDocumentation Standards Applied
✅ Clean JSDoc formatting with proper descriptions, parameter documentation, and return types
✅ No example code blocks - focused on clear, concise documentation without cluttering examples
✅ Proper author attribution using
@author Jeongho Nam - https://github.com/samchontags on all main classes and interfaces✅ Public members only - documentation exclusively on public/exported interfaces and functions
✅ Type safety with proper TypeScript integration in documentation
The package now provides clear guidance for developers migrating from OpenAPI/Swagger specifications to NestJS applications or SDK libraries, with proper attribution and clean documentation standards.
Fixes #1348.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.