fixup on JSDoc generated for Optic #556

ehennum · ehennum · commit 5f4684d3e6b3 · 2020-08-10T17:28:33.000-07:00
diff --git a/lib/plan-builder-generated.js b/lib/plan-builder-generated.js
@@ -3250,7 +3250,7 @@ class JsonExpr {
   constructor() {
   }
   /**
-    * Creates a (JSON) array, which is like a sequence of values, but allows for nesting. Provides a client interface to a server function. See {@link http://docs.marklogic.com/json.array|json.array}
+    * Creates a (JSON) array, which is like a sequence of values, but allows for nesting. Provides a client interface to a server function. See {@link http://docs.marklogic.com/json:array|json:array}
     * @method planBuilder.json#array
     * @since 2.1.1
     * @param { ElementNode } [array] - A serialized array element.
@@ -3262,7 +3262,7 @@ array(...args) {
     return new types.JsonArray('json', 'array', checkedArgs);
     }
 /**
-    * Returns the size of the array. Provides a client interface to a server function. See {@link http://docs.marklogic.com/json.arraySize|json.arraySize}
+    * Returns the size of the array. Provides a client interface to a server function. See {@link http://docs.marklogic.com/json:array-size|json:array-size}
     * @method planBuilder.json#arraySize
     * @since 2.1.1
     * @param { JsonArray } [array] - An array.
@@ -3274,7 +3274,7 @@ arraySize(...args) {
     return new types.XsUnsignedLong('json', 'array-size', checkedArgs);
     }
 /**
-    * Returns the array values as an XQuery sequence. Provides a client interface to a server function. See {@link http://docs.marklogic.com/json.arrayValues|json.arrayValues}
+    * Returns the array values as an XQuery sequence. Provides a client interface to a server function. See {@link http://docs.marklogic.com/json:array-values|json:array-values}
     * @method planBuilder.json#arrayValues
     * @since 2.1.1
     * @param { JsonArray } [array] - An array.
@@ -3291,7 +3291,7 @@ arrayValues(...args) {
 
     }
 /**
-    * Creates a JSON object, which is a kind of map with a fixed and ordered set of keys. Provides a client interface to a server function. See {@link http://docs.marklogic.com/json.object|json.object}
+    * Creates a JSON object, which is a kind of map with a fixed and ordered set of keys. Provides a client interface to a server function. See {@link http://docs.marklogic.com/json:object|json:object}
     * @method planBuilder.json#object
     * @since 2.1.1
     * @param { ElementNode } [map] - A serialized JSON object.
@@ -3303,7 +3303,7 @@ object(...args) {
     return new types.JsonObject('json', 'object', checkedArgs);
     }
 /**
-    * Creates a JSON object. Provides a client interface to a server function. See {@link http://docs.marklogic.com/json.objectDefine|json.objectDefine}
+    * Creates a JSON object. Provides a client interface to a server function. See {@link http://docs.marklogic.com/json:object-define|json:object-define}
     * @method planBuilder.json#objectDefine
     * @since 2.1.1
     * @param { XsString } [keys] - The sequence of keys in this object.
@@ -3315,7 +3315,7 @@ objectDefine(...args) {
     return new types.JsonObject('json', 'object-define', checkedArgs);
     }
 /**
-    * Extract a subarray from an array, producing a new array. The second and third arguments to this function operate similarly to those of fn:subsequence for XQuery sequences. Provides a client interface to a server function. See {@link http://docs.marklogic.com/json.subarray|json.subarray}
+    * Extract a subarray from an array, producing a new array. The second and third arguments to this function operate similarly to those of fn:subsequence for XQuery sequences. Provides a client interface to a server function. See {@link http://docs.marklogic.com/json:subarray|json:subarray}
     * @method planBuilder.json#subarray
     * @since 2.1.1
     * @param { JsonArray } [array] - An array.
@@ -3333,7 +3333,7 @@ subarray(...args) {
 
     }
 /**
-    * Constructs a json:array from a sequence of items. Provides a client interface to a server function. See {@link http://docs.marklogic.com/json.toArray|json.toArray}
+    * Constructs a json:array from a sequence of items. Provides a client interface to a server function. See {@link http://docs.marklogic.com/json:to-array|json:to-array}
     * @method planBuilder.json#toArray
     * @since 2.1.1
     * @param { Item } [items] - The items to be used as elements in the constructed array.
@@ -3355,7 +3355,7 @@ class MapExpr {
   constructor() {
   }
   /**
-    * Returns true if the key exists in the map. Provides a client interface to a server function. See {@link http://docs.marklogic.com/map.contains|map.contains}
+    * Returns true if the key exists in the map. Provides a client interface to a server function. See {@link http://docs.marklogic.com/map:contains|map:contains}
     * @method planBuilder.map#contains
     * @since 2.1.1
     * @param { MapMap } [map] - A map.
@@ -3372,7 +3372,7 @@ contains(...args) {
 
     }
 /**
-    * Returns the number of keys used in the map. Provides a client interface to a server function. See {@link http://docs.marklogic.com/map.count|map.count}
+    * Returns the number of keys used in the map. Provides a client interface to a server function. See {@link http://docs.marklogic.com/map:count|map:count}
     * @method planBuilder.map#count
     * @since 2.1.1
     * @param { MapMap } [map] - A map.
@@ -3384,7 +3384,7 @@ count(...args) {
     return new types.XsUnsignedInt('map', 'count', checkedArgs);
     }
 /**
-    * Constructs a new map with a single entry consisting of the key and value specified as arguments. This is particularly helpful when used as part of an argument to map:new(). Provides a client interface to a server function. See {@link http://docs.marklogic.com/map.entry|map.entry}
+    * Constructs a new map with a single entry consisting of the key and value specified as arguments. This is particularly helpful when used as part of an argument to map:new(). Provides a client interface to a server function. See {@link http://docs.marklogic.com/map:entry|map:entry}
     * @method planBuilder.map#entry
     * @since 2.1.1
     * @param { XsString } [key] - The map key.
@@ -3401,7 +3401,7 @@ entry(...args) {
 
     }
 /**
-    * Get a value from a map. Provides a client interface to a server function. See {@link http://docs.marklogic.com/map.get|map.get}
+    * Get a value from a map. Provides a client interface to a server function. See {@link http://docs.marklogic.com/map:get|map:get}
     * @method planBuilder.map#get
     * @since 2.1.1
     * @param { MapMap } [map] - A map.
@@ -3418,7 +3418,7 @@ get(...args) {
 
     }
 /**
-    * Get the keys used in the map. Provides a client interface to a server function. See {@link http://docs.marklogic.com/map.keys|map.keys}
+    * Get the keys used in the map. Provides a client interface to a server function. See {@link http://docs.marklogic.com/map:keys|map:keys}
     * @method planBuilder.map#keys
     * @since 2.1.1
     * @param { MapMap } [map] - A map.
@@ -3430,7 +3430,7 @@ keys(...args) {
     return new types.XsString('map', 'keys', checkedArgs);
     }
 /**
-    * Creates a map. Provides a client interface to a server function. See {@link http://docs.marklogic.com/map.map|map.map}
+    * Creates a map. Provides a client interface to a server function. See {@link http://docs.marklogic.com/map:map|map:map}
     * @method planBuilder.map#map
     * @since 2.1.1
     * @param { ElementNode } [map] - A serialized map element.
@@ -4144,7 +4144,7 @@ iri(...args) {
     return new types.SemIri('sem', 'iri', checkedArgs);
     }
 /**
-    *  Provides a client interface to a server function.
+    * Converts an IRI value to a QName value. Provides a client interface to a server function.
     * @method planBuilder.sem#iriToQName
     * @since 2.1.1
     * @param { XsString } [arg1] - 
@@ -4233,7 +4233,7 @@ langMatches(...args) {
 
     }
 /**
-    *  Provides a client interface to a server function.
+    * Converts a QName value to an IRI value. Provides a client interface to a server function.
     * @method planBuilder.sem#QNameToIri
     * @since 2.1.1
     * @param { XsQName } [arg1] - 
@@ -4466,7 +4466,7 @@ collatedString(...args) {
 
     }
 /**
-    * Returns a specified date with the specified number interval (signed integer) added to a specified datepart of that date  Provides a client interface to a server function. See {@link http://docs.marklogic.com/sql.dateadd|sql.dateadd}
+    * Returns a specified date with the specified number interval (signed integer) added to a specified datepart of that date  Provides a client interface to a server function. See {@link http://docs.marklogic.com/sql:dateadd|sql:dateadd}
     * @method planBuilder.sql#dateadd
     * @since 2.1.1
     * @param { XsString } [datepart] - Is the part of date where the number will be added. The following table lists all valid datepart arguments. User-defined variable equivalents are not valid. The return data type is the data type of the date argument. Options: datepart parameter abbreviation includes:  "year","yyyy","yy" The year part of the date "quarter","qq","q" The quarter part of the date "month","mm","m" The month part of the date "dayofyear","dy","y" The day of the year from the date "day","dd","d" The day of the month from the date "week","wk","ww" The week of the year from the date "weekday","dw" The day of the week from the date "hour","hh" The hour of the day from the date "minute","mi","n" The minute of the hour from the date "second","ss","s" The second of the minute from the date "millisecond","ms" The millisecond of the minute from the date "microsecond","msc" The microsecond of the minute from the date "nanosecond","ns" The nanosecond of the minute from the date 
@@ -4484,7 +4484,7 @@ dateadd(...args) {
 
     }
 /**
-    * Returns the count (signed integer) of the specified datepart boundaries crossed between the specified startdate and enddate.  Provides a client interface to a server function. See {@link http://docs.marklogic.com/sql.datediff|sql.datediff}
+    * Returns the count (signed integer) of the specified datepart boundaries crossed between the specified startdate and enddate.  Provides a client interface to a server function. See {@link http://docs.marklogic.com/sql:datediff|sql:datediff}
     * @method planBuilder.sql#datediff
     * @since 2.1.1
     * @param { XsString } [datepart] - Is the part of startdate and enddate that specifies the type of boundary crossed. The following table lists all valid datepart arguments. User-defined variable equivalents are not valid. Options: datepart parameter abbreviation includes:  "year","yyyy","yy" The year part of the date "quarter","qq","q" The quarter part of the date "month","mm","m" The month part of the date "dayofyear","dy","y" The day of the year from the date "day","dd","d" The day of the month from the date "week","wk","ww" The week of the year from the date "weekday","dw" The day of the week from the date "hour","hh" The hour of the day from the date "minute","mi","n" The minute of the hour from the date "second","ss","s" The second of the minute from the date "millisecond","ms" The millisecond of the minute from the date "microsecond","msc" The microsecond of the minute from the date "nanosecond","ns" The nanosecond of the minute from the date 
@@ -4502,7 +4502,7 @@ datediff(...args) {
 
     }
 /**
-    * Returns an integer that represents the specified datepart of the specified date.  Provides a client interface to a server function. See {@link http://docs.marklogic.com/sql.datepart|sql.datepart}
+    * Returns an integer that represents the specified datepart of the specified date.  Provides a client interface to a server function. See {@link http://docs.marklogic.com/sql:datepart|sql:datepart}
     * @method planBuilder.sql#datepart
     * @since 2.1.1
     * @param { XsString } [datepart] - The part of date that to be returned. Options: datepart parameter abbreviation includes:  "year","yyyy","yy" The year part of the date "quarter","qq","q" The quarter part of the date "month","mm","m" The month part of the date "dayofyear","dy","y" The day of the year from the date "day","dd","d" The day of the month from the date "week","wk","ww" The week of the year from the date "weekday","dw" The day of the week from the date "hour","hh" The hour of the day from the date "minute","mi","n" The minute of the hour from the date "second","ss","s" The second of the minute from the date "millisecond","ms" The millisecond of the minute from the date "microsecond","msc" The microsecond of the minute from the date "nanosecond","ns" The nanosecond of the minute from the date "TZoffset","tz" The timezone offset from the date 
@@ -4794,7 +4794,13 @@ right(...args) {
     return new types.XsString('sql', 'right', checkedArgs);
 
     }
-/** @ignore */
+/**
+    * Constructs a row identifier from the string form of the temporary identifier assigned to a row during processing. Provides a client interface to a server function.
+    * @method planBuilder.sql#rowID
+    * @since 2.1.1
+    * @param { XsAnyAtomicType } [arg1] - 
+    * @returns { SqlRowID }
+    */
 rowID(...args) {
     const paramdef = ['arg1', [types.XsAnyAtomicType, PlanColumn, PlanParam], false, false];
     const checkedArgs = bldrbase.makeSingleArgs('sql.rowID', 1, paramdef, args);
@@ -4939,7 +4945,7 @@ week(...args) {
     return new types.XsInteger('sql', 'week', checkedArgs);
     }
 /**
-    *  Provides a client interface to a server function.
+    * Returns the day of the week. Provides a client interface to a server function.
     * @method planBuilder.sql#weekday
     * @since 2.1.1
     * @param { Item } [arg1] - 
