Fixing the JSDoc.

Author: anu3990

lib/plan-builder.js

@@ -118,7 +118,9 @@ class RdtExpr {
    * Controls features such as the length and type of the generated value.
    * @method planBuilder#maskDeterministic
    * @since 2.7.0
-   * @param args - Options for redacting.
+   * @param args - with column and options - Column is the name of the column to be defined.
+   *  This can be either a string or the return value from PlanBuilder.col(), PlanBuilder.viewCol() or PlanBuilder.schemaCol().
+   *  Options is an object with name-value pairs specific to the redaction method.
    * @returns { planBuilder.PlanExprCol }
    */
   maskDeterministic(...args) {
@@ -128,7 +130,9 @@ class RdtExpr {
    * Controls the length of the generated value and type of replacement text (numbers or letters).
    * @method planBuilder#maskRandom
    * @since 2.7.0
-   * @param args - Options for redacting.
+   * @param args - with column and options - Column is the name of the column to be defined.
+   *  This can be either a string or the return value from PlanBuilder.col(), PlanBuilder.viewCol() or PlanBuilder.schemaCol().
+   *  Options is an object with name-value pairs specific to the redaction method.
    * @returns { planBuilder.PlanExprCol }
    */
   maskRandom(...args) {
@@ -137,7 +141,9 @@ class RdtExpr {
   /** This function redacts data that matches the pattern of a dateTime value. Controls the expected input format and the masking dateTime format.
    * @method planBuilder#redactDatetime
    * @since 2.7.0
-   * @param args - Options for redacting.
+   * @param args - with column and options - Column is the name of the column to be defined.
+   *  This can be either a string or the return value from PlanBuilder.col(), PlanBuilder.viewCol() or PlanBuilder.schemaCol().
+   *  Options is an object with name-value pairs specific to the redaction method.
    * @returns { planBuilder.PlanExprCol }
    */
   redactDatetime(...args) {
@@ -147,7 +153,9 @@ class RdtExpr {
    * Controls whether to mask the entire address, only the username, or only the domain name.
    * @method planBuilder#redactEmail
    * @since 2.7.0
-   * @param args - Options for redacting.
+   * @param args - with column and options - Column is the name of the column to be defined.
+   *  This can be either a string or the return value from PlanBuilder.col(), PlanBuilder.viewCol() or PlanBuilder.schemaCol().
+   *  Options is an object with name-value pairs specific to the redaction method.
    * @returns { planBuilder.PlanExprCol }
    */
   redactEmail(...args) {
@@ -156,7 +164,9 @@ class RdtExpr {
   /** This function redacts data that matches the pattern of an IPv4 address. Controls what character to use as a masking character.
    * @method planBuilder#redactIpv4
    * @since 2.7.0
-   * @param args - Options for redacting.
+   * @param args - with column and options - Column is the name of the column to be defined.
+   *  This can be either a string or the return value from PlanBuilder.col(), PlanBuilder.viewCol() or PlanBuilder.schemaCol().
+   *  Options is an object with name-value pairs specific to the redaction method.
    * @returns { planBuilder.PlanExprCol }
    */
   redactIpv4(...args) {
@@ -165,7 +175,9 @@ class RdtExpr {
   /** This function replaces values with random numbers. Controls the data type, range, and format of the masking values.
    * @method planBuilder#redactNumber
    * @since 2.7.0
-   * @param args - Options for redacting.
+   * @param args - with column and options - Column is the name of the column to be defined.
+   *  This can be either a string or the return value from PlanBuilder.col(), PlanBuilder.viewCol() or PlanBuilder.schemaCol().
+   *  Options is an object with name-value pairs specific to the redaction method.
    * @returns { planBuilder.PlanExprCol }
    */
   redactNumber(...args) {
@@ -174,7 +186,9 @@ class RdtExpr {
   /** This function redacts data that matches a given regular expression. You must specify the regular expression and the masking text.
    * @method planBuilder#redactRegex
    * @since 2.7.0
-   * @param args - Options for redacting.
+   * @param args - with column and options - Column is the name of the column to be defined.
+   *  This can be either a string or the return value from PlanBuilder.col(), PlanBuilder.viewCol() or PlanBuilder.schemaCol().
+   *  Options is an object with name-value pairs specific to the redaction method.
    * @returns { planBuilder.PlanExprCol }
    */
   redactRegex(...args) {
@@ -184,7 +198,9 @@ class RdtExpr {
    * Controls whether or not to preserve the last 4 digits and what character to use as a masking character.
    * @method planBuilder#redactUsSsn
    * @since 2.7.0
-   * @param args - Options for redacting.
+   * @param args - with column and options - Column is the name of the column to be defined.
+   *  This can be either a string or the return value from PlanBuilder.col(), PlanBuilder.viewCol() or PlanBuilder.schemaCol().
+   *  Options is an object with name-value pairs specific to the redaction method.
    * @returns { planBuilder.PlanExprCol }
    */
   redactUsSsn(...args) {
@@ -194,7 +210,9 @@ class RdtExpr {
    * Controls whether or not to preserve the last 4 digits and what character to use as a masking character.
    * @method planBuilder#redactUsPhone
    * @since 2.7.0
-   * @param args - Options for redacting.
+   * @param args - with column and options - Column is the name of the column to be defined.
+   *  This can be either a string or the return value from PlanBuilder.col(), PlanBuilder.viewCol() or PlanBuilder.schemaCol().
+   *  Options is an object with name-value pairs specific to the redaction method.
    * @returns { planBuilder.PlanExprCol }
    */
   redactUsPhone(...args) {