chore: enabled jsdoc/check-tag-names fully

DefinitelyTyped · May 9, 2023 · 246c212 · 246c212
1 parent b63a486
commit 246c212
Show file tree

Hide file tree

Showing 279 changed files with 19,291 additions and 22,379 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -8,11 +8,112 @@
         "project": ["./tsconfig.json"]
     },
     "plugins": [
-        "@typescript-eslint"
+        "@typescript-eslint",
+        "jsdoc"
     ],
     "rules": {
       "dt-header": "error",
       "export-just-namespace": "error",
+      "jsdoc/check-tag-names": [
+        "error",
+        {
+          "definedTags": [
+            "addVersion",
+            "api",
+            "author",
+            "beta",
+            "brief",
+            "category",
+            "cfg",
+            "chainable",
+            "check",
+            "classDescription",
+            "condparamprivilege",
+            "constraint",
+            "credits",
+            "declaration",
+            "defApiFeature",
+            "defaultValue",
+            "detail",
+            "end",
+            "eventproperty",
+            "experimental",
+            "export",
+            "expose",
+            "extendscript",
+            "factory",
+            "field",
+            "final",
+            "fixme",
+            "fluent",
+            "for",
+            "governance",
+            "header",
+            "hidden-property",
+            "hidden",
+            "id",
+            "label",
+            "language",
+            "link",
+            "listen",
+            "locus",
+            "methodOf",
+            "minVersion",
+            "ngdoc",
+            "nonstandard",
+            "note",
+            "npm",
+            "observable",
+            "option",
+            "optionobject",
+            "options",
+            "packageDocumentation",
+            "param",
+            "parent",
+            "platform",
+            "plugin",
+            "preserve",
+            "privateRemarks",
+            "privilegeLevel",
+            "privilegeName",
+            "proposed",
+            "range",
+            "readOnly",
+            "related",
+            "remark",
+            "remarks",
+            "required",
+            "requires",
+            "restriction",
+            "returnType",
+            "section",
+            "see",
+            "since",
+            "const",
+            "singleton",
+            "source",
+            "struct",
+            "suppress",
+            "targetfolder",
+            "enum",
+            "title",
+            "record",
+            "title",
+            "TODO",
+            "trigger",
+            "triggers",
+            "typeparam",
+            "typeParam",
+            "unsupported",
+            "url",
+            "usage",
+            "warn",
+            "warning",
+            "version"
+          ],
+          "typed": true
+        }
+      ],
       "no-any-union": "error",
       "no-bad-reference": "error",
       "no-const-enum": "error",
@@ -27,5 +128,18 @@
       "prefer-declare-function": "error",
       "redundant-undefined": "error",
       "trim-file": "error"
+    },
+    "settings": {
+        "jsdoc": {
+            "tagNamePreference": {
+                "argument": "argument",
+                "exception": "exception",
+                "function": "function",
+                "method": "method",
+                "param": "param",
+                "return": "return",
+                "returns": "returns"
+            }
+        }
     }
 }
diff --git a/types/activex-libreoffice/index.d.ts b/types/activex-libreoffice/index.d.ts
@@ -13209,8 +13209,8 @@ declare namespace com.sun.star {
          * com.sun.star.container.XNameAccess} interface or {@link XPropertySet} .
          *
          * The {@link XMaterialHolder} interface has to be supported to give access to the inspected object.
-         * @@see XPropertySet
-         * @@see com::sun::star::beans::XExactName
+         * @see XPropertySet
+         * @see com::sun::star::beans::XExactName
          */
         interface XIntrospectionAccess extends uno.XInterface {
             /**
@@ -13844,7 +13844,7 @@ declare namespace com.sun.star {
              *
              * The value depends on the implementation of this interface. If this is a bound property, the value changes before the change events are fired. If this
              * is a constrained property, the vetoable event is fired before the property value changes.
-             * @@throws com::sun::star::lang::WrappedTargetException    if the implementation has an internal reason for the exception.      In this case the original ex
+             * @throws com::sun::star::lang::WrappedTargetException    if the implementation has an internal reason for the exception.      In this case the original ex
              */
             setToDefaultAsProperty(): void;
 
@@ -60720,7 +60720,7 @@ declare namespace com.sun.star {
              * returns `TRUE` if the method with the specified name exists, else `FALSE` .
              *
              * This optimizes the calling sequence ( {@link XInvocation.hasMethod()} , {@link XInvocation.invoke()} )!
-             * @@param aName        specifies the name of the method.
+             * @param aName        specifies the name of the method.
              */
             hasMethod(aName: string): boolean;
 
@@ -60736,7 +60736,7 @@ declare namespace com.sun.star {
              *     ( XInvocation::hasProperty(),
              *
              *     XInvocation::setValue() )!
-             * @@param aName    specifies the name of the property.
+             * @param aName    specifies the name of the property.
              */
             hasProperty(aName: string): boolean;
 
@@ -60851,13 +60851,13 @@ declare namespace com.sun.star {
 
             /**
              * returns `TRUE` , if the function is accessible through this library; otherwise it returns `FALSE` .
-             * @@param aFunctionName    the fully qualified name of a function.      (e.g., "UtilLibrary.ModuleDate.FunctionCurrentDate")
+             * @param aFunctionName    the fully qualified name of a function.      (e.g., "UtilLibrary.ModuleDate.FunctionCurrentDate")
              */
             isFunction(aFunctionName: string): boolean;
 
             /**
              * returns `TRUE` if a fully qualified function name begins with this name.
-             * @@param aPathName    a part of a function name (e.g., "UtilLibrary").
+             * @param aPathName    a part of a function name (e.g., "UtilLibrary").
              */
             isValidPath(aPathName: string): boolean;
 
@@ -68677,7 +68677,7 @@ declare namespace com.sun.star {
          * is called, the PooledConnection returns the connection which is pooled.
          *
          * </p>
-         * @@see com::sun::star::sdbc::XConnection
+         * @see com::sun::star::sdbc::XConnection
          */
         interface XPooledConnection extends uno.XInterface {
             /**
@@ -72201,7 +72201,7 @@ declare namespace com.sun.star {
              * specifies an arithmetic series for date values. <p>Cell by cell, the value used to fill the cells is increased
              *
              * by a specified number of days</p>
-             * @@see com::sun::star::sheet::FillDateMode  any date value matching the specified condition is valid.
+             * @see com::sun::star::sheet::FillDateMode  any date value matching the specified condition is valid.
              */
             DATE = 3,
             /**
@@ -72445,7 +72445,7 @@ declare namespace com.sun.star {
              * specifies an arithmetic series for date values. <p>Cell by cell, the value used to fill the cells is increased
              *
              * by a specified number of days</p>
-             * @@see com::sun::star::sheet::FillDateMode  any date value matching the specified condition is valid.
+             * @see com::sun::star::sheet::FillDateMode  any date value matching the specified condition is valid.
              */
             DATE = 3,
             /** any number matching the specified condition is valid. */
@@ -84906,7 +84906,7 @@ declare namespace com.sun.star {
              * Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT.
              *
              * </p>
-             * @@since OOo 3.0
+             * @since OOo 3.0
              */
             FirstLineIndent: number;
 
@@ -84940,7 +84940,7 @@ declare namespace com.sun.star {
              * Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT.
              *
              * </p>
-             * @@since OOo 3.0
+             * @since OOo 3.0
              */
             IndentAt: number;
 
@@ -84954,7 +84954,7 @@ declare namespace com.sun.star {
              * Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT.
              *
              * </p>
-             * @@since OOo 3.0
+             * @since OOo 3.0
              */
             LabelFollowedBy: number;
 
@@ -84973,7 +84973,7 @@ declare namespace com.sun.star {
              * and LabelFollowedBy equal LABELFOLLOW_LISTTAB
              *
              * </p>
-             * @@since OOo 3.0
+             * @since OOo 3.0
              */
             ListtabStopPosition: number;
 
@@ -85005,7 +85005,7 @@ declare namespace com.sun.star {
              * ListtabStopPosition, FirstLineIndent, IndentAt are used.
              *
              * </p>
-             * @@since OOo 3.0
+             * @since OOo 3.0
              */
             PositionAndSpaceMode: number;
 
@@ -85834,7 +85834,7 @@ declare namespace com.sun.star {
 
             /**
              * determines the interpretation of the height and relative height properties.
-             * @@see SizeType
+             * @see SizeType
              */
             SizeType: number;
 
@@ -86547,7 +86547,7 @@ declare namespace com.sun.star {
 
             /**
              * If `TRUE` , the row is allowed to be split at page or column breaks.
-             * @@since OOo 2.0
+             * @since OOo 2.0
              */
             IsSplitAllowed: boolean;
 
@@ -88764,7 +88764,7 @@ declare namespace com.sun.star {
         namespace textfield {
             /**
              * specifies service of text field that visualizes a {@link DDE} connection.
-             * @@see com::sun::star::text::TextFieldMaster::DDE
+             * @see com::sun::star::text::TextFieldMaster::DDE
              * @since OOo 1.1.2
              */
             type DDE = TextField;
@@ -90296,8 +90296,8 @@ declare namespace com.sun.star {
 
         /**
          * Offers a simple access to resources, like files and folders located in a local file system or on an WebDAV server.
-         * @@author Andreas Bregas
-         * @@version 1.0 07/25/2000
+         * @author Andreas Bregas
+         * @version 1.0 07/25/2000
          */
         type SimpleFileAccess = XSimpleFileAccess3;
 

diff --git a/types/amcharts/AmLegend.d.ts b/types/amcharts/AmLegend.d.ts
@@ -221,7 +221,7 @@ export default class AmLegend {
     valueWidth: number;
     /**
      * Vertical space between legend items also between legend border and first and last legend row.
-     * @default: 10
+     * @default 10
      */
     verticalGap: number;
     /**

diff --git a/types/amcharts/AmRectangularChart.d.ts b/types/amcharts/AmRectangularChart.d.ts
@@ -124,17 +124,17 @@ export default class AmRectangularChart extends AmCoordinateChart {
     zoomOutButtonImage: string;
     /**
      * Size of zoom-out button image
-     * @default: 17
+     * @default 17
      */
     zoomOutButtonImageSize: number;
     /**
      * Padding around the text and image.
-     * @default: 8
+     * @default 8
      */
     zoomOutButtonPadding: number;
     /**
      * Opacity of zoom-out button background when mouse is over it.
-     * @default: 1
+     * @default 1
      */
     zoomOutButtonRollOverAlpha: number;
     /**

diff --git a/types/amcharts/Label.d.ts b/types/amcharts/Label.d.ts
@@ -3,11 +3,11 @@
  */
 export default class Label {
     /**
-     * @Default 'left'
+     * @default 'left'
      */
     align: string;
     /**
-     * @Default 1
+     * @default 1
      */
     alpha: number;
     /**

diff --git a/types/angular-gettext/index.d.ts b/types/angular-gettext/index.d.ts
@@ -32,7 +32,7 @@ declare module 'angular' {
       /** An object of loaded translation strings.Shouldn't be used directly. */
       strings: {};
       /** The default language, in which you're application is written. This defaults to English and it's generally a bad idea to use anything else: if your language has different pluralization rules you'll end up with incorrect translations. Deprecated
-       * @deprecreated
+       * @deprecated
        */
       baseLanguage: string;
 

diff --git a/types/angular-route/index.d.ts b/types/angular-route/index.d.ts
@@ -217,7 +217,7 @@ declare module 'angular' {
             /**
              * Sets route definition that will be used on route change when no other route definition is matched.
              *
-             * @params Mapping information to be assigned to $route.current.
+             * @param params Mapping information to be assigned to $route.current.
              */
             otherwise(params: IRoute | string): IRouteProvider;
             /**