Skip to content

Conversation

@Zih0
Copy link
Collaborator

@Zih0 Zih0 commented Jan 23, 2026

Changes

  • Validate JSDoc completeness for exports with @public tag
  • Detect missing @param and @returns tags
  • Detect unused @param tags that don't match actual parameters
  • Extract validatePublic function for testability

Each declaration type has its own validator with specific validation targets:

Declaration Validator Validates
function FunctionValidator params, returns
interface InterfaceValidator properties, methods
...

TODO

Currently, the build command treats params, properties and members as @param
I think each of them should be handled separately

@vercel
Copy link

vercel bot commented Jan 23, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
docflow-docs Ready Ready Preview, Comment Jan 25, 2026 5:40am

Request Review

@Zih0 Zih0 self-assigned this Jan 23, 2026
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.

2 participants