docs: using jsdoc module syntax correctly

Author: David Joy

src/config.js

@@ -40,7 +40,7 @@ let config = {
  * reference to an existing object, and is thus safe to call as often as desired.  The document
  * should have the following keys at a minimum:
  *
- * @memberof Config
+ * @memberof module:Config
  * @returns {ConfigDocument}
   */
 export function getConfig() {
@@ -53,7 +53,7 @@ export function getConfig() {
  * The supplied config document will be tested with `ensureDefinedConfig` to ensure it does not
  * have any `undefined` keys.
  *
- * @memberof Config
+ * @memberof module:Config
  * @param {ConfigDocument} newConfig
  */
 export function setConfig(newConfig) {
@@ -74,7 +74,7 @@ export function setConfig(newConfig) {
  *
  * If any of the key values are `undefined`, an error will be thrown.
  *
- * @memberof Config
+ * @memberof module:Config
  * @param {Object} newConfig
  */
 export function mergeConfig(newConfig) {
@@ -104,7 +104,7 @@ export function mergeConfig(newConfig) {
  * phase handlers responsible for loading additional configuration data in the initialization
  * sequence.
  *
- * @memberof Config
+ * @memberof module:Config
  * @param {Array} keys
  * @param {string} [requester='unspecified application code']
  */
@@ -152,5 +152,5 @@ export function ensureConfig(keys, requester = 'unspecified application code') {
  * @property {string} SEGMENT_KEY
  * @property {string} SITE_NAME
  * @property {string} USER_INFO_COOKIE_NAME
- * @memberof Config
+ * @memberof module:Config
  */

src/initialize.js

@@ -32,13 +32,12 @@ export const APP_INIT_ERROR = `${APP_TOPIC}.INIT_ERROR`;
  * package.  Applications are encouraged to use this history object, rather than creating their own,
  * as behavior may be undefined when managing history via multiple mechanisms/instances.
  *
- * @memberof Utilities
+ * @memberof module:Utilities
  */
 export const history = createBrowserHistory();
 
 /**
- * @memberof Initialization
- * @exports
+ * @memberof module:Initialization
  * @param {*} error
  */
 export async function initError(error) {
@@ -54,7 +53,7 @@ export async function initError(error) {
  * - Optionally loading additional user information via the application's user account data
  * endpoint.
  *
- * @memberof Initialization
+ * @memberof module:Initialization
  * @param {boolean} requireUser Whether or not we should redirect to login if a user is not
  * authenticated.
  * @param {boolean} hydrateUser Whether or not we should fetch additional user account data.
@@ -82,7 +81,7 @@ export async function auth(requireUser, hydrateUser) {
  * service.  This is a pre-requisite for sending analytics events, thus, we do it during the
  * initialization sequence so that analytics is ready once the application's UI code starts to load.
  *
- * @memberof Initialization
+ * @memberof module:Initialization
  */
 export async function analytics() {
   const authenticatedUser = getAuthenticatedUser();
@@ -112,7 +111,7 @@ function applyOverrideHandlers(overrides) {
  * Invokes the application initialization sequence.
  *
  *
- * @memberof Initialization
+ * @memberof module:Initialization
  * @param {Object} [options]
  * @param {*} [options.loggingService=NewRelicLoggingService] The `LoggingService` implementation
  * to use.

src/pubSub.js

@@ -20,7 +20,7 @@ import PubSub from 'pubsub-js';
 
 /**
  *
- * @memberof PubSub
+ * @memberof module:PubSub
  * @param {string} type
  * @param {function} callback
  * @returns {string} A subscription token that can be passed to `unsubscribe`
@@ -31,7 +31,7 @@ export function subscribe(type, callback) {
 
 /**
  *
- * @memberof PubSub
+ * @memberof module:PubSub
  * @param {string} token A subscription token provided by `subscribe`
  */
 export function unsubscribe(token) {
@@ -40,7 +40,7 @@ export function unsubscribe(token) {
 
 /**
  *
- * @memberof PubSub
+ * @memberof module:PubSub
  * @param {string} type
  * @param {Object} data
  */

src/utils.js

@@ -31,7 +31,7 @@ import snakeCase from 'lodash.snakecase';
  * Can accept arrays as well as objects, and will perform its conversion on any objects it finds in
  * the array.
  *
- * @memberof Utilities
+ * @memberof module:Utilities
  * @param {Object} object
  * @param {function} modify
  * @returns {Object}
@@ -67,7 +67,7 @@ export function modifyObjectKeys(object, modify) {
  * Can accept arrays as well as objects, and will perform its conversion on any objects it finds in
  * the array.
  *
- * @memberof Utilities
+ * @memberof module:Utilities
  * @param {Array|Object} object
  * @returns {Array|Object}
  */
@@ -84,7 +84,7 @@ export function camelCaseObject(object) {
  * Can accept arrays as well as objects, and will perform its conversion on any objects it finds in
  * the array.
  *
- * @memberof Utilities
+ * @memberof module:Utilities
  * @param {Array|Object} object
  * @returns {Array|Object}
  */
@@ -114,7 +114,7 @@ export function snakeCaseObject(object) {
  * Can accept arrays as well as objects, and will perform its conversion on any objects it finds in
  * the array.
  *
- * @memberof Utilities
+ * @memberof module:Utilities
  * @param {Array|Object} object
  * @param {Object} nameMap
  * @returns {Array|Object}
@@ -132,7 +132,7 @@ export function convertKeyNames(object, nameMap) {
  * [window.searchParams](https://developer.mozilla.org/en-US/docs/Web/API/URL/searchParams)
  *
  * @deprecated
- * @memberof Utilities
+ * @memberof module:Utilities
  * @param {string} [search=global.location.search]
  * @returns {Object}
  */
@@ -158,7 +158,7 @@ export function getQueryParameters(search = global.location.search) {
  *
  * Keys that are intended to be falsy should be defined using null, 0, false, etc.
  *
- * @memberof Utilities
+ * @memberof module:Utilities
  * @param {Object} object
  * @param {string} requester A human-readable identifier for the code which called this function.
  * Used when throwing errors to aid in debugging.