oxc-project/oxc · error · OxcDiagnostic

Missing description in `@property` tag.

Error message

Missing description in `@property` tag.

What it means

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.

Source

Thrown at crates/oxc_linter/src/rules/jsdoc/require_property_description.rs:12

use oxc_diagnostics::OxcDiagnostic;
use oxc_macros::declare_oxc_lint;
use oxc_span::Span;

use crate::{
    context::LintContext,
    rule::Rule,
    utils::{should_ignore_as_internal, should_ignore_as_private},
};

fn require_property_description_diagnostic(span: Span) -> OxcDiagnostic {
    OxcDiagnostic::warn("Missing description in `@property` tag.")
        .with_help("Add a description to this `@property` tag.")
        .with_label(span)
}

#[derive(Debug, Default, Clone)]
pub struct RequirePropertyDescription;

declare_oxc_lint!(
    /// ### What it does
    ///
    /// Requires that all `@property` tags have descriptions.
    ///
    /// ### Why is this bad?
    ///
    /// The description of a property should be documented.
    ///
    /// ### Examples
    ///

View on GitHub (pinned to e1e7af627c)

Solutions

1. Add a description after the `@property {type} name` portion
2. Remove the `@property` tag if the member no longer exists

When it happens

Trigger: Thrown at crates/oxc_linter/src/rules/jsdoc/require_property_description.rs:12 when the library encounters an invalid state.

Common situations: See trigger scenarios.

AI-assisted analysis of oxc-project/oxc@e1e7af627c (2026-08-20). Data as JSON: /api/errors/76e3b91f1ae34fd2. Report an issue: GitHub.