{"record":{"id":"c2bb5ce621b0eb9d","repo":"oxc-project/oxc","slug":"missing-jsdoc-param-description","errorCode":null,"errorMessage":"Missing JSDoc `@param` description.","messagePattern":"Missing JSDoc `@param` description\\.","errorType":"validation","errorClass":"OxcDiagnostic","httpStatus":null,"severity":"error","filePath":"crates/oxc_linter/src/rules/jsdoc/require_param_description.rs","lineNumber":21,"sourceCode":"\nuse oxc_ast::AstKind;\nuse oxc_diagnostics::OxcDiagnostic;\nuse oxc_macros::declare_oxc_lint;\nuse oxc_span::Span;\nuse oxc_str::CompactStr;\n\nuse crate::{\n    AstNode,\n    context::LintContext,\n    rule::{DefaultRuleConfig, Rule},\n    utils::{\n        ParamKind, collect_params, get_function_nearest_jsdoc_node, should_ignore_as_internal,\n        should_ignore_as_private,\n    },\n};\n\nfn missing_type_diagnostic(span: Span) -> OxcDiagnostic {\n    OxcDiagnostic::warn(\"Missing JSDoc `@param` description.\")\n        .with_help(\"Add description to `@param` tag.\")\n        .with_label(span)\n}\n\nfn missing_root_description_diagnostic(span: Span) -> OxcDiagnostic {\n    OxcDiagnostic::warn(\"Missing root description for @param.\")\n        .with_help(\"Add root description to `@param`.\")\n        .with_label(span)\n}\n\n#[derive(Debug, Clone, Deserialize, JsonSchema)]\n#[serde(rename_all = \"camelCase\", default, deny_unknown_fields)]\npub struct RequireParamDescriptionConfig {\n    /// The description string to set by default for destructured roots. Defaults to \"The root object\".\n    default_destructured_root_description: CompactStr,\n    /// Whether to set a default destructured root description.\n    /// For example, you may wish to avoid manually having to set the description for a @param corresponding to a destructured root object as it should always be the same type of object.\n    /// Uses `defaultDestructuredRootDescription` for the description string. Defaults to `false`.","sourceCodeStart":3,"sourceCodeEnd":39,"githubUrl":"https://github.com/oxc-project/oxc/blob/e1e7af627c8843ab64044ed466b128fcc21a035b/crates/oxc_linter/src/rules/jsdoc/require_param_description.rs#L3-L39","documentation":"Fires from jsdoc/require-param-description when a @param tag exists but has no description text after its name/type. The missing_type_diagnostic helper (name is historical) labels the tag span and advises adding the description.","triggerScenarios":"Thrown at crates/oxc_linter/src/rules/jsdoc/require_param_description.rs:21 when the library encounters an invalid state.","commonSituations":"See trigger scenarios.","solutions":["Add a description after the `@param {type} name` portion of the tag","If descriptions are unnecessary, disable this rule"],"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"}