Enforce alignment of JSDoc comments
This CL adds the eslint-plugin-jsdoc plugin and enables just one rule,
`jsdoc/check-alignment`, which ensures that all the lines in a comment
are correctly aligned. For example:
```
/**
* foo
* bar
*/
```
Would fail the check and be corrected to:
```
/**
* foo
* bar
*/
```
DISABLE_THIRD_PARTY_CHECK=deliberate install + use of
eslint-plugin-jsdoc node_module
Bug: none
Change-Id: I969983cd550653654a334ede3409b8c850467245
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/4110906
Commit-Queue: Andres Olivares <[email protected]>
Reviewed-by: Andres Olivares <[email protected]>
Auto-Submit: Jack Franklin <[email protected]>
Commit-Queue: Jack Franklin <[email protected]>
diff --git a/front_end/panels/network/components/RequestHeadersView.ts b/front_end/panels/network/components/RequestHeadersView.ts
index 098c61f..9c2ae4d 100644
--- a/front_end/panels/network/components/RequestHeadersView.ts
+++ b/front_end/panels/network/components/RequestHeadersView.ts
@@ -33,77 +33,77 @@
const UIStrings = {
/**
- *@description Text in Request Headers View of the Network panel
- */
+ *@description Text in Request Headers View of the Network panel
+ */
fromDiskCache: '(from disk cache)',
/**
- *@description Text in Request Headers View of the Network panel
- */
+ *@description Text in Request Headers View of the Network panel
+ */
fromMemoryCache: '(from memory cache)',
/**
- *@description Text in Request Headers View of the Network panel
- */
+ *@description Text in Request Headers View of the Network panel
+ */
fromPrefetchCache: '(from prefetch cache)',
/**
- *@description Text in Request Headers View of the Network panel
- */
+ *@description Text in Request Headers View of the Network panel
+ */
fromServiceWorker: '(from `service worker`)',
/**
- *@description Text in Request Headers View of the Network panel
- */
+ *@description Text in Request Headers View of the Network panel
+ */
fromSignedexchange: '(from signed-exchange)',
/**
- *@description Text in Request Headers View of the Network panel
- */
+ *@description Text in Request Headers View of the Network panel
+ */
fromWebBundle: '(from Web Bundle)',
/**
- *@description Section header for a list of the main aspects of a http request
- */
+ *@description Section header for a list of the main aspects of a http request
+ */
general: 'General',
/**
- *@description Label for a link from the network panel's headers view to the file in which
- * header overrides are defined in the sources panel.
- */
+ *@description Label for a link from the network panel's headers view to the file in which
+ * header overrides are defined in the sources panel.
+ */
headerOverrides: 'Header overrides',
/**
- *@description Label for a checkbox to switch between raw and parsed headers
- */
+ *@description Label for a checkbox to switch between raw and parsed headers
+ */
raw: 'Raw',
/**
- *@description Text in Request Headers View of the Network panel
- */
+ *@description Text in Request Headers View of the Network panel
+ */
referrerPolicy: 'Referrer Policy',
/**
- *@description Text in Network Log View Columns of the Network panel
- */
+ *@description Text in Network Log View Columns of the Network panel
+ */
remoteAddress: 'Remote Address',
/**
- *@description Text in Request Headers View of the Network panel
- */
+ *@description Text in Request Headers View of the Network panel
+ */
requestHeaders: 'Request Headers',
/**
- *@description The HTTP method of a request
- */
+ *@description The HTTP method of a request
+ */
requestMethod: 'Request Method',
/**
- *@description The URL of a request
- */
+ *@description The URL of a request
+ */
requestUrl: 'Request URL',
/**
- *@description A context menu item in the Network Log View Columns of the Network panel
- */
+ *@description A context menu item in the Network Log View Columns of the Network panel
+ */
responseHeaders: 'Response Headers',
/**
- *@description Title text for a link to the Sources panel to the file containing the header override definitions
- */
+ *@description Title text for a link to the Sources panel to the file containing the header override definitions
+ */
revealHeaderOverrides: 'Reveal header override definitions',
/**
- *@description Text to show more content
- */
+ *@description Text to show more content
+ */
showMore: 'Show more',
/**
- *@description HTTP response code
- */
+ *@description HTTP response code
+ */
statusCode: 'Status Code',
};
const str_ = i18n.i18n.registerUIStrings('panels/network/components/RequestHeadersView.ts', UIStrings);
