Skip to content

Comments

Feature/comments for api docs#1

Merged
ckanthony merged 10 commits intockanthony:mainfrom
hztBUAA:feature/comments-for-api-docs
Aug 14, 2025
Merged

Feature/comments for api docs#1
ckanthony merged 10 commits intockanthony:mainfrom
hztBUAA:feature/comments-for-api-docs

Conversation

@hztBUAA
Copy link

@hztBUAA hztBUAA commented May 8, 2025

Feature: Add API Documentation Support

Changes

  • Added support for parsing function comments to generate API documentation
  • Standardized comment format using English documentation
  • Improved AST traversal logic for better function detection
  • Removed redundant logging messages
  • Added test cases for documentation parsing

Technical Details

  • Enhanced parseHandlerComments to properly traverse AST nodes
  • Standardized documentation format:
  • Fixed module path issues for local development and remote usage

Testing

  • Added unit tests for comment parsing in convert_test.go
  • Updated integration tests in server_test.go
  • All tests passing with improved coverage

@ckanthony
Copy link
Owner

Very cool, thank you for PR, will have a look

@codecov
Copy link

codecov bot commented May 22, 2025

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@ckanthony ckanthony merged commit a950c19 into ckanthony:main Aug 14, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants