[JSDoc] Add missing documentation for botbuilder-dialogs-adaptive entityRecognizers folder

libraries/botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/ageEntityRecognizer.ts

@@ -10,9 +10,20 @@ import { recognizeAge } from '@microsoft/recognizers-text-number-with-unit';
 import { ModelResult } from 'botbuilder-dialogs';
 import { TextEntityRecognizer } from './textEntityRecognizer';
 
+/**
+ * Recognizes age input.
+ */
 export class AgeEntityRecognizer extends TextEntityRecognizer {
+
     public static $kind = 'Microsoft.AgeEntityRecognizer';
 
+    /**
+     * @protected
+     * Age recognizing implementation.
+     * @param text Text to recognize.
+     * @param culture Culture to use.
+     * @returns The recognized [ModelResult](xref:botbuilder-dialogs.ModelResult) list.
+     */
     protected recognize(text: string, culture: string): ModelResult[] {
         return recognizeAge(text, culture);
     }

libraries/botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/confirmationEntityRecognizer.ts

@@ -10,9 +10,20 @@ import { recognizeBoolean } from '@microsoft/recognizers-text-choice';
 import { ModelResult } from 'botbuilder-dialogs';
 import { TextEntityRecognizer } from './textEntityRecognizer';
 
+/**
+ * Recognizes yes/no confirmation style input.
+ */
 export class ConfirmationEntityRecognizer extends TextEntityRecognizer {
+
     public static $kind = 'Microsoft.ConfirmationEntityRecognizer';
 
+    /**
+     * @protected
+     * Yes/no confirmation style input recognizing implementation.
+     * @param text Text to recognize.
+     * @param culture Culture to use.
+     * @returns The recognized [ModelResult](xref:botbuilder-dialogs.ModelResult) list.
+     */
     protected recognize(text: string, culture: string): ModelResult[] {
         return recognizeBoolean(text, culture);
     }

libraries/botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/currencyEntityRecognizer.ts

@@ -10,9 +10,20 @@ import { recognizeCurrency } from '@microsoft/recognizers-text-number-with-unit'
 import { ModelResult } from 'botbuilder-dialogs';
 import { TextEntityRecognizer } from './textEntityRecognizer';
 
+/**
+ * Recognizes currency input.
+ */
 export class CurrencyEntityRecognizer extends TextEntityRecognizer {
+
     public static $kind = 'Microsoft.CurrencyEntityRecognizer';
 
+    /**
+     * @protected
+     * Currency recognizing implementation.
+     * @param text Text to recognize.
+     * @param culture Culture to use.
+     * @returns The recognized [ModelResult](xref:botbuilder-dialogs.ModelResult) list.
+     */
     protected recognize(text: string, culture: string): ModelResult[] {
         return recognizeCurrency(text, culture);
     }

libraries/botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/dateTimeEntityRecognizer.ts

@@ -10,9 +10,20 @@ import { recognizeDateTime } from '@microsoft/recognizers-text-date-time';
 import { ModelResult } from 'botbuilder-dialogs';
 import { TextEntityRecognizer } from './textEntityRecognizer';
 
+/**
+ * Recognizes DateTime input.
+ */
 export class DateTimeEntityRecognizer extends TextEntityRecognizer {
+
     public static $kind = 'Microsoft.DateTimeEntityRecognizer';
 
+    /**
+     * @protected
+     * DateTime recognizing implementation.
+     * @param text Text to recognize.
+     * @param culture Culture to use.
+     * @returns The recognized [ModelResult](xref:botbuilder-dialogs.ModelResult) list.
+     */
     protected recognize(text: string, culture: string): ModelResult[] {
         return recognizeDateTime(text, culture);
     }

libraries/botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/dimensionEntityRecognizer.ts

@@ -10,9 +10,20 @@ import { recognizeDimension } from '@microsoft/recognizers-text-number-with-unit
 import { ModelResult } from 'botbuilder-dialogs';
 import { TextEntityRecognizer } from './textEntityRecognizer';
 
+/**
+ * Recognizes dimension input.
+ */
 export class DimensionEntityRecognizer extends TextEntityRecognizer {
+
     public static $kind = 'Microsoft.DimensionEntityRecognizer';
 
+    /**
+     * @protected
+     * Dimension recognizing implementation.
+     * @param text Text to recognize.
+     * @param culture Culture to use.
+     * @returns The recognized [ModelResult](xref:botbuilder-dialogs.ModelResult) list.
+     */
     protected recognize(text: string, culture: string): ModelResult[] {
         return recognizeDimension(text, culture);
     }

libraries/botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/emailEntityRecognizer.ts

@@ -10,9 +10,20 @@ import { recognizeEmail } from '@microsoft/recognizers-text-sequence';
 import { ModelResult } from 'botbuilder-dialogs';
 import { TextEntityRecognizer } from './textEntityRecognizer';
 
+/**
+ * Recognizes email input.
+ */
 export class EmailEntityRecognizer extends TextEntityRecognizer {
+
     public static $kind = 'Microsoft.EmailEntityRecognizer';
 
+    /**
+     * @protected
+     * Email recognizing implementation.
+     * @param text Text to recognize.
+     * @param culture Culture to use.
+     * @returns The recognized [ModelResult](xref:botbuilder-dialogs.ModelResult) list.
+     */
     protected recognize(text: string, culture: string): ModelResult[] {
         return recognizeEmail(text, culture);
     }

libraries/botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/entityRecognizerSet.ts

@@ -11,7 +11,18 @@ import { DialogContext } from 'botbuilder-dialogs';
 import { EntityRecognizer } from './entityRecognizer';
 import { TextEntity } from './textEntity';
 
+/**
+ * EntityRecognizerSet - Implements a workflow against a pool of [EntityRecognizer](xref:botbuilder-dialogs-adaptive.EntityRecognizer) instances, iterating until nobody has anything new to add.
+ */
 export class EntityRecognizerSet extends Array<EntityRecognizer> {
+    /**
+     * Implement [EntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognizeEntities) by iterating against the Recognizer pool.
+     * @param dialogContext [DialogContext](xref:botbuilder-dialogs.DialogContext) for the current turn of conversation.
+     * @param text Text to recognize.
+     * @param locale Locale to use.
+     * @param entities The [Entity](xref:botframework-schema.Entity) array to be recognized. If no entities are passed in, it will generate a [TextEntity](xref:botbuilder-dialogs-adaptive.TextEntity).
+     * @returns Recognized [Entity](xref:botframework-schema.Entity) list Promise.
+     */
     public async recognizeEntities(
         dialogContext: DialogContext,
         text: string,

libraries/botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/guidEntityRecognizer.ts

@@ -10,9 +10,20 @@ import { recognizeGUID } from '@microsoft/recognizers-text-sequence';
 import { ModelResult } from 'botbuilder-dialogs';
 import { TextEntityRecognizer } from './textEntityRecognizer';
 
+/**
+ * Recognizes GUID input.
+ */
 export class GuidEntityRecognizer extends TextEntityRecognizer {
+
     public static $kind = 'Microsoft.GuidEntityRecognizer';
 
+    /**
+     * @protected
+     * GUID recognizing implementation.
+     * @param text Text to recognize.
+     * @param culture Culture to use.
+     * @returns The recognized [ModelResult](xref:botbuilder-dialogs.ModelResult) list.
+     */
     protected recognize(text: string, culture: string): ModelResult[] {
         return recognizeGUID(text, culture);
     }

libraries/botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/hashtagEntityRecognizer.ts

@@ -10,9 +10,20 @@ import { recognizeHashtag } from '@microsoft/recognizers-text-sequence';
 import { ModelResult } from 'botbuilder-dialogs';
 import { TextEntityRecognizer } from './textEntityRecognizer';
 
+/**
+ * Recognizes hashtag input.
+ */
 export class HashtagEntityRecognizer extends TextEntityRecognizer {
+
     public static $kind = 'Microsoft.HashtagEntityRecognizer';
 
+    /**
+     * @protected
+     * Hashtag recognizing implementation.
+     * @param text Text to recognize.
+     * @param culture Culture to use.
+     * @returns The recognized [ModelResult](xref:botbuilder-dialogs.ModelResult) list.
+     */
     protected recognize(text: string, culture: string): ModelResult[] {
         return recognizeHashtag(text, culture);
     }

libraries/botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/ipEntityRecognizer.ts

@@ -10,9 +10,20 @@ import { recognizeIpAddress } from '@microsoft/recognizers-text-sequence';
 import { ModelResult } from 'botbuilder-dialogs';
 import { TextEntityRecognizer } from './textEntityRecognizer';
 
+/**
+ * Recognizes IP input.
+ */
 export class IpEntityRecognizer extends TextEntityRecognizer {
+
     public static $kind = 'Microsoft.IpEntityRecognizer';
 
+    /**
+     * @protected
+     * IP recognizing implementation.
+     * @param text Text to recognize.
+     * @param culture Culture to use.
+     * @returns The recognized [ModelResult](xref:botbuilder-dialogs.ModelResult) list.
+     */
     protected recognize(text: string, culture: string): ModelResult[] {
         return recognizeIpAddress(text, culture);
     }

libraries/botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/mentionEntityRecognizer.ts

@@ -10,9 +10,20 @@ import { recognizeMention } from '@microsoft/recognizers-text-sequence';
 import { ModelResult } from 'botbuilder-dialogs';
 import { TextEntityRecognizer } from './textEntityRecognizer';
 
+/**
+ * Recognizes mention input.
+ */
 export class MentionEntityRecognizer extends TextEntityRecognizer {
+
     public static $kind = 'Microsoft.MentionEntityRecognizer';
 
+    /**
+     * @protected
+     * Mention recognizing implementation.
+     * @param text Text to recognize.
+     * @param culture Culture to use.
+     * @returns The recognized [ModelResult](xref:botbuilder-dialogs.ModelResult) list.
+     */
     protected recognize(text: string, culture: string): ModelResult[] {
         return recognizeMention(text, culture);
     }

libraries/botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/numberEntityRecognizer.ts

@@ -10,9 +10,20 @@ import { recognizeNumber } from '@microsoft/recognizers-text-number';
 import { ModelResult } from 'botbuilder-dialogs';
 import { TextEntityRecognizer } from './textEntityRecognizer';
 
+/**
+ * Recognizes number input.
+ */
 export class NumberEntityRecognizer extends TextEntityRecognizer {
+
     public static $kind = 'Microsoft.NumberEntityRecognizer';
 
+    /**
+     * @protected
+     * Number recognizing implementation.
+     * @param text Text to recognize.
+     * @param culture Culture to use.
+     * @returns The recognized [ModelResult](xref:botbuilder-dialogs.ModelResult) list.
+     */
     protected recognize(text: string, culture: string): ModelResult[] {
         return recognizeNumber(text, culture);
     }

libraries/botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/ordinalEntityRecognizer.ts

@@ -10,9 +10,20 @@ import { recognizeOrdinal } from '@microsoft/recognizers-text-number';
 import { ModelResult } from 'botbuilder-dialogs';
 import { TextEntityRecognizer } from './textEntityRecognizer';
 
+/**
+ * Recognizes ordinal input.
+ */
 export class OrdinalEntityRecognizer extends TextEntityRecognizer {
+
     public static $kind = 'Microsoft.OrdinalEntityRecognizer';
 
+    /**
+     * @protected
+     * Ordinal recognizing implementation.
+     * @param text Text to recognize.
+     * @param culture Culture to use.
+     * @returns The recognized [ModelResult](xref:botbuilder-dialogs.ModelResult) list.
+     */
     protected recognize(text: string, culture: string): ModelResult[] {
         return recognizeOrdinal(text, culture);
     }

libraries/botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/percentageEntityRecognizer.ts

@@ -10,9 +10,20 @@ import { recognizePercentage } from '@microsoft/recognizers-text-number';
 import { ModelResult } from 'botbuilder-dialogs';
 import { TextEntityRecognizer } from './textEntityRecognizer';
 
+/**
+ * Recognizes percentage input.
+ */
 export class PercentageEntityRecognizer extends TextEntityRecognizer {
+
     public static $kind = 'Microsoft.PercentageEntityRecognizer';
 
+    /**
+     * @protected
+     * Percentage recognizing implementation.
+     * @param text Text to recognize.
+     * @param culture Culture to use.
+     * @returns The recognized [ModelResult](xref:botbuilder-dialogs.ModelResult) list.
+     */
     protected recognize(text: string, culture: string): ModelResult[] {
         return recognizePercentage(text, culture);
     }

libraries/botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/phoneNumberEntityRecognizer.ts

@@ -10,9 +10,20 @@ import { recognizePhoneNumber } from '@microsoft/recognizers-text-sequence';
 import { ModelResult } from 'botbuilder-dialogs';
 import { TextEntityRecognizer } from './textEntityRecognizer';
 
+/**
+ * Recognizes phone number input.
+ */
 export class PhoneNumberEntityRecognizer extends TextEntityRecognizer {
+
     public static $kind = 'Microsoft.PhoneNumberEntityRecognizer';
 
+    /**
+     * @protected
+     * Phone number recognizing implementation.
+     * @param text Text to recognize.
+     * @param culture Culture to use.
+     * @returns The recognized [ModelResult](xref:botbuilder-dialogs.ModelResult) list.
+     */
     protected recognize(text: string, culture: string): ModelResult[] {
         return recognizePhoneNumber(text, culture);
     }

libraries/botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/regexEntityRecognizer.ts

@@ -18,6 +18,11 @@ export class RegexEntityRecognizer extends TextEntityRecognizer implements Regex
     public static $kind = 'Microsoft.RegexEntityRecognizer';
 
     public constructor();
+    /**
+     * Initializes a new instance of the [RegexEntityRecognizer](xref:botbuilder-dialogs-adaptive.RegexEntityRecognizer) class.
+     * @param name The name match result `typeName` value.
+     * @param pattern The regular expression pattern value.
+     */
     public constructor(name?: string, pattern?: string) {
         super();
         if (name) {
@@ -30,10 +35,16 @@ export class RegexEntityRecognizer extends TextEntityRecognizer implements Regex
 
     public name: string;
 
+    /**
+     * Gets the regular expression pattern value.
+     */
     public get pattern(): string {
         return this._pattern;
     }
 
+    /**
+     * Sets the regular expression pattern value.
+     */
     public set pattern(value: string) {
         if (value.startsWith('(?i)')) {
             value = value.substr(4);
@@ -43,6 +54,13 @@ export class RegexEntityRecognizer extends TextEntityRecognizer implements Regex
 
     private _pattern: string;
 
+    /**
+     * @protected
+     * Match recognizing implementation.
+     * @param text Text to match.
+     * @param culture Culture to use.
+     * @returns The matched [ModelResult](xref:botbuilder-dialogs.ModelResult) list.
+     */
     protected recognize(text: string, culture: string): ModelResult[] {
         const results: ModelResult[] = [];
 

libraries/botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/temperatureEntityRecognizer.ts

@@ -10,9 +10,20 @@ import { recognizeTemperature } from '@microsoft/recognizers-text-number-with-un
 import { ModelResult } from 'botbuilder-dialogs';
 import { TextEntityRecognizer } from './textEntityRecognizer';
 
+/**
+ * Recognizes temperature input.
+ */
 export class TemperatureEntityRecognizer extends TextEntityRecognizer {
+
     public static $kind = 'Microsoft.TemperatureEntityRecognizer';
 
+    /**
+     * @protected
+     * Temperature recognizing implementation.
+     * @param text Text to recognize.
+     * @param culture Culture to use.
+     * @returns The recognized [ModelResult](xref:botbuilder-dialogs.ModelResult) list.
+     */
     protected recognize(text: string, culture: string): ModelResult[] {
         return recognizeTemperature(text, culture);
     }

libraries/botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/textEntity.ts

@@ -8,11 +8,18 @@
 
 import { Entity } from 'botbuilder-core';
 
+/**
+ * Text entity base class.
+ */
 export class TextEntity implements Entity {
     public type = 'text';
 
     public text: string;
 
+    /**
+     * Initializes a new instance of the [TextEntity](xref:botbuilder-dialogs-adaptive.TextEntity) class.
+     * @param text The text value.
+     */
     public constructor(text?: string) {
         this.text = text;
     }