rayvn/function-docs

Audit and update function doc comments.

Functions

auditDocs()

Audit and update function doc comments using the ◇ structured format. Use via: require ‘rayvn/function-docs’ Audit function doc comment coverage for registered projects, reporting missing or stale docs.

usage

auditDocs [--release] [PROJECT]...

--release	Exit 1 if any public functions are missing ◇ doc comments.
PROJECT (string)	One or more project names to audit (default: all loaded projects).

updateDocs()

Generate or update doc comments for public functions using the Claude API.

usage

updateDocs [--dry-run] [--regen] [--missing-only] [--stale-only] [--lib NAME] [--since DURATION] [--delay SECS] [PROJECT...]

--dry-run	Print proposed docs without writing changes.
--regen	Regenerate docs for all public functions, not just missing or stale.
--missing-only	Only process functions with no doc comment.
--stale-only	Only process functions with stale docs.
--lib NAME (string)	Limit processing to a single library by name.
--since DURATION (string)	Skip functions updated within this duration (e.g. ‘30m’, ‘2h’, ‘1d’); ignored with –regen.
--delay SECS (int)	Seconds to sleep between API calls (default: 5).
[PROJECT] (string)	One or more project names to limit scope (default: all loaded projects).