updating property docs, setters get getters doc as well and come last.

2019-01-14 17:48:34 +01:00 · 2019-01-14 17:48:34 +01:00 · eacfa7f02a
--- a/src/sdk/IntentRecognizer.ts
+++ b/src/sdk/IntentRecognizer.ts
@ -114,7 +114,7 @@ export class IntentRecognizer extends Recognizer {
    }

    /**
-     * Sets the authorization token used to communicate with the service.
+     * Gets/Sets the authorization token used to communicate with the service.
     * Note: Please use a token derived from your LanguageUnderstanding subscription key for the Intent recognizer.
     * @member IntentRecognizer.prototype.authorizationToken
     * @function
--- a/src/sdk/SpeechConfig.ts
+++ b/src/sdk/SpeechConfig.ts
@ -90,8 +90,8 @@ export abstract class SpeechConfig {
    public abstract get authorizationToken(): string;

    /**
-     * Sets the authorization token.
-     * If this is set, subscription key is ignored.
+     * Get/Sets the authorization token.
+     * If the autorizaton token is set, the subscription key is ignored.
     * User needs to make sure the provided authorization token is valid and not expired.
     * @member SpeechConfig.prototype.authorizationToken
     * @function
@ -109,7 +109,7 @@ export abstract class SpeechConfig {
    public abstract get speechRecognitionLanguage(): string;

    /**
-     * Sets the input language.
+     * Gets/Sets the input language.
     * @member SpeechConfig.prototype.speechRecognitionLanguage
     * @function
     * @public
@ -138,14 +138,6 @@ export abstract class SpeechConfig {
     */
    public abstract getProperty(name: string, def?: string): string;

-    /**
-     * Sets output format.
-     * @member SpeechConfig.prototype.outputFormat
-     * @function
-     * @public
-     */
-    public abstract set outputFormat(format: OutputFormat);
-
    /**
     * Gets output format.
     * @member SpeechConfig.prototype.outputFormat
@ -156,13 +148,12 @@ export abstract class SpeechConfig {
    public abstract get outputFormat(): OutputFormat;

    /**
-     * Sets the endpoint ID of a customized speech model that is used for speech recognition.
-     * @member SpeechConfig.prototype.endpointId
+     * Gets/Sets the output format.
+     * @member SpeechConfig.prototype.outputFormat
     * @function
     * @public
-     * @param {string} value - The endpoint ID
     */
-    public abstract set endpointId(value: string);
+    public abstract set outputFormat(format: OutputFormat);

    /**
     * Gets the endpoint ID of a customized speech model that is used for speech recognition.
@ -173,6 +164,15 @@ export abstract class SpeechConfig {
     */
    public abstract get endpointId(): string;

+    /**
+     * Gets/Sets the endpoint ID of a customized speech model that is used for speech recognition.
+     * @member SpeechConfig.prototype.endpointId
+     * @function
+     * @public
+     * @param {string} value - The endpoint ID
+     */
+    public abstract set endpointId(value: string);
+
    /**
     * Closes the configuration.
     * @member SpeechConfig.prototype.close
@ -239,14 +239,14 @@ export class SpeechConfigImpl extends SpeechConfig {
        this.privProperties.setProperty(OutputFormatPropertyName, OutputFormat[value]);
    }

-    public set endpointId(value: string) {
-        this.privProperties.setProperty(PropertyId.SpeechServiceConnection_EndpointId, value);
-    }
-
    public get endpointId(): string {
        return this.privProperties.getProperty(PropertyId.SpeechServiceConnection_EndpointId);
    }

+    public set endpointId(value: string) {
+        this.privProperties.setProperty(PropertyId.SpeechServiceConnection_EndpointId, value);
+    }
+
    public setProperty(name: string | PropertyId, value: string): void {
        Contracts.throwIfNullOrWhitespace(value, "value");

--- a/src/sdk/SpeechRecognizer.ts
+++ b/src/sdk/SpeechRecognizer.ts
@ -90,18 +90,6 @@ export class SpeechRecognizer extends Recognizer {
        return this.properties.getProperty(PropertyId.SpeechServiceConnection_EndpointId, "00000000-0000-0000-0000-000000000000");
    }

-    /**
-     * Sets the authorization token used to communicate with the service.
-     * @member SpeechRecognizer.prototype.authorizationToken
-     * @function
-     * @public
-     * @param {string} token - Authorization token.
-     */
-    public set authorizationToken(token: string) {
-        Contracts.throwIfNullOrWhitespace(token, "token");
-        this.properties.setProperty(PropertyId.SpeechServiceAuthorization_Token, token);
-    }
-
    /**
     * Gets the authorization token used to communicate with the service.
     * @member SpeechRecognizer.prototype.authorizationToken
@ -113,6 +101,18 @@ export class SpeechRecognizer extends Recognizer {
        return this.properties.getProperty(PropertyId.SpeechServiceAuthorization_Token);
    }

+    /**
+     * Gets/Sets the authorization token used to communicate with the service.
+     * @member SpeechRecognizer.prototype.authorizationToken
+     * @function
+     * @public
+     * @param {string} token - Authorization token.
+     */
+    public set authorizationToken(token: string) {
+        Contracts.throwIfNullOrWhitespace(token, "token");
+        this.properties.setProperty(PropertyId.SpeechServiceAuthorization_Token, token);
+    }
+
    /**
     * Gets the spoken language of recognition.
     * @member SpeechRecognizer.prototype.speechRecognitionLanguage
--- a/src/sdk/SpeechTranslationConfig.ts
+++ b/src/sdk/SpeechTranslationConfig.ts
@ -86,7 +86,7 @@ export abstract class SpeechTranslationConfig extends SpeechConfig {
    }

    /**
-     * Sets the authorization token.
+     * Gets/Sets the authorization token.
     * If this is set, subscription key is ignored.
     * User needs to make sure the provided authorization token is valid and not expired.
     * @member SpeechTranslationConfig.prototype.authorizationToken
@ -97,9 +97,7 @@ export abstract class SpeechTranslationConfig extends SpeechConfig {
    public abstract set authorizationToken(value: string);

    /**
-     * Sets the authorization token.
-     * If this is set, subscription key is ignored.
-     * User needs to make sure the provided authorization token is valid and not expired.
+     * Gets/Sets the speech recognition language.
     * @member SpeechTranslationConfig.prototype.speechRecognitionLanguage
     * @function
     * @public
@ -117,7 +115,7 @@ export abstract class SpeechTranslationConfig extends SpeechConfig {
    public abstract addTargetLanguage(value: string): void;

    /**
-     * Add a (text) target language to translate into.
+     * Gets the (text) target language to translate into.
     * @member SpeechTranslationConfig.prototype.targetLanguages
     * @function
     * @public
@ -126,7 +124,7 @@ export abstract class SpeechTranslationConfig extends SpeechConfig {
    public abstract get targetLanguages(): string[];

    /**
-     * Returns the selected voice name.
+     * Gets the selected voice name.
     * @member SpeechTranslationConfig.prototype.voiceName
     * @function
     * @public
@ -135,7 +133,7 @@ export abstract class SpeechTranslationConfig extends SpeechConfig {
    public abstract get voiceName(): string;

    /**
-     * Sets voice of the translated language, enable voice synthesis output.
+     * Gets/Sets voice of the translated language, enable voice synthesis output.
     * @member SpeechTranslationConfig.prototype.voiceName
     * @function
     * @public
@ -176,7 +174,7 @@ export class SpeechTranslationConfigImpl extends SpeechTranslationConfig {
        this.outputFormat = OutputFormat.Simple;
    }
    /**
-     * Sets the authorization token.
+     * Gets/Sets the authorization token.
     * If this is set, subscription key is ignored.
     * User needs to make sure the provided authorization token is valid and not expired.
     * @member SpeechTranslationConfigImpl.prototype.authorizationToken
@ -191,9 +189,7 @@ export class SpeechTranslationConfigImpl extends SpeechTranslationConfig {
    }

    /**
-     * Sets the authorization token.
-     * If this is set, subscription key is ignored.
-     * User needs to make sure the provided authorization token is valid and not expired.
+     * Gets/Sets the speech recognition language.
     * @member SpeechTranslationConfigImpl.prototype.speechRecognitionLanguage
     * @function
     * @public
@ -214,6 +210,7 @@ export class SpeechTranslationConfigImpl extends SpeechTranslationConfig {
    }

    /**
+     * Gets the output format
     * @member SpeechTranslationConfigImpl.prototype.outputFormat
     * @function
     * @public
@ -223,6 +220,7 @@ export class SpeechTranslationConfigImpl extends SpeechTranslationConfig {
    }

    /**
+     * Gets/Sets the output format
     * @member SpeechTranslationConfigImpl.prototype.outputFormat
     * @function
     * @public
@ -232,6 +230,17 @@ export class SpeechTranslationConfigImpl extends SpeechTranslationConfig {
    }

    /**
+     * Gets the endpoint id.
+     * @member SpeechTranslationConfigImpl.prototype.endpointId
+     * @function
+     * @public
+     */
+    public get endpointId(): string {
+        return this.privSpeechProperties.getProperty(PropertyId.SpeechServiceConnection_EndpointId);
+    }
+
+    /**
+     * Gets/Sets the endpoint id.
     * @member SpeechTranslationConfigImpl.prototype.endpointId
     * @function
     * @public
@ -240,14 +249,6 @@ export class SpeechTranslationConfigImpl extends SpeechTranslationConfig {
        this.privSpeechProperties.setProperty(PropertyId.SpeechServiceConnection_Endpoint, value);
    }

-    /**
-     * @member SpeechTranslationConfigImpl.prototype.endpointId
-     * @function
-     * @public
-     */
-    public get endpointId(): string {
-        return this.privSpeechProperties.getProperty(PropertyId.SpeechServiceConnection_EndpointId);
-    }
    /**
     * Add a (text) target language to translate into.
     * @member SpeechTranslationConfigImpl.prototype.addTargetLanguage
@ -264,7 +265,7 @@ export class SpeechTranslationConfigImpl extends SpeechTranslationConfig {
    }

    /**
-     * Add a (text) target language to translate into.
+     * Gets the (text) target language to translate into.
     * @member SpeechTranslationConfigImpl.prototype.targetLanguages
     * @function
     * @public
@ -281,6 +282,7 @@ export class SpeechTranslationConfigImpl extends SpeechTranslationConfig {
    }

    /**
+     * Gets the voice name.
     * @member SpeechTranslationConfigImpl.prototype.voiceName
     * @function
     * @public
@ -290,7 +292,7 @@ export class SpeechTranslationConfigImpl extends SpeechTranslationConfig {
    }

    /**
-     * Sets voice of the translated language, enable voice synthesis output.
+     * Gets/Sets the voice of the translated language, enable voice synthesis output.
     * @member SpeechTranslationConfigImpl.prototype.voiceName
     * @function
     * @public
@ -314,19 +316,7 @@ export class SpeechTranslationConfigImpl extends SpeechTranslationConfig {
    }

    /**
-     * Allows for setting arbitrary properties.
-     * @member SpeechTranslationConfigImpl.prototype.setProperty
-     * @function
-     * @public
-     * @param {string} name - The name of the property.
-     * @param {string} value - The value of the property.
-     */
-    public setProperty(name: string, value: string): void {
-        this.privSpeechProperties.setProperty(name, value);
-    }
-
-    /**
-     * Allows for retrieving arbitrary property values.
+     * Gets an arbitrary property value.
     * @member SpeechTranslationConfigImpl.prototype.getProperty
     * @function
     * @public
@ -338,6 +328,18 @@ export class SpeechTranslationConfigImpl extends SpeechTranslationConfig {
        return this.privSpeechProperties.getProperty(name, def);
    }

+    /**
+     * Gets/Sets an arbitrary property value.
+     * @member SpeechTranslationConfigImpl.prototype.setProperty
+     * @function
+     * @public
+     * @param {string} name - The name of the property.
+     * @param {string} value - The value of the property.
+     */
+    public setProperty(name: string, value: string): void {
+        this.privSpeechProperties.setProperty(name, value);
+    }
+
    /**
     * Provides access to custom properties.
     * @member SpeechTranslationConfigImpl.prototype.properties
--- a/src/sdk/TranslationRecognizer.ts
+++ b/src/sdk/TranslationRecognizer.ts
@ -147,7 +147,7 @@ export class TranslationRecognizer extends Recognizer {
    }

    /**
-     * Sets the authorization token used to communicate with the service.
+     * Gets/Sets the authorization token used to communicate with the service.
     * @member TranslationRecognizer.prototype.authorizationToken
     * @function
     * @public