API documentation updates

packages/node_modules/@node-red/util/index.js

@@ -1,4 +1,4 @@
-/**
+/*!
  * Copyright JS Foundation and other contributors, http://js.foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,17 +14,20 @@
  * limitations under the License.
  **/
 
- /**
-  * @module @node-red/util
-  */
 const log = require("./lib/log");
 const i18n = require("./lib/i18n");
 const util = require("./lib/util");
 
+/**
+ * This module provides common utilities for the Node-RED runtime and editor
+ *
+ * @namespace @node-red/util
+ */
 module.exports = {
     /**
     * Initialise the module with the runtime settings
     * @param {Object} settings
+    * @memberof @node-red/util
     */
     init: function(settings) {
         log.init(settings);
@@ -33,19 +36,22 @@ module.exports = {
 
     /**
     * Logging utilities
-    * @see module:@node-red/util.module:log
+    * @mixes @node-red/util_log
+    * @memberof @node-red/util
     */
     log: log,
 
     /**
     * Internationalization utilities
-    * @see module:@node-red/util.module:i18n
+    * @mixes @node-red/util_i18n
+    * @memberof @node-red/util
     */
     i18n: i18n,
 
     /**
     * General utilities
-    * @see module:@node-red/util.module:util
+    * @mixes @node-red/util_util
+    * @memberof @node-red/util
     */
     util: util,
 }