scan-documentation

Scanning for missing JSDoc involves auditing exported functions, service-layer contracts, and shared utilities against Always-tier documentation rules. It checks React components with three or more props for purpose comments and outputs findings formatted for the refactor board's Fix lane.

Auditing JSDoc coverage requires scanning exported functions, service-layer contracts, and React components with three or more props. The scanner references detailed rule specifications to identify missing documentation and groups findings by file for the refactor board's Fix lane.

Yes, the JSDoc scanner explicitly excludes Skip-tier code during the audit process. It focuses strictly on Always-tier documentation rules, ensuring exported functions, service-layer contracts, and shared package exports are fully documented without processing excluded files.

The best way to format missing JSDoc findings is to group them by file and structure the output specifically for the refactor board's Fix lane. This approach ensures undocumented exported functions and complex React components are tracked systematically.

You need to scan JSDoc comments for React components when they have three or more props, ensuring purpose comments are present. This process enforces Always-tier documentation rules across exported functions and shared package exports.

Yes, you can use JSDoc scanning to audit service-layer contracts in TypeScript. The scanner identifies missing documentation across shared package exports and complex React components, formatting the undocumented items for the refactor board.