Struct JsDocPluginSettings 

pub struct JsDocPluginSettings {
    pub augments_extends_replaces_docs: Option<bool>,
    pub exempt_destructured_roots_from_chekcs: Option<bool>,
    pub ignore_internal: Option<bool>,
    pub ignore_private: Option<bool>,
    pub ignore_replaces_docs: Option<bool>,
    pub implements_replaces_docs: Option<bool>,
    pub override_replaces_docs: Option<bool>,
    pub tag_name_preference: Option<BTreeMap<String, TagNamePreference>>,
}

Settings for the Jsdoc plugin. See more: https://oxc.rs/docs/guide/usage/linter/config-file-reference.html#settings-jsdoc

Fields

augments_extends_replaces_docs: Option<bool>

Only for require-(yields|returns|description|example|param|throws) rules.

exempt_destructured_roots_from_chekcs: Option<bool>

Only for require-param-type and require-param-description rule.

ignore_internal: Option<bool>

For all rules but NOT apply to empty-tags rule.

ignore_private: Option<bool>

For all rules but NOT apply to check-access and empty-tags rule.

ignore_replaces_docs: Option<bool>

Only for require-(yields|returns|description|example|param|throws) rules.

implements_replaces_docs: Option<bool>

Only for require-(yields|returns|description|example|param|throws) rules.

override_replaces_docs: Option<bool>

Only for require-(yields|returns|description|example|param|throws) rules.

tag_name_preference: Option<BTreeMap<String, TagNamePreference>>

Specifies allows custom tags for Jsdoc annotations.

Trait Implementations

impl Clone for JsDocPluginSettings

fn clone(&self) -> JsDocPluginSettings

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for JsDocPluginSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for JsDocPluginSettings

fn default() -> JsDocPluginSettings

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JsDocPluginSettings

where JsDocPluginSettings: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for JsDocPluginSettings

fn eq(&self, other: &JsDocPluginSettings) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for JsDocPluginSettings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for JsDocPluginSettings

impl StructuralPartialEq for JsDocPluginSettings