Update jsdoc comments to use package names (#2312)

* Update jsdoc comments to use package names

* Add missing jsdoc updates

* Fix failing integration tests

* Fix failing integration tests (again)

Author: philipwalton

packages/workbox-background-sync/src/BackgroundSyncPlugin.ts

@@ -14,16 +14,16 @@ import './_version.js';
  * A class implementing the `fetchDidFail` lifecycle callback. This makes it
  * easier to add failed requests to a background sync Queue.
  *
- * @memberof workbox.backgroundSync
+ * @memberof module:workbox-background-sync
  */
 class BackgroundSyncPlugin implements WorkboxPlugin {
   private _queue: Queue;
 
   /**
-   * @param {string} name See the [Queue]{@link workbox.backgroundSync.Queue}
+   * @param {string} name See the [Queue]{@link module:workbox-background-sync.Queue}
    *     documentation for parameter details.
    * @param {Object} [options] See the
-   *     [Queue]{@link workbox.backgroundSync.Queue} documentation for
+   *     [Queue]{@link module:workbox-background-sync.Queue} documentation for
    *     parameter details.
    */
   constructor(name: string, options: QueueOptions) {

packages/workbox-background-sync/src/Queue.ts

@@ -47,7 +47,7 @@ const queueNames = new Set();
  * later. All parts of the storing and replaying process are observable via
  * callbacks.
  *
- * @memberof workbox.backgroundSync
+ * @memberof module:workbox-background-sync
  */
 class Queue {
   private _name: string;

packages/workbox-background-sync/src/index.ts

@@ -12,7 +12,7 @@ import './_version.js';
 
 
 /**
- * @namespace workbox.backgroundSync
+ * @module workbox-background-sync
  */
 
 export {

packages/workbox-background-sync/src/lib/QueueStore.ts

@@ -149,7 +149,7 @@ export class QueueStore {
   /**
    * Returns all entries in the store matching the `queueName`.
    *
-   * @param {Object} options See workbox.backgroundSync.Queue~getAll}
+   * @param {Object} options See {@link module:workbox-background-sync.Queue~getAll}
    * @return {Promise<Array<Object>>}
    * @private
    */

packages/workbox-broadcast-update/src/BroadcastCacheUpdate.ts

@@ -52,7 +52,7 @@ function defaultPayloadGenerator(data: CacheDidUpdateCallbackParam): Object {
  * For efficiency's sake, the underlying response bodies are not compared;
  * only specific response headers are checked.
  *
- * @memberof workbox.broadcastUpdate
+ * @memberof module:workbox-broadcast-update
  */
 class BroadcastCacheUpdate {
   private _headersToCheck: string[];

packages/workbox-broadcast-update/src/BroadcastUpdatePlugin.ts

@@ -17,14 +17,14 @@ import './_version.js';
  * This plugin will automatically broadcast a message whenever a cached response
  * is updated.
  *
- * @memberof workbox.broadcastUpdate
+ * @memberof module:workbox-broadcast-update
  */
 class BroadcastUpdatePlugin implements WorkboxPlugin {
   private _broadcastUpdate: BroadcastCacheUpdate;
 
   /**
    * Construct a BroadcastCacheUpdate instance with the passed options and
-   * calls its [`notifyIfUpdated()`]{@link workbox.broadcastUpdate.BroadcastCacheUpdate~notifyIfUpdated}
+   * calls its [`notifyIfUpdated()`]{@link module:workbox-broadcast-update.BroadcastCacheUpdate~notifyIfUpdated}
    * method whenever the plugin's `cacheDidUpdate` callback is invoked.
    *
    * @param {Object} options

packages/workbox-broadcast-update/src/index.ts

@@ -13,7 +13,7 @@ import './_version.js';
 
 
 /**
- * @namespace workbox.broadcastUpdate
+ * @module workbox-broadcast-update
  */
 
 export {

packages/workbox-broadcast-update/src/responsesAreSame.ts

@@ -20,8 +20,7 @@ import './_version.js';
  * @param {Array<string>} headersToCheck
  * @return {boolean}
  *
- * @memberof workbox.broadcastUpdate
- * @private
+ * @memberof module:workbox-broadcast-update
  */
 const responsesAreSame = (
   firstResponse: Response,

packages/workbox-build/src/lib/module-registry.js

@@ -12,10 +12,11 @@ const upath = require('upath');
 /**
  * Class for keeping track of which Workbox modules are used by the generated
  * service worker script.
+ * @private
  */
 class ModuleRegistry {
   /**
-   * Basic constructor.
+   * @private
    */
   constructor() {
     this.modulesUsed = new Map();
@@ -24,6 +25,7 @@ class ModuleRegistry {
   /**
    * @return {Array<string>} A list of all of the import statements that are
    * needed for the modules being used.
+   * @private
    */
   getImportStatements() {
     const workboxModuleImports = [];
@@ -48,6 +50,7 @@ class ModuleRegistry {
    * @param {string} pkg The workbox package that the module belongs to.
    * @param {string} moduleName The name of the module to import.
    * @return {string} The local variable name that corresponds to that module.
+   * @private
    */
   getLocalName(pkg, moduleName) {
     return `${pkg.replace(/-/g, '_')}_${moduleName}`;
@@ -57,6 +60,7 @@ class ModuleRegistry {
    * @param {string} pkg The workbox package that the module belongs to.
    * @param {string} moduleName The name of the module to import.
    * @return {string} The local variable name that corresponds to that module.
+   * @private
    */
   use(pkg, moduleName) {
     const localName = this.getLocalName(pkg, moduleName);

packages/workbox-cacheable-response/src/CacheableResponse.ts

@@ -24,7 +24,7 @@ export interface CacheableResponseOptions {
  * [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
  * to be considered cacheable.
  *
- * @memberof workbox.cacheableResponse
+ * @memberof module:workbox-cacheable-response
  */
 class CacheableResponse {
   private _statuses?: CacheableResponseOptions['statuses'];