{"record":{"id":"44e57bfe0d93ab75","repo":"oxc-project/oxc","slug":"missing-jsdoc-returns-declaration-for-function","errorCode":null,"errorMessage":"Missing JSDoc `@returns` declaration for function.","messagePattern":"Missing JSDoc `@returns` declaration for function\\.","errorType":"validation","errorClass":"OxcDiagnostic","httpStatus":null,"severity":"error","filePath":"crates/oxc_linter/src/rules/jsdoc/require_returns.rs","lineNumber":23,"sourceCode":"use oxc_diagnostics::OxcDiagnostic;\nuse oxc_macros::declare_oxc_lint;\nuse oxc_span::Span;\nuse rustc_hash::FxHashMap;\nuse schemars::JsonSchema;\nuse serde::Deserialize;\n\nuse crate::{\n    context::LintContext,\n    rule::{DefaultRuleConfig, Rule},\n    utils::{\n        get_function_nearest_jsdoc_node, is_duplicated_special_tag, is_missing_special_tag,\n        should_ignore_as_avoid, should_ignore_as_custom_skip, should_ignore_as_internal,\n        should_ignore_as_private,\n    },\n};\n\nfn missing_returns_diagnostic(span: Span) -> OxcDiagnostic {\n    OxcDiagnostic::warn(\"Missing JSDoc `@returns` declaration for function.\")\n        .with_help(\"Add a `@returns` tag to the JSDoc comment.\")\n        .with_label(span)\n}\n\nfn duplicate_returns_diagnostic(span: Span) -> OxcDiagnostic {\n    OxcDiagnostic::warn(\"Duplicate `@returns` tags.\")\n        .with_help(\"Remove the redundant `@returns` tag.\")\n        .with_label(span)\n}\n\n#[derive(Debug, Default, Clone, Deserialize)]\npub struct RequireReturns(Box<RequireReturnsConfig>);\n\n#[derive(Debug, Clone, Deserialize, JsonSchema)]\n#[serde(rename_all = \"camelCase\", default, deny_unknown_fields)]\nstruct RequireReturnsConfig {\n    /// Tags that exempt functions from requiring `@returns`.\n    exempted_by: Vec<String>,","sourceCodeStart":5,"sourceCodeEnd":41,"githubUrl":"https://github.com/oxc-project/oxc/blob/e1e7af627c8843ab64044ed466b128fcc21a035b/crates/oxc_linter/src/rules/jsdoc/require_returns.rs#L5-L41","documentation":"Fires from jsdoc/require-returns when a documented function returns a value but its JSDoc block has no @returns tag. The run_once visitor finds functions with return statements whose nearest JSDoc lacks the tag and the helper advises adding it.","triggerScenarios":"Thrown at crates/oxc_linter/src/rules/jsdoc/require_returns.rs:23 when the library encounters an invalid state.","commonSituations":"See trigger scenarios.","solutions":["Add a `@returns {type} description` tag to the function's JSDoc","If the function returns nothing meaningful, remove the implicit return or document `@returns {void}`"],"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"}