{"record":{"id":"a45ab44eaa1da1de","repo":"oxc-project/oxc","slug":"missing-jsdoc-param-declaration-for-function-pa","errorCode":null,"errorMessage":"Missing JSDoc `@param` declaration for function parameters.","messagePattern":"Missing JSDoc `@param` declaration for function parameters\\.","errorType":"validation","errorClass":"OxcDiagnostic","httpStatus":null,"severity":"error","filePath":"crates/oxc_linter/src/rules/jsdoc/require_param.rs","lineNumber":25,"sourceCode":"use oxc_ast::{\n    AstKind,\n    ast::{FormalParameters, MethodDefinitionKind, TSType},\n};\nuse oxc_diagnostics::OxcDiagnostic;\nuse oxc_macros::declare_oxc_lint;\nuse oxc_semantic::{AstNode, JSDoc, NodeId};\n\nuse crate::{\n    context::LintContext,\n    rule::Rule,\n    utils::{\n        ParamKind, collect_params, deserialize_regex, get_function_nearest_jsdoc_node,\n        should_ignore_as_avoid, should_ignore_as_internal, should_ignore_as_private,\n    },\n};\n\nfn require_param_diagnostic(violations: Vec<Span>) -> OxcDiagnostic {\n    OxcDiagnostic::warn(\"Missing JSDoc `@param` declaration for function parameters.\")\n        .with_help(\"Add `@param` tag with name.\")\n        .with_labels(violations)\n}\n\n#[derive(Debug, Default, Clone)]\npub struct RequireParam(Box<RequireParamConfig>);\n\n#[derive(Debug, Clone, Deserialize, JsonSchema)]\n#[serde(rename_all = \"camelCase\", default, deny_unknown_fields)]\nstruct RequireParamConfig {\n    /// List of JSDoc tags that exempt functions from `@param` checking.\n    #[serde(default = \"default_exempted_by\")]\n    exempted_by: Vec<String>,\n    /// Whether to check constructor methods.\n    check_constructors: bool,\n    /// Whether to check getter methods.\n    check_getters: bool,\n    /// Whether to check setter methods.","sourceCodeStart":7,"sourceCodeEnd":43,"githubUrl":"https://github.com/oxc-project/oxc/blob/e1e7af627c8843ab64044ed466b128fcc21a035b/crates/oxc_linter/src/rules/jsdoc/require_param.rs#L7-L43","documentation":"Fires from jsdoc/require-param when a documented function has parameters in its signature that are not covered by any @param tag. The rule collects each undocumented parameter's span and passes all violations to this diagnostic, which labels every offending parameter position.","triggerScenarios":"Thrown at crates/oxc_linter/src/rules/jsdoc/require_param.rs:25 when the library encounters an invalid state.","commonSituations":"See trigger scenarios.","solutions":["Add a `@param` tag for each undocumented parameter","Use `@param foo` (name-only) if descriptions are not required by your config"],"exampleFix":null,"handlingStrategy":"validation","validationCode":null,"typeGuard":null,"tryCatchPattern":null,"preventionTips":[],"tags":[],"backgroundTag":null,"analyzedSha":"e1e7af627c8843ab64044ed466b128fcc21a035b","analyzedAt":"2026-08-20T07:01:07.079Z","contentChangedAt":"2026-08-20T07:01:07.079Z","schemaVersion":2},"datasetVersion":"2026-09-14T00:17:10.932Z"}