diff --git a/aio/src/app/custom-elements/api/api.service.ts b/aio/src/app/custom-elements/api/api.service.ts index ae94866a4b..b6ca5ea26d 100644 --- a/aio/src/app/custom-elements/api/api.service.ts +++ b/aio/src/app/custom-elements/api/api.service.ts @@ -67,7 +67,7 @@ export class ApiService implements OnDestroy { * API sections is an array of Angular top modules and metadata about their API documents (items). * Updates `sections` observable * - * @param {string} [src] - Name of the api list JSON file + * @param [src] - Name of the api list JSON file */ fetchSections(src?: string) { // TODO: get URL by configuration? diff --git a/aio/src/app/custom-elements/code/pretty-printer.service.ts b/aio/src/app/custom-elements/code/pretty-printer.service.ts index 24538d8702..8df9665dc9 100644 --- a/aio/src/app/custom-elements/code/pretty-printer.service.ts +++ b/aio/src/app/custom-elements/code/pretty-printer.service.ts @@ -37,9 +37,9 @@ export class PrettyPrinter { /** * Format code snippet as HTML - * @param {string} code - the code snippet to format; should already be HTML encoded - * @param {string} [language] - The language of the code to render (could be javascript, html, typescript, etc) - * @param {string|number} [linenums] - Whether to display line numbers: + * @param code - the code snippet to format; should already be HTML encoded + * @param [language] - The language of the code to render (could be javascript, html, typescript, etc) + * @param [linenums] - Whether to display line numbers: * - false: don't display * - true: do display * - number: do display but start at the given number diff --git a/aio/src/app/search/search.worker.ts b/aio/src/app/search/search.worker.ts index 2482bb9085..646b81f6e2 100644 --- a/aio/src/app/search/search.worker.ts +++ b/aio/src/app/search/search.worker.ts @@ -26,7 +26,7 @@ function createIndex(loadIndexFn: IndexLoader): lunr.Index { // The lunr typings are missing QueryLexer so we have to add them here manually. const queryLexer = (lunr as any as { QueryLexer: { termSeparator: RegExp } }).QueryLexer; queryLexer.termSeparator = lunr.tokenizer.separator = /\s+/; - return lunr(/** @this */function() { + return lunr(function() { this.ref('path'); this.field('topics', { boost: 15 }); this.field('titleWords', { boost: 10 }); diff --git a/aio/src/app/shared/location.service.ts b/aio/src/app/shared/location.service.ts index d09d2cee06..463eb54651 100644 --- a/aio/src/app/shared/location.service.ts +++ b/aio/src/app/shared/location.service.ts @@ -100,7 +100,7 @@ export class LocationService { /** * Handle user's anchor click * - * @param anchor {HTMLAnchorElement} - the anchor element clicked + * @param anchor The anchor element clicked * @param button Number of the mouse button held down. 0 means left or none * @param ctrlKey True if control key held down * @param metaKey True if command or window key held down diff --git a/aio/src/app/sw-updates/sw-updates.service.ts b/aio/src/app/sw-updates/sw-updates.service.ts index f44df3286b..38ea8c4658 100644 --- a/aio/src/app/sw-updates/sw-updates.service.ts +++ b/aio/src/app/sw-updates/sw-updates.service.ts @@ -13,14 +13,13 @@ import { Logger } from 'app/shared/logger.service'; * 1. Checks for available ServiceWorker updates once instantiated. * 2. Re-checks every 6 hours. * 3. Whenever an update is available, it activates the update. - * - * @property - * `updateActivated` {Observable} - Emit the version hash whenever an update is activated. */ @Injectable() export class SwUpdatesService implements OnDestroy { private checkInterval = 1000 * 60 * 60 * 6; // 6 hours private onDestroy = new Subject(); + + /** Emit the version hash whenever an update is activated. */ updateActivated: Observable; constructor(appRef: ApplicationRef, private logger: Logger, private swu: SwUpdate) { diff --git a/aio/tslint.json b/aio/tslint.json index 3a745b774d..07c0e2e9c2 100644 --- a/aio/tslint.json +++ b/aio/tslint.json @@ -61,6 +61,7 @@ true, "ignore-params" ], + "no-redundant-jsdoc": true, "no-string-literal": false, "no-switch-case-fall-through": true, "no-var-requires": false,