[Linting Rule] Roxygen Arguments

Generated from 'wiki-linter.ts' on 2026-10-27, 10:46:55 UTC (v2.16.6), do not edit directly.

This rule is a best-effort rule.

Finds function parameters the roxygen documentation leaves out, and documented parameters the function does not have.
This linting rule is implemented in src/linter/rules/roxygen-arguments.ts.

#' A function with two parameters, but only only one documented
#' @param a A variable
f = function(a, b){return a;}

The linting query can be used to run this rule on the above example:

[ { "type": "linter",   "rules": [ { "name": "roxygen-arguments",     "config": {} } ] } ]

Results (prettified and summarized):

Query: linter (1 ms)
   ╰ Roxygen Arguments (roxygen-arguments):
       ╰ uncertain:
           ╰ Function at 3.5-29 has undocumented argument 'b'

More examples are the test cases in test/functionality/linter/lint-roxygen-arguments.test.ts.