Enforce eslint rule `jsdoc/check-tag-names`
Initially the goal was just to remove usages of @desc, because they
have a special meaning for Closure compiler. But while trying to
enforce this, I decided to go a bit beyond that.
Release-Notes: skip
Change-Id: I2c91602fdd5c36f9ca16e558998f7c7aeed829c7
diff --git a/polygerrit-ui/app/constants/constants.ts b/polygerrit-ui/app/constants/constants.ts
index 6ed9646..d4c3843 100644
--- a/polygerrit-ui/app/constants/constants.ts
+++ b/polygerrit-ui/app/constants/constants.ts
@@ -16,7 +16,7 @@
*/
/**
- * @desc Tab names for primary tabs on change view page.
+ * Tab names for primary tabs on change view page.
*/
import {DiffViewMode} from '../api/diff';
import {DiffPreferencesInfo} from '../types/diff';
@@ -74,14 +74,14 @@
}
/**
- * @desc Tab names for secondary tabs on change view page.
+ * Tab names for secondary tabs on change view page.
*/
export enum SecondaryTab {
CHANGE_LOG = '_changeLog',
}
/**
- * @desc Tag names of change log messages.
+ * Tag names of change log messages.
*/
export enum MessageTag {
TAG_DELETE_REVIEWER = 'autogenerated:gerrit:deleteReviewer',
@@ -97,7 +97,7 @@
}
/**
- * @desc Modes for gr-diff-cursor
+ * Modes for gr-diff-cursor
* The scroll behavior for the cursor. Values are 'never' and
* 'keep-visible'. 'keep-visible' will only scroll if the cursor is beyond
* the viewport.
@@ -108,7 +108,7 @@
}
/**
- * @desc Special file paths
+ * Special file paths
*/
export enum SpecialFilePath {
PATCHSET_LEVEL_COMMENTS = '/PATCHSET_LEVEL',
