{"record":{"id":"76e3b91f1ae34fd2","repo":"oxc-project/oxc","slug":"missing-description-in-property-tag","errorCode":null,"errorMessage":"Missing description in `@property` tag.","messagePattern":"Missing description in `@property` tag\\.","errorType":"validation","errorClass":"OxcDiagnostic","httpStatus":null,"severity":"error","filePath":"crates/oxc_linter/src/rules/jsdoc/require_property_description.rs","lineNumber":12,"sourceCode":"use oxc_diagnostics::OxcDiagnostic;\nuse oxc_macros::declare_oxc_lint;\nuse oxc_span::Span;\n\nuse crate::{\n    context::LintContext,\n    rule::Rule,\n    utils::{should_ignore_as_internal, should_ignore_as_private},\n};\n\nfn require_property_description_diagnostic(span: Span) -> OxcDiagnostic {\n    OxcDiagnostic::warn(\"Missing description in `@property` tag.\")\n        .with_help(\"Add a description to this `@property` tag.\")\n        .with_label(span)\n}\n\n#[derive(Debug, Default, Clone)]\npub struct RequirePropertyDescription;\n\ndeclare_oxc_lint!(\n    /// ### What it does\n    ///\n    /// Requires that all `@property` tags have descriptions.\n    ///\n    /// ### Why is this bad?\n    ///\n    /// The description of a property should be documented.\n    ///\n    /// ### Examples\n    ///","sourceCodeStart":1,"sourceCodeEnd":30,"githubUrl":"https://github.com/oxc-project/oxc/blob/e1e7af627c8843ab64044ed466b128fcc21a035b/crates/oxc_linter/src/rules/jsdoc/require_property_description.rs#L1-L30","documentation":"Fires from jsdoc/require-property-description when a @property tag has a name/type but no description text. The run_once visitor checks each property tag in typedef/namespace blocks and the helper advises adding the description.","triggerScenarios":"Thrown at crates/oxc_linter/src/rules/jsdoc/require_property_description.rs:12 when the library encounters an invalid state.","commonSituations":"See trigger scenarios.","solutions":["Add a description after the `@property {type} name` portion","Remove the `@property` tag if the member no longer exists"],"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"}