diff --git a/third_party/docfx-doclet-143274/pom.xml b/third_party/docfx-doclet-143274/pom.xml index ef2c1ce2..4d1f749c 100644 --- a/third_party/docfx-doclet-143274/pom.xml +++ b/third_party/docfx-doclet-143274/pom.xml @@ -121,11 +121,6 @@ jackson-dataformat-yaml ${jackson.version} - - com.overzealous - remark - ${remark.version} - org.jsoup jsoup diff --git a/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/1.1.0/remark-1.1.0.jar b/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/1.1.0/remark-1.1.0.jar deleted file mode 100644 index 527c98af..00000000 Binary files a/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/1.1.0/remark-1.1.0.jar and /dev/null differ diff --git a/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/1.1.0/remark-1.1.0.jar.md5 b/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/1.1.0/remark-1.1.0.jar.md5 deleted file mode 100644 index 9ed251a2..00000000 --- a/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/1.1.0/remark-1.1.0.jar.md5 +++ /dev/null @@ -1 +0,0 @@ -11f285988d090720765d07f7aaac00a6 \ No newline at end of file diff --git a/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/1.1.0/remark-1.1.0.jar.sha1 b/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/1.1.0/remark-1.1.0.jar.sha1 deleted file mode 100644 index 2d258c4d..00000000 --- a/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/1.1.0/remark-1.1.0.jar.sha1 +++ /dev/null @@ -1 +0,0 @@ -9c7a5cffdcd3ef94825d8b2cdb9f3c4aaf2930f4 \ No newline at end of file diff --git a/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/1.1.0/remark-1.1.0.pom b/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/1.1.0/remark-1.1.0.pom deleted file mode 100644 index bac4faf2..00000000 --- a/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/1.1.0/remark-1.1.0.pom +++ /dev/null @@ -1,8 +0,0 @@ - - - 4.0.0 - com.overzealous - remark - 1.1.0 - diff --git a/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/1.1.0/remark-1.1.0.pom.md5 b/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/1.1.0/remark-1.1.0.pom.md5 deleted file mode 100644 index ccfb7cf1..00000000 --- a/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/1.1.0/remark-1.1.0.pom.md5 +++ /dev/null @@ -1 +0,0 @@ -292f4027cd3d0fc25d75bd0f27a46632 \ No newline at end of file diff --git a/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/1.1.0/remark-1.1.0.pom.sha1 b/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/1.1.0/remark-1.1.0.pom.sha1 deleted file mode 100644 index 8dffd609..00000000 --- a/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/1.1.0/remark-1.1.0.pom.sha1 +++ /dev/null @@ -1 +0,0 @@ -7300c7d2fb40d00af496bae93093d983360d21ee \ No newline at end of file diff --git a/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/maven-metadata.xml b/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/maven-metadata.xml deleted file mode 100644 index 7276174c..00000000 --- a/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/maven-metadata.xml +++ /dev/null @@ -1,12 +0,0 @@ - - - com.overzealous - remark - - 1.1.0 - - 1.1.0 - - 20210513221435 - - diff --git a/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/maven-metadata.xml.md5 b/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/maven-metadata.xml.md5 deleted file mode 100644 index 8d598f66..00000000 --- a/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/maven-metadata.xml.md5 +++ /dev/null @@ -1 +0,0 @@ -5255ffae96d2551edaf1f1a837d4cc98 \ No newline at end of file diff --git a/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/maven-metadata.xml.sha1 b/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/maven-metadata.xml.sha1 deleted file mode 100644 index 435a09a6..00000000 --- a/third_party/docfx-doclet-143274/src/lib/com/overzealous/remark/maven-metadata.xml.sha1 +++ /dev/null @@ -1 +0,0 @@ -5f7e2f422ec7db69ca5481f7439175eb6f9d7339 \ No newline at end of file diff --git a/third_party/docfx-doclet-143274/src/main/java/com/microsoft/build/YmlFilesBuilder.java b/third_party/docfx-doclet-143274/src/main/java/com/microsoft/build/YmlFilesBuilder.java index 957a5adb..0733bb61 100644 --- a/third_party/docfx-doclet-143274/src/main/java/com/microsoft/build/YmlFilesBuilder.java +++ b/third_party/docfx-doclet-143274/src/main/java/com/microsoft/build/YmlFilesBuilder.java @@ -199,9 +199,9 @@ void addClassInfo(TypeElement classElement, MetadataFile classMetadataFile) { } String getDeprecatedSummary(String depMsg, String summary){ - String result = "(deprecated) " + depMsg; + String result = "

(deprecated) " + depMsg + "

"; if (summary != null && !summary.equals("")) { - result = result + " - " + summary; + result = result + "\n" + summary; } return result; } @@ -495,7 +495,7 @@ void populateUidValues(List packageMetadataFiles, List */ String replaceLinksAndCodes(List items) { - return items.stream().map( + return YamlUtil.cleanupHtml(items.stream().map( bodyItem -> { switch (bodyItem.getKind()) { case LINK: @@ -188,7 +189,7 @@ String replaceLinksAndCodes(List items) { return String.valueOf(bodyItem); } } - ).collect(Collectors.joining()); + ).collect(Collectors.joining())); } /** diff --git a/third_party/docfx-doclet-143274/src/main/java/com/microsoft/util/YamlUtil.java b/third_party/docfx-doclet-143274/src/main/java/com/microsoft/util/YamlUtil.java index a77f6206..dad67134 100644 --- a/third_party/docfx-doclet-143274/src/main/java/com/microsoft/util/YamlUtil.java +++ b/third_party/docfx-doclet-143274/src/main/java/com/microsoft/util/YamlUtil.java @@ -5,28 +5,9 @@ import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.dataformat.yaml.YAMLFactory; import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator.Feature; -import com.overzealous.remark.IgnoredHtmlElement; -import com.overzealous.remark.Options; -import com.overzealous.remark.Remark; import org.apache.commons.lang3.StringUtils; public class YamlUtil { - - /** - * Same instance of {@link Remark} class reused for better performance according to authors recommendations. - *

- * It wrapped in ThreadLocal because of its non-thread safe nature - */ - private static ThreadLocal remark = new ThreadLocal<>() { - @Override - protected Remark initialValue() { - Options options = Options.github(); - options.fencedCodeBlocksWidth = 3; - options.ignoredHtmlElements.add(IgnoredHtmlElement.create("xref", "uid", "data-throw-if-not-resolved")); - return new Remark(options); - } - }; - private static final ObjectMapper mapper = new ObjectMapper(new YAMLFactory() .disable(Feature.WRITE_DOC_START_MARKER) .disable(Feature.SPLIT_LINES) @@ -42,12 +23,15 @@ public static String objectToYamlString(Object object) { } } - public static String convertHtmlToMarkdown(String text) { + public static String cleanupHtml(String text) { if (StringUtils.isBlank(text)) { return text; } - return remark.get().convertFragment(text) - .replaceAll("\r\n", "\n") - .replaceAll("\n\n```\n", "\n\n```java\n"); + return text.replaceAll("

([^<]+)
","$1") + .replaceAll("
", "
")
+                .replaceAll("`([^`]+)`", "$1")
+                .replaceAll("\\[([^]]+)]\\(([^)]+)\\)", "$1")
+                .replaceAll("\\[([^]]+)]\\[([^]]+)\\]", "$1")
+                .replaceAll("==+([^=]+)==+", "

$1

"); } } diff --git a/third_party/docfx-doclet-143274/src/test/java/com/microsoft/samples/package-info.java b/third_party/docfx-doclet-143274/src/test/java/com/microsoft/samples/package-info.java index e2126573..8bfaebaa 100644 --- a/third_party/docfx-doclet-143274/src/test/java/com/microsoft/samples/package-info.java +++ b/third_party/docfx-doclet-143274/src/test/java/com/microsoft/samples/package-info.java @@ -1,4 +1,51 @@ +/* + * Copyright 2021 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ /** - * This package contains the sample set of classes for testing DocFx doclet. + * The interfaces provided are listed below, along with usage samples. + * + *

======================= SpeechClient ======================= + * + *

Service Description: Service that implements Google Cloud Speech API. + * + *

Sample for SpeechClient: + * + *

{@code
+ * try (SpeechClient speechClient = SpeechClient.create()) {
+ *   RecognitionConfig config = RecognitionConfig.newBuilder().build();
+ *   RecognitionAudio audio = RecognitionAudio.newBuilder().build();
+ *   RecognizeResponse response = speechClient.recognize(config, audio);
+ * }
+ * }
+ * + *

======================= AdaptationClient ======================= + * + *

Service Description: Service that implements Google Cloud Speech Adaptation API. + * + *

Sample for AdaptationClient: + * + *

{@code
+ * try (AdaptationClient adaptationClient = AdaptationClient.create()) {
+ *   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
+ *   PhraseSet phraseSet = PhraseSet.newBuilder().build();
+ *   String phraseSetId = "phraseSetId959902180";
+ *   PhraseSet response = adaptationClient.createPhraseSet(parent, phraseSet, phraseSetId);
+ * }
+ * }
*/ +@Generated("by gapic-generator-java") package com.microsoft.samples; + +import javax.annotation.Generated; diff --git a/third_party/docfx-doclet-143274/src/test/java/com/microsoft/util/YamlUtilTest.java b/third_party/docfx-doclet-143274/src/test/java/com/microsoft/util/YamlUtilTest.java index 955f41fa..7b290f56 100644 --- a/third_party/docfx-doclet-143274/src/test/java/com/microsoft/util/YamlUtilTest.java +++ b/third_party/docfx-doclet-143274/src/test/java/com/microsoft/util/YamlUtilTest.java @@ -9,10 +9,10 @@ import java.io.File; import java.io.IOException; import java.util.Collections; +import java.util.UUID; import static java.nio.charset.StandardCharsets.UTF_8; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNull; +import static org.junit.Assert.*; public class YamlUtilTest { @@ -45,29 +45,92 @@ public void objectToYamlString() { + " description: \"Some desc 5\"\n"); } + private MetadataFileItem buildMetadataFileItem(int seed) { + MetadataFileItem metadataFileItem = new MetadataFileItem("Some uid " + seed); + metadataFileItem.setId("Some id" + seed); + metadataFileItem.setHref("Some href" + seed); + metadataFileItem.setParameters(Collections.singletonList( + new MethodParameter("Some id " + seed, "Some type " + seed, "Some desc " + seed))); + + return metadataFileItem; + } + + @Test - public void convertHtmlToMarkdown() throws IOException { - String text = FileUtils.readFileToString(new File("target/test-classes/html2md/initial.html"), UTF_8); - String expectedResult = FileUtils.readFileToString(new File("target/test-classes/html2md/converted.md"), UTF_8); + public void cleanupHtmlRemoveLonePreTagsTest() { + String expectedActual = "
text
"; + String expectedResult = "text"; + String expectedWithCode = "
text
"; + String random = UUID.randomUUID().toString(); + + assertEquals(expectedResult, YamlUtil.cleanupHtml(expectedActual)); + assertEquals(random + expectedResult + random, YamlUtil.cleanupHtml(random + expectedActual + random)); + assertEquals(expectedResult + random + expectedResult, YamlUtil.cleanupHtml(expectedActual + random + expectedActual)); + assertEquals(expectedWithCode, YamlUtil.cleanupHtml(expectedWithCode)); + } - String result = YamlUtil.convertHtmlToMarkdown(text); + @Test + public void cleanupHtmlIncludePrettyPrintTest() { + String expectedActual = "
";
+        String expectedResult = "
";
+        String random = UUID.randomUUID().toString();
 
-        assertEquals("Wrong result", result, expectedResult);
+        assertEquals(expectedResult, YamlUtil.cleanupHtml(expectedActual));
+        assertEquals(random + expectedResult + random, YamlUtil.cleanupHtml(random + expectedActual + random));
+        assertEquals(expectedResult + random + expectedResult, YamlUtil.cleanupHtml(expectedActual + random + expectedActual));
+        assertNotEquals(expectedResult, YamlUtil.cleanupHtml("
" + random + ""));
+        assertFalse(YamlUtil.cleanupHtml("
" + random + "").contains("class=\"pretty-print\""));
     }
 
     @Test
-    public void convertHtmlToMarkdownForBlankParam() {
-        assertNull("Wrong result for null", YamlUtil.convertHtmlToMarkdown(null));
-        assertEquals("Wrong result for empty string", YamlUtil.convertHtmlToMarkdown(""), "");
+    public void cleanupHtmlAddCodeTagsTest() {
+        String expectedActual = "`text`";
+        String expectedResult = "text";
+        String random = UUID.randomUUID().toString();
+
+        assertEquals(expectedResult, YamlUtil.cleanupHtml(expectedActual));
+        assertEquals(random + expectedResult + random, YamlUtil.cleanupHtml(random + expectedActual + random));
+        assertEquals(expectedResult + random + expectedResult, YamlUtil.cleanupHtml(expectedActual + random + expectedActual));
+        assertEquals("`" + expectedResult, YamlUtil.cleanupHtml("`" + expectedActual));
+        assertFalse(YamlUtil.cleanupHtml("`" + random).contains(""));
     }
 
-    private MetadataFileItem buildMetadataFileItem(int seed) {
-        MetadataFileItem metadataFileItem = new MetadataFileItem("Some uid " + seed);
-        metadataFileItem.setId("Some id" + seed);
-        metadataFileItem.setHref("Some href" + seed);
-        metadataFileItem.setParameters(Collections.singletonList(
-                new MethodParameter("Some id " + seed, "Some type " + seed, "Some desc " + seed)));
+    @Test
+    public void cleanupHtmlAddHrefTagsTest() {
+        String expectedActual = "[text](link)";
+        String expectedResult = "text";
+        String random = UUID.randomUUID().toString();
 
-        return metadataFileItem;
+        assertEquals(expectedResult, YamlUtil.cleanupHtml(expectedActual));
+        assertEquals(random + expectedResult + random, YamlUtil.cleanupHtml(random + expectedActual + random));
+        assertEquals(expectedResult + random + expectedResult, YamlUtil.cleanupHtml(expectedActual + random + expectedActual));
+        assertEquals("[text]](link)", YamlUtil.cleanupHtml("[text]](link)"));
+        assertFalse(YamlUtil.cleanupHtml("[text(link)]").contains("href"));
+    }
+
+    @Test
+    public void cleanupHtmlEqualTitlesTest() {
+        String expectedActual = "======================= SpeechClient =======================";
+        String expectedResult = "

SpeechClient

"; + String random = UUID.randomUUID().toString(); + + assertEquals(expectedResult, YamlUtil.cleanupHtml(expectedActual)); + assertEquals(random + expectedResult + random, YamlUtil.cleanupHtml(random + expectedActual + random)); + assertEquals(expectedResult + random + expectedResult, YamlUtil.cleanupHtml(expectedActual + random + expectedActual)); + assertEquals("= text =", YamlUtil.cleanupHtml("= text =")); + } + + @Test + public void cleanupHtmlReferenceTest() { + String expectedActual = "[KeyRing][google.cloud.kms.v1.KeyRing]"; + String expectedResult = "KeyRing"; + String random = UUID.randomUUID().toString(); + + assertEquals(expectedResult, YamlUtil.cleanupHtml(expectedActual)); + assertEquals(random + expectedResult + random, YamlUtil.cleanupHtml(random + expectedActual + random)); + assertEquals(expectedResult + random + expectedResult, YamlUtil.cleanupHtml(expectedActual + random + expectedActual)); + + assertEquals("[uid]][text]", YamlUtil.cleanupHtml("[uid]][text]")); + assertFalse(YamlUtil.cleanupHtml("[text[uid]]").contains("xref")); } } diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.BasePartnerComponent.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.BasePartnerComponent.yml index 4b278719..5aa4cfcf 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.BasePartnerComponent.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.BasePartnerComponent.yml @@ -14,7 +14,7 @@ items: fullName: "com.microsoft.samples.BasePartnerComponent" type: "Class" package: "com.microsoft.samples" - summary: "Holds common partner component properties and behavior. All components should inherit from this class. The context object type." + summary: "Holds common partner component properties and behavior. All components should inherit from this class. The context\n object type." syntax: content: "public abstract class BasePartnerComponent" typeParameters: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.IPartner.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.IPartner.yml index 1c84b57b..9bae6eeb 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.IPartner.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.IPartner.yml @@ -12,7 +12,7 @@ items: fullName: "com.microsoft.samples.IPartner" type: "Interface" package: "com.microsoft.samples" - summary: "The main entry point into using the partner SDK functionality. Represents a partner and encapsulates all the behavior attached to partners. Use this interface to get to the partner's customers, profiles, and customer orders, profiles and subscriptions and more." + summary: "The main entry point into using the partner SDK functionality. Represents a partner and encapsulates all the behavior\n attached to partners. Use this interface to get to the partner's customers, profiles, and customer orders, profiles\n and subscriptions and more." syntax: content: "public interface IPartner" - uid: "com.microsoft.samples.IPartner.getCredentials()" diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.SuperHero.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.SuperHero.yml index 0d15a994..543bfec2 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.SuperHero.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.SuperHero.yml @@ -158,7 +158,7 @@ items: overridden: "com.microsoft.samples.subpackage.Person.getLastName()" type: "Method" package: "com.microsoft.samples" - summary: "Get capitalized last name. But it's not the end, because of multiline comment" + summary: "Get capitalized last name. But it's not the end,\n because of multiline comment" syntax: content: "public String getLastName()" return: @@ -254,7 +254,7 @@ items: overload: "com.microsoft.samples.SuperHero.successfullyAttacked*" type: "Method" package: "com.microsoft.samples" - summary: "(deprecated) As of version 1.1, use . . . instead -\n\nThis is a simple description of the method. . . [Superman!][Superman]\n\n\n[Superman]: http://www.supermanisthegreatest.com" + summary: "

(deprecated) As of version 1.1, use . . . instead

\n

This is a simple description of the method. . .\n Superman!\n

" syntax: content: "public int successfullyAttacked(int incomingDamage, String damageType)" parameters: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.agreements.AgreementDetailsCollectionOperations.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.agreements.AgreementDetailsCollectionOperations.yml index 41a61229..22c01beb 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.agreements.AgreementDetailsCollectionOperations.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.agreements.AgreementDetailsCollectionOperations.yml @@ -13,7 +13,7 @@ items: fullName: "com.microsoft.samples.agreements.AgreementDetailsCollectionOperations" type: "Class" package: "com.microsoft.samples.agreements" - summary: "(deprecated) Use AgreementMetaData instead. - Agreement details collection operations implementation class." + summary: "

(deprecated) Use AgreementMetaData instead.

\nAgreement details collection operations implementation class." syntax: content: "public class AgreementDetailsCollectionOperations extends BasePartnerComponentString implements IAgreementDetailsCollection" inheritance: @@ -66,7 +66,7 @@ items: overload: "com.microsoft.samples.agreements.AgreementDetailsCollectionOperations.get*" type: "Method" package: "com.microsoft.samples.agreements" - summary: "(deprecated) Some text - Retrieves the agreement details." + summary: "

(deprecated) Some text

\nRetrieves the agreement details." syntax: content: "public ResourceCollection get()" return: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.agreements.AgreementMetaData.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.agreements.AgreementMetaData.yml index fce4c657..50cdfb1e 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.agreements.AgreementMetaData.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.agreements.AgreementMetaData.yml @@ -18,7 +18,7 @@ items: fullName: "com.microsoft.samples.agreements.AgreementMetaData" type: "Class" package: "com.microsoft.samples.agreements" - summary: "The AgreementMetaData provides metadata about the agreement type that partner can provide confirmation of customer acceptance." + summary: "The AgreementMetaData provides metadata about the agreement type\n that partner can provide confirmation of customer acceptance." syntax: content: "public class AgreementMetaData" inheritance: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.agreements.IAgreementDetailsCollection.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.agreements.IAgreementDetailsCollection.yml index 47d03163..8afb653a 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.agreements.IAgreementDetailsCollection.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.agreements.IAgreementDetailsCollection.yml @@ -12,7 +12,7 @@ items: fullName: "com.microsoft.samples.agreements.IAgreementDetailsCollection" type: "Interface" package: "com.microsoft.samples.agreements" - summary: "(deprecated) This one is deprecated :( - Encapsulates the operations on the agreement metadata collection." + summary: "

(deprecated) This one is deprecated :(

\nEncapsulates the operations on the agreement metadata collection." syntax: content: "public interface IAgreementDetailsCollection" status: "deprecated" diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.commentinheritance.Animal.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.commentinheritance.Animal.yml index 4ded03b4..b3a2d5c4 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.commentinheritance.Animal.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.commentinheritance.Animal.yml @@ -87,7 +87,7 @@ items: overload: "com.microsoft.samples.commentinheritance.Animal.getKind*" type: "Method" package: "com.microsoft.samples.commentinheritance" - summary: "Get kind from Organism. Get kind from Animal." + summary: "Get kind from Organism.\n Get kind from Animal." syntax: content: "public abstract String getKind()" return: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.commentinheritance.Dog.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.commentinheritance.Dog.yml index 91c05db5..169cf75c 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.commentinheritance.Dog.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.commentinheritance.Dog.yml @@ -138,7 +138,7 @@ items: overridden: "com.microsoft.samples.commentinheritance.Mammal.getKind()" type: "Method" package: "com.microsoft.samples.commentinheritance" - summary: "Get kind from Organism. Get kind from Animal. Get kind from Mammal. Get kind from Dog." + summary: "Get kind from Organism.\n Get kind from Animal.\n Get kind from Mammal.\n Get kind from Dog." syntax: content: "public String getKind()" return: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.commentinheritance.Mammal.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.commentinheritance.Mammal.yml index 16d78013..82c30c40 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.commentinheritance.Mammal.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.commentinheritance.Mammal.yml @@ -60,7 +60,7 @@ items: overridden: "com.microsoft.samples.commentinheritance.Animal.getKind()" type: "Method" package: "com.microsoft.samples.commentinheritance" - summary: "Get kind from Organism. Get kind from Animal. Get kind from Mammal." + summary: "Get kind from Organism.\n Get kind from Animal.\n Get kind from Mammal." syntax: content: "public abstract String getKind()" return: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.commentinheritance.Omnivorous.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.commentinheritance.Omnivorous.yml index 87bc961b..7dc54473 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.commentinheritance.Omnivorous.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.commentinheritance.Omnivorous.yml @@ -65,7 +65,7 @@ items: overload: "com.microsoft.samples.commentinheritance.Omnivorous.getKind*" type: "Method" package: "com.microsoft.samples.commentinheritance" - summary: "Get kind from Carnivorous. Get kind from Omnivorous." + summary: "Get kind from Carnivorous.\n Get kind from Omnivorous." syntax: content: "public abstract String getKind()" return: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.BetaApi.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.BetaApi.yml index 3aa7bc05..b4c65868 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.BetaApi.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.BetaApi.yml @@ -12,7 +12,7 @@ items: fullName: "com.microsoft.samples.google.BetaApi" type: "Interface" package: "com.microsoft.samples.google" - summary: "Indicates a public API that can change at any time, and has no guarantee of API stability and backward-compatibility.\n\nUsage guidelines:\n\n1. This annotation is used only on APIs with public visibility. Internal interfaces should not use it.\n2. This annotation should only be added to new APIs. Adding it to an existing API is considered API-breaking.\n3. Removing this annotation from an API gives it stable status, assuming the API doesn't have other annotations denoting instability." + summary: "Indicates a public API that can change at any time, and has no guarantee of API stability and\n backward-compatibility.\n\n

\n Usage guidelines:\n

    \n
  1. This annotation is used only on APIs with public visibility. Internal interfaces should not\n use it.
  2. \n
  3. This annotation should only be added to new APIs. Adding it to an existing API is considered\n API-breaking.
  4. \n
  5. Removing this annotation from an API gives it stable status, assuming the API doesn't have\n other annotations denoting instability.\n
" syntax: content: "public interface BetaApi implements Annotation" implements: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.ProductSearchSettings.Builder.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.ProductSearchSettings.Builder.yml index a61c9d27..1f691bf3 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.ProductSearchSettings.Builder.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.ProductSearchSettings.Builder.yml @@ -171,7 +171,7 @@ items: overload: "com.microsoft.samples.google.ProductSearchSettings.Builder.applyToAllUnaryMethods*" type: "Method" package: "com.microsoft.samples.google" - summary: "Applies the given settings updater function to all of the unary API methods in this service.\n\nNote: This method does not support applying settings to streaming methods." + summary: "Applies the given settings updater function to all of the unary API methods in this service.\n\n

Note: This method does not support applying settings to streaming methods." syntax: content: "public ProductSearchSettings.Builder applyToAllUnaryMethods(ApiFunction,Void> settingsUpdater)" parameters: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.ProductSearchSettings.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.ProductSearchSettings.yml index 2c905114..06c92b5d 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.ProductSearchSettings.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.ProductSearchSettings.yml @@ -45,7 +45,7 @@ items: fullName: "com.microsoft.samples.google.ProductSearchSettings" type: "Class" package: "com.microsoft.samples.google" - summary: "Settings class to configure an instance of ProductSearchClient.\n\nThe default instance has everything set to sensible defaults:\n\n * The default service address (vision.googleapis.com) and default port (443) are used.\n * Credentials are acquired automatically through Application Default Credentials.\n * Retries are configured for idempotent methods but not for non-idempotent methods.\n\nThe builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.\n\nFor example, to set the total timeout of createProductSet to 30 seconds:\n\n```java\nProductSearchSettings.Builder productSearchSettingsBuilder = ProductSearchSettings.newBuilder();\n productSearchSettingsBuilder\n .createProductSetSettings()\n .setRetrySettings(\n productSearchSettingsBuilder\n .createProductSetSettings()\n .getRetrySettings()\n .toBuilder()\n .setTotalTimeout(Duration.ofSeconds(30))\n .build());\n ProductSearchSettings productSearchSettings = productSearchSettingsBuilder.build();\n```" + summary: "Settings class to configure an instance of ProductSearchClient.\n\n

The default instance has everything set to sensible defaults:\n\n

    \n
  • The default service address (vision.googleapis.com) and default port (443) are used.\n
  • Credentials are acquired automatically through Application Default Credentials.\n
  • Retries are configured for idempotent methods but not for non-idempotent methods.\n
\n\n

The builder of this class is recursive, so contained classes are themselves builders. When\n build() is called, the tree of builders is called to create the complete settings object.\n\n

For example, to set the total timeout of createProductSet to 30 seconds:\n\n

\n ProductSearchSettings.Builder productSearchSettingsBuilder = ProductSearchSettings.newBuilder();\n productSearchSettingsBuilder\n     .createProductSetSettings()\n     .setRetrySettings(\n         productSearchSettingsBuilder\n             .createProductSetSettings()\n             .getRetrySettings()\n             .toBuilder()\n             .setTotalTimeout(Duration.ofSeconds(30))\n             .build());\n ProductSearchSettings productSearchSettings = productSearchSettingsBuilder.build();\n 
" syntax: content: "public class ProductSearchSettings extends ClientSettings" inheritance: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.RecognitionAudio.AudioSourceCase.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.RecognitionAudio.AudioSourceCase.yml index b04846da..8b389ba6 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.RecognitionAudio.AudioSourceCase.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.RecognitionAudio.AudioSourceCase.yml @@ -146,7 +146,7 @@ items: overload: "com.microsoft.samples.google.RecognitionAudio.AudioSourceCase.valueOf*" type: "Method" package: "com.microsoft.samples.google" - summary: "(deprecated) Use #forNumber(int) instead." + summary: "

(deprecated) Use #forNumber(int) instead.

" syntax: content: "public static RecognitionAudio.AudioSourceCase valueOf(int value)" parameters: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.RecognitionAudio.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.RecognitionAudio.yml index 83dd3b25..429de39c 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.RecognitionAudio.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.RecognitionAudio.yml @@ -30,7 +30,7 @@ items: fullName: "com.microsoft.samples.google.RecognitionAudio" type: "Class" package: "com.microsoft.samples.google" - summary: "```\nContains audio data in the encoding specified in the `RecognitionConfig`.\n Either `content` or `uri` must be supplied. Supplying both or neither\n returns [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. See\n [content limits](https://cloud.google.com/speech-to-text/quotas#content).\n```\n\nProtobuf type `google.cloud.speech.v1.RecognitionAudio`" + summary: "\n Contains audio data in the encoding specified in the RecognitionConfig.\n Either content or uri must be supplied. Supplying both or neither\n returns google.rpc.Code.INVALID_ARGUMENT. See\n content limits.\n \n\n Protobuf type google.cloud.speech.v1.RecognitionAudio" syntax: content: "public final class RecognitionAudio extends GeneratedMessageV3 implements RecognitionAudioOrBuilder" inheritance: @@ -220,7 +220,7 @@ items: overload: "com.microsoft.samples.google.RecognitionAudio.getContent*" type: "Method" package: "com.microsoft.samples.google" - summary: "```\nThe audio data bytes encoded as specified in\n `RecognitionConfig`. Note: as with all bytes fields, proto buffers use a\n pure binary representation, whereas JSON representations use base64.\n```\n\n`bytes content = 1;`" + summary: "\n The audio data bytes encoded as specified in\n RecognitionConfig. Note: as with all bytes fields, proto buffers use a\n pure binary representation, whereas JSON representations use base64.\n \n\n bytes content = 1;" syntax: content: "public ByteString getContent()" return: @@ -284,7 +284,7 @@ items: overload: "com.microsoft.samples.google.RecognitionAudio.getUri*" type: "Method" package: "com.microsoft.samples.google" - summary: "```\nURI that points to a file that contains audio data bytes as specified in\n `RecognitionConfig`. The file must not be compressed (for example, gzip).\n Currently, only Google Cloud Storage URIs are\n supported, which must be specified in the following format:\n `gs://bucket_name/object_name` (other URI formats return\n [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see\n [Request URIs](https://cloud.google.com/storage/docs/reference-uris).\n```\n\n`string uri = 2;`" + summary: "\n URI that points to a file that contains audio data bytes as specified in\n RecognitionConfig. The file must not be compressed (for example, gzip).\n Currently, only Google Cloud Storage URIs are\n supported, which must be specified in the following format:\n gs://bucket_name/object_name (other URI formats return\n google.rpc.Code.INVALID_ARGUMENT). For more information, see\n Request URIs.\n \n\n string uri = 2;" syntax: content: "public String getUri()" return: @@ -301,7 +301,7 @@ items: overload: "com.microsoft.samples.google.RecognitionAudio.getUriBytes*" type: "Method" package: "com.microsoft.samples.google" - summary: "```\nURI that points to a file that contains audio data bytes as specified in\n `RecognitionConfig`. The file must not be compressed (for example, gzip).\n Currently, only Google Cloud Storage URIs are\n supported, which must be specified in the following format:\n `gs://bucket_name/object_name` (other URI formats return\n [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see\n [Request URIs](https://cloud.google.com/storage/docs/reference-uris).\n```\n\n`string uri = 2;`" + summary: "\n URI that points to a file that contains audio data bytes as specified in\n RecognitionConfig. The file must not be compressed (for example, gzip).\n Currently, only Google Cloud Storage URIs are\n supported, which must be specified in the following format:\n gs://bucket_name/object_name (other URI formats return\n google.rpc.Code.INVALID_ARGUMENT). For more information, see\n Request URIs.\n \n\n string uri = 2;" syntax: content: "public ByteString getUriBytes()" return: @@ -318,7 +318,7 @@ items: overload: "com.microsoft.samples.google.RecognitionAudio.hasContent*" type: "Method" package: "com.microsoft.samples.google" - summary: "```\nThe audio data bytes encoded as specified in\n `RecognitionConfig`. Note: as with all bytes fields, proto buffers use a\n pure binary representation, whereas JSON representations use base64.\n```\n\n`bytes content = 1;`" + summary: "\n The audio data bytes encoded as specified in\n RecognitionConfig. Note: as with all bytes fields, proto buffers use a\n pure binary representation, whereas JSON representations use base64.\n \n\n bytes content = 1;" syntax: content: "public boolean hasContent()" return: @@ -335,7 +335,7 @@ items: overload: "com.microsoft.samples.google.RecognitionAudio.hasUri*" type: "Method" package: "com.microsoft.samples.google" - summary: "```\nURI that points to a file that contains audio data bytes as specified in\n `RecognitionConfig`. The file must not be compressed (for example, gzip).\n Currently, only Google Cloud Storage URIs are\n supported, which must be specified in the following format:\n `gs://bucket_name/object_name` (other URI formats return\n [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see\n [Request URIs](https://cloud.google.com/storage/docs/reference-uris).\n```\n\n`string uri = 2;`" + summary: "\n URI that points to a file that contains audio data bytes as specified in\n RecognitionConfig. The file must not be compressed (for example, gzip).\n Currently, only Google Cloud Storage URIs are\n supported, which must be specified in the following format:\n gs://bucket_name/object_name (other URI formats return\n google.rpc.Code.INVALID_ARGUMENT). For more information, see\n Request URIs.\n \n\n string uri = 2;" syntax: content: "public boolean hasUri()" return: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.SpeechClient.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.SpeechClient.yml index 41aaf61c..8b438158 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.SpeechClient.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.SpeechClient.yml @@ -33,7 +33,7 @@ items: fullName: "com.microsoft.samples.google.SpeechClient" type: "Class" package: "com.microsoft.samples.google" - summary: "Service Description: Service that implements Google Cloud Speech API.\n\nThis class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n RecognitionConfig config = RecognitionConfig.newBuilder().build();\n RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n RecognizeResponse response = speechClient.recognize(config, audio);\n }\n```\n\nNote: close() needs to be called on the SpeechClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().\n\nThe surface of this class includes several types of Java methods for each of the API's methods:\n\n1. A \"flattened\" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.\n2. A \"request object\" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.\n3. A \"callable\" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.\n\nSee the individual methods for example code.\n\nMany parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.\n\nThis class can be customized by passing in a custom instance of SpeechSettings to create(). For example:\n\nTo customize credentials:\n\n```java\nSpeechSettings speechSettings =\n SpeechSettings.newBuilder()\n .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))\n .build();\n SpeechClient speechClient = SpeechClient.create(speechSettings);\n```\n\nTo customize the endpoint:\n\n```java\nSpeechSettings speechSettings = SpeechSettings.newBuilder().setEndpoint(myEndpoint).build();\n SpeechClient speechClient = SpeechClient.create(speechSettings);\n```\n\nPlease refer to the GitHub repository's samples for more quickstart code snippets." + summary: "Service Description: Service that implements Google Cloud Speech API.\n\n

This class provides the ability to make remote calls to the backing service through method\n calls that map to API methods. Sample code to get started:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   RecognitionConfig config = RecognitionConfig.newBuilder().build();\n   RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n   RecognizeResponse response = speechClient.recognize(config, audio);\n }\n 
\n\n

Note: close() needs to be called on the SpeechClient object to clean up resources such as\n threads. In the example above, try-with-resources is used, which automatically calls close().\n\n

The surface of this class includes several types of Java methods for each of the API's\n methods:\n\n

    \n
  1. A \"flattened\" method. With this type of method, the fields of the request type have been\n converted into function parameters. It may be the case that not all fields are available as\n parameters, and not every API method will have a flattened method entry point.\n
  2. A \"request object\" method. This type of method only takes one parameter, a request object,\n which must be constructed before the call. Not every API method will have a request object\n method.\n
  3. A \"callable\" method. This type of method takes no parameters and returns an immutable API\n callable object, which can be used to initiate calls to the service.\n
\n\n

See the individual methods for example code.\n\n

Many parameters require resource names to be formatted in a particular way. To assist with\n these names, this class includes a format method for each type of name, and additionally a parse\n method to extract the individual identifiers contained within names that are returned.\n\n

This class can be customized by passing in a custom instance of SpeechSettings to create().\n For example:\n\n

To customize credentials:\n\n

\n SpeechSettings speechSettings =\n     SpeechSettings.newBuilder()\n         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))\n         .build();\n SpeechClient speechClient = SpeechClient.create(speechSettings);\n 
\n\n

To customize the endpoint:\n\n

\n SpeechSettings speechSettings = SpeechSettings.newBuilder().setEndpoint(myEndpoint).build();\n SpeechClient speechClient = SpeechClient.create(speechSettings);\n 
\n\n

Please refer to the GitHub repository's samples for more quickstart code snippets." syntax: content: "public class SpeechClient implements BackgroundResource" inheritance: @@ -79,7 +79,7 @@ items: overload: "com.microsoft.samples.google.SpeechClient.SpeechClient*" type: "Constructor" package: "com.microsoft.samples.google" - summary: "Constructs an instance of SpeechClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred." + summary: "Constructs an instance of SpeechClient, using the given settings. This is protected so that it\n is easy to make a subclass, but otherwise, the static factory methods should be preferred." syntax: content: "protected SpeechClient(SpeechSettings settings)" parameters: @@ -149,7 +149,7 @@ items: overload: "com.microsoft.samples.google.SpeechClient.create*" type: "Method" package: "com.microsoft.samples.google" - summary: "Constructs an instance of SpeechClient, using the given stub for making calls. This is for advanced usage - prefer using create(SpeechSettings)." + summary: "Constructs an instance of SpeechClient, using the given stub for making calls. This is for\n advanced usage - prefer using create(SpeechSettings)." syntax: content: "public static final SpeechClient create(SpeechStub stub)" parameters: @@ -168,7 +168,7 @@ items: overload: "com.microsoft.samples.google.SpeechClient.create*" type: "Method" package: "com.microsoft.samples.google" - summary: "Constructs an instance of SpeechClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set." + summary: "Constructs an instance of SpeechClient, using the given settings. The channels are created\n based on the settings passed in, or defaults for any settings that are not set." syntax: content: "public static final SpeechClient create(SpeechSettings settings)" parameters: @@ -189,7 +189,7 @@ items: overload: "com.microsoft.samples.google.SpeechClient.getOperationsClient*" type: "Method" package: "com.microsoft.samples.google" - summary: "Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call." + summary: "Returns the OperationsClient that can be used to query the status of a long-running operation\n returned by another API method call." syntax: content: "public final OperationsClient getOperationsClient()" return: @@ -265,7 +265,7 @@ items: overload: "com.microsoft.samples.google.SpeechClient.longRunningRecognizeAsync*" type: "Method" package: "com.microsoft.samples.google" - summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface. Returns either an \\`Operation.error\\` or an \\`Operation.response\\` which contains a \\`LongRunningRecognizeResponse\\` message. For more information on asynchronous speech recognition, see the \\[how-to\\](https://cloud.google.com/speech-to-text/docs/async-recognize).\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n LongRunningRecognizeRequest request =\n LongRunningRecognizeRequest.newBuilder()\n .setConfig(RecognitionConfig.newBuilder().build())\n .setAudio(RecognitionAudio.newBuilder().build())\n .setOutputConfig(TranscriptOutputConfig.newBuilder().build())\n .build();\n LongRunningRecognizeResponse response = speechClient.longRunningRecognizeAsync(request).get();\n }\n```" + summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations\n interface. Returns either an Operation.error or an Operation.response which contains a\n LongRunningRecognizeResponse message. For more information on asynchronous speech\n recognition, see the how-to.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   LongRunningRecognizeRequest request =\n       LongRunningRecognizeRequest.newBuilder()\n           .setConfig(RecognitionConfig.newBuilder().build())\n           .setAudio(RecognitionAudio.newBuilder().build())\n           .setOutputConfig(TranscriptOutputConfig.newBuilder().build())\n           .build();\n   LongRunningRecognizeResponse response = speechClient.longRunningRecognizeAsync(request).get();\n }\n 
" syntax: content: "public final OperationFuture longRunningRecognizeAsync(LongRunningRecognizeRequest request)" parameters: @@ -285,7 +285,7 @@ items: overload: "com.microsoft.samples.google.SpeechClient.longRunningRecognizeAsync*" type: "Method" package: "com.microsoft.samples.google" - summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface. Returns either an \\`Operation.error\\` or an \\`Operation.response\\` which contains a \\`LongRunningRecognizeResponse\\` message. For more information on asynchronous speech recognition, see the \\[how-to\\](https://cloud.google.com/speech-to-text/docs/async-recognize).\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n RecognitionConfig config = RecognitionConfig.newBuilder().build();\n RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n LongRunningRecognizeResponse response =\n speechClient.longRunningRecognizeAsync(config, audio).get();\n }\n```" + summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations\n interface. Returns either an Operation.error or an Operation.response which contains a\n LongRunningRecognizeResponse message. For more information on asynchronous speech\n recognition, see the how-to.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   RecognitionConfig config = RecognitionConfig.newBuilder().build();\n   RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n   LongRunningRecognizeResponse response =\n       speechClient.longRunningRecognizeAsync(config, audio).get();\n }\n 
" syntax: content: "public final OperationFuture longRunningRecognizeAsync(RecognitionConfig config, RecognitionAudio audio)" parameters: @@ -308,7 +308,7 @@ items: overload: "com.microsoft.samples.google.SpeechClient.longRunningRecognizeCallable*" type: "Method" package: "com.microsoft.samples.google" - summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface. Returns either an \\`Operation.error\\` or an \\`Operation.response\\` which contains a \\`LongRunningRecognizeResponse\\` message. For more information on asynchronous speech recognition, see the \\[how-to\\](https://cloud.google.com/speech-to-text/docs/async-recognize).\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n LongRunningRecognizeRequest request =\n LongRunningRecognizeRequest.newBuilder()\n .setConfig(RecognitionConfig.newBuilder().build())\n .setAudio(RecognitionAudio.newBuilder().build())\n .setOutputConfig(TranscriptOutputConfig.newBuilder().build())\n .build();\n ApiFuture future = speechClient.longRunningRecognizeCallable().futureCall(request);\n // Do something.\n Operation response = future.get();\n }\n```" + summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations\n interface. Returns either an Operation.error or an Operation.response which contains a\n LongRunningRecognizeResponse message. For more information on asynchronous speech\n recognition, see the how-to.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   LongRunningRecognizeRequest request =\n       LongRunningRecognizeRequest.newBuilder()\n           .setConfig(RecognitionConfig.newBuilder().build())\n           .setAudio(RecognitionAudio.newBuilder().build())\n           .setOutputConfig(TranscriptOutputConfig.newBuilder().build())\n           .build();\n   ApiFuture future = speechClient.longRunningRecognizeCallable().futureCall(request);\n   // Do something.\n   Operation response = future.get();\n }\n 
" syntax: content: "public final UnaryCallable longRunningRecognizeCallable()" return: @@ -324,7 +324,7 @@ items: overload: "com.microsoft.samples.google.SpeechClient.longRunningRecognizeOperationCallable*" type: "Method" package: "com.microsoft.samples.google" - summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface. Returns either an \\`Operation.error\\` or an \\`Operation.response\\` which contains a \\`LongRunningRecognizeResponse\\` message. For more information on asynchronous speech recognition, see the \\[how-to\\](https://cloud.google.com/speech-to-text/docs/async-recognize).\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n LongRunningRecognizeRequest request =\n LongRunningRecognizeRequest.newBuilder()\n .setConfig(RecognitionConfig.newBuilder().build())\n .setAudio(RecognitionAudio.newBuilder().build())\n .setOutputConfig(TranscriptOutputConfig.newBuilder().build())\n .build();\n OperationFuture future =\n speechClient.longRunningRecognizeOperationCallable().futureCall(request);\n // Do something.\n LongRunningRecognizeResponse response = future.get();\n }\n```" + summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations\n interface. Returns either an Operation.error or an Operation.response which contains a\n LongRunningRecognizeResponse message. For more information on asynchronous speech\n recognition, see the how-to.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   LongRunningRecognizeRequest request =\n       LongRunningRecognizeRequest.newBuilder()\n           .setConfig(RecognitionConfig.newBuilder().build())\n           .setAudio(RecognitionAudio.newBuilder().build())\n           .setOutputConfig(TranscriptOutputConfig.newBuilder().build())\n           .build();\n   OperationFuture future =\n       speechClient.longRunningRecognizeOperationCallable().futureCall(request);\n   // Do something.\n   LongRunningRecognizeResponse response = future.get();\n }\n 
" syntax: content: "public final OperationCallable longRunningRecognizeOperationCallable()" return: @@ -340,7 +340,7 @@ items: overload: "com.microsoft.samples.google.SpeechClient.recognize*" type: "Method" package: "com.microsoft.samples.google" - summary: "Performs synchronous speech recognition: receive results after all audio has been sent and processed.\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n RecognitionConfig config = RecognitionConfig.newBuilder().build();\n RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n RecognizeResponse response = speechClient.recognize(config, audio);\n }\n```" + summary: "Performs synchronous speech recognition: receive results after all audio has been sent and\n processed.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   RecognitionConfig config = RecognitionConfig.newBuilder().build();\n   RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n   RecognizeResponse response = speechClient.recognize(config, audio);\n }\n 
" syntax: content: "public final RecognizeResponse recognize(RecognitionConfig config, RecognitionAudio audio)" parameters: @@ -363,7 +363,7 @@ items: overload: "com.microsoft.samples.google.SpeechClient.recognize*" type: "Method" package: "com.microsoft.samples.google" - summary: "Performs synchronous speech recognition: receive results after all audio has been sent and processed.\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n RecognizeRequest request =\n RecognizeRequest.newBuilder()\n .setConfig(RecognitionConfig.newBuilder().build())\n .setAudio(RecognitionAudio.newBuilder().build())\n .build();\n RecognizeResponse response = speechClient.recognize(request);\n }\n```" + summary: "Performs synchronous speech recognition: receive results after all audio has been sent and\n processed.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   RecognizeRequest request =\n       RecognizeRequest.newBuilder()\n           .setConfig(RecognitionConfig.newBuilder().build())\n           .setAudio(RecognitionAudio.newBuilder().build())\n           .build();\n   RecognizeResponse response = speechClient.recognize(request);\n }\n 
" syntax: content: "public final RecognizeResponse recognize(RecognizeRequest request)" parameters: @@ -383,7 +383,7 @@ items: overload: "com.microsoft.samples.google.SpeechClient.recognizeCallable*" type: "Method" package: "com.microsoft.samples.google" - summary: "Performs synchronous speech recognition: receive results after all audio has been sent and processed.\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n RecognizeRequest request =\n RecognizeRequest.newBuilder()\n .setConfig(RecognitionConfig.newBuilder().build())\n .setAudio(RecognitionAudio.newBuilder().build())\n .build();\n ApiFuture future = speechClient.recognizeCallable().futureCall(request);\n // Do something.\n RecognizeResponse response = future.get();\n }\n```" + summary: "Performs synchronous speech recognition: receive results after all audio has been sent and\n processed.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   RecognizeRequest request =\n       RecognizeRequest.newBuilder()\n           .setConfig(RecognitionConfig.newBuilder().build())\n           .setAudio(RecognitionAudio.newBuilder().build())\n           .build();\n   ApiFuture future = speechClient.recognizeCallable().futureCall(request);\n   // Do something.\n   RecognizeResponse response = future.get();\n }\n 
" syntax: content: "public final UnaryCallable recognizeCallable()" return: @@ -425,7 +425,7 @@ items: overload: "com.microsoft.samples.google.SpeechClient.streamingRecognizeCallable*" type: "Method" package: "com.microsoft.samples.google" - summary: "Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n BidiStream bidiStream =\n speechClient.streamingRecognizeCallable().call();\n StreamingRecognizeRequest request = StreamingRecognizeRequest.newBuilder().build();\n bidiStream.send(request);\n for (StreamingRecognizeResponse response : bidiStream) {\n // Do something when a response is received.\n }\n }\n```" + summary: "Performs bidirectional streaming speech recognition: receive results while sending audio. This\n method is only available via the gRPC API (not REST).\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   BidiStream bidiStream =\n       speechClient.streamingRecognizeCallable().call();\n   StreamingRecognizeRequest request = StreamingRecognizeRequest.newBuilder().build();\n   bidiStream.send(request);\n   for (StreamingRecognizeResponse response : bidiStream) {\n     // Do something when a response is received.\n   }\n }\n 
" syntax: content: "public final BidiStreamingCallable streamingRecognizeCallable()" return: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.SpeechSettings.Builder.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.SpeechSettings.Builder.yml index 56f870bb..d059fabf 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.SpeechSettings.Builder.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.SpeechSettings.Builder.yml @@ -138,7 +138,7 @@ items: overload: "com.microsoft.samples.google.SpeechSettings.Builder.applyToAllUnaryMethods*" type: "Method" package: "com.microsoft.samples.google" - summary: "Applies the given settings updater function to all of the unary API methods in this service.\n\nNote: This method does not support applying settings to streaming methods." + summary: "Applies the given settings updater function to all of the unary API methods in this service.\n\n

Note: This method does not support applying settings to streaming methods." syntax: content: "public SpeechSettings.Builder applyToAllUnaryMethods(ApiFunction,Void> settingsUpdater)" parameters: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.SpeechSettings.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.SpeechSettings.yml index 88b9cdd1..d2e8047b 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.SpeechSettings.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.SpeechSettings.yml @@ -28,7 +28,7 @@ items: fullName: "com.microsoft.samples.google.SpeechSettings" type: "Class" package: "com.microsoft.samples.google" - summary: "Settings class to configure an instance of SpeechClient.\n\nThe default instance has everything set to sensible defaults:\n\n * The default service address (speech.googleapis.com) and default port (443) are used.\n * Credentials are acquired automatically through Application Default Credentials.\n * Retries are configured for idempotent methods but not for non-idempotent methods.\n\nThe builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.\n\nFor example, to set the total timeout of recognize to 30 seconds:\n\n```java\nSpeechSettings.Builder speechSettingsBuilder = SpeechSettings.newBuilder();\n speechSettingsBuilder\n .recognizeSettings()\n .setRetrySettings(\n speechSettingsBuilder\n .recognizeSettings()\n .getRetrySettings()\n .toBuilder()\n .setTotalTimeout(Duration.ofSeconds(30))\n .build());\n SpeechSettings speechSettings = speechSettingsBuilder.build();\n```" + summary: "Settings class to configure an instance of SpeechClient.\n\n

The default instance has everything set to sensible defaults:\n\n

    \n
  • The default service address (speech.googleapis.com) and default port (443) are used.\n
  • Credentials are acquired automatically through Application Default Credentials.\n
  • Retries are configured for idempotent methods but not for non-idempotent methods.\n
\n\n

The builder of this class is recursive, so contained classes are themselves builders. When\n build() is called, the tree of builders is called to create the complete settings object.\n\n

For example, to set the total timeout of recognize to 30 seconds:\n\n

\n SpeechSettings.Builder speechSettingsBuilder = SpeechSettings.newBuilder();\n speechSettingsBuilder\n     .recognizeSettings()\n     .setRetrySettings(\n         speechSettingsBuilder\n             .recognizeSettings()\n             .getRetrySettings()\n             .toBuilder()\n             .setTotalTimeout(Duration.ofSeconds(30))\n             .build());\n SpeechSettings speechSettings = speechSettingsBuilder.build();\n 
" syntax: content: "public class SpeechSettings extends ClientSettings" inheritance: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.ValidationException.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.ValidationException.yml index 8abc87c5..988e632b 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.ValidationException.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.ValidationException.yml @@ -16,7 +16,7 @@ items: fullName: "com.microsoft.samples.google.ValidationException" type: "Class" package: "com.microsoft.samples.google" - summary: "Exception thrown if there is a validation problem with a path template, http config, or related framework methods. Comes as an illegal argument exception subclass. Allows to globally set a thread-local validation context description which each exception inherits." + summary: "Exception thrown if there is a validation problem with a path template, http config, or related\n framework methods. Comes as an illegal argument exception subclass. Allows to globally set a\n thread-local validation context description which each exception inherits." syntax: content: "public class ValidationException extends IllegalArgumentException" inheritance: @@ -93,7 +93,7 @@ items: overload: "com.microsoft.samples.google.ValidationException.pushCurrentThreadValidationContext*" type: "Method" package: "com.microsoft.samples.google" - summary: "Sets the validation context description. Each thread has its own description, so this is thread safe." + summary: "Sets the validation context description. Each thread has its own description, so this is thread\n safe." syntax: content: "public static void pushCurrentThreadValidationContext(ValidationException.Supplier supplier)" parameters: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.v1beta.SpeechClient.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.v1beta.SpeechClient.yml index 7bc06397..38c3a709 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.v1beta.SpeechClient.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.v1beta.SpeechClient.yml @@ -33,7 +33,7 @@ items: fullName: "com.microsoft.samples.google.v1beta.SpeechClient" type: "Class" package: "com.microsoft.samples.google.v1beta" - summary: "Service Description: Service that implements Google Cloud Speech API.\n\nThis class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n RecognitionConfig config = RecognitionConfig.newBuilder().build();\n RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n RecognizeResponse response = speechClient.recognize(config, audio);\n }\n```\n\nNote: close() needs to be called on the SpeechClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().\n\nThe surface of this class includes several types of Java methods for each of the API's methods:\n\n1. A \"flattened\" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.\n2. A \"request object\" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.\n3. A \"callable\" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.\n\nSee the individual methods for example code.\n\nMany parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.\n\nThis class can be customized by passing in a custom instance of SpeechSettings to create(). For example:\n\nTo customize credentials:\n\n```java\nSpeechSettings speechSettings =\n SpeechSettings.newBuilder()\n .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))\n .build();\n SpeechClient speechClient = SpeechClient.create(speechSettings);\n```\n\nTo customize the endpoint:\n\n```java\nSpeechSettings speechSettings = SpeechSettings.newBuilder().setEndpoint(myEndpoint).build();\n SpeechClient speechClient = SpeechClient.create(speechSettings);\n```\n\nPlease refer to the GitHub repository's samples for more quickstart code snippets." + summary: "Service Description: Service that implements Google Cloud Speech API.\n\n

This class provides the ability to make remote calls to the backing service through method\n calls that map to API methods. Sample code to get started:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   RecognitionConfig config = RecognitionConfig.newBuilder().build();\n   RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n   RecognizeResponse response = speechClient.recognize(config, audio);\n }\n 
\n\n

Note: close() needs to be called on the SpeechClient object to clean up resources such as\n threads. In the example above, try-with-resources is used, which automatically calls close().\n\n

The surface of this class includes several types of Java methods for each of the API's\n methods:\n\n

    \n
  1. A \"flattened\" method. With this type of method, the fields of the request type have been\n converted into function parameters. It may be the case that not all fields are available as\n parameters, and not every API method will have a flattened method entry point.\n
  2. A \"request object\" method. This type of method only takes one parameter, a request object,\n which must be constructed before the call. Not every API method will have a request object\n method.\n
  3. A \"callable\" method. This type of method takes no parameters and returns an immutable API\n callable object, which can be used to initiate calls to the service.\n
\n\n

See the individual methods for example code.\n\n

Many parameters require resource names to be formatted in a particular way. To assist with\n these names, this class includes a format method for each type of name, and additionally a parse\n method to extract the individual identifiers contained within names that are returned.\n\n

This class can be customized by passing in a custom instance of SpeechSettings to create().\n For example:\n\n

To customize credentials:\n\n

\n SpeechSettings speechSettings =\n     SpeechSettings.newBuilder()\n         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))\n         .build();\n SpeechClient speechClient = SpeechClient.create(speechSettings);\n 
\n\n

To customize the endpoint:\n\n

\n SpeechSettings speechSettings = SpeechSettings.newBuilder().setEndpoint(myEndpoint).build();\n SpeechClient speechClient = SpeechClient.create(speechSettings);\n 
\n\n

Please refer to the GitHub repository's samples for more quickstart code snippets." syntax: content: "public class SpeechClient implements BackgroundResource" inheritance: @@ -79,7 +79,7 @@ items: overload: "com.microsoft.samples.google.v1beta.SpeechClient.SpeechClient*" type: "Constructor" package: "com.microsoft.samples.google.v1beta" - summary: "Constructs an instance of SpeechClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred." + summary: "Constructs an instance of SpeechClient, using the given settings. This is protected so that it\n is easy to make a subclass, but otherwise, the static factory methods should be preferred." syntax: content: "protected SpeechClient(SpeechSettings settings)" parameters: @@ -149,7 +149,7 @@ items: overload: "com.microsoft.samples.google.v1beta.SpeechClient.create*" type: "Method" package: "com.microsoft.samples.google.v1beta" - summary: "Constructs an instance of SpeechClient, using the given stub for making calls. This is for advanced usage - prefer using create(SpeechSettings)." + summary: "Constructs an instance of SpeechClient, using the given stub for making calls. This is for\n advanced usage - prefer using create(SpeechSettings)." syntax: content: "public static final SpeechClient create(SpeechStub stub)" parameters: @@ -168,7 +168,7 @@ items: overload: "com.microsoft.samples.google.v1beta.SpeechClient.create*" type: "Method" package: "com.microsoft.samples.google.v1beta" - summary: "Constructs an instance of SpeechClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set." + summary: "Constructs an instance of SpeechClient, using the given settings. The channels are created\n based on the settings passed in, or defaults for any settings that are not set." syntax: content: "public static final SpeechClient create(SpeechSettings settings)" parameters: @@ -189,7 +189,7 @@ items: overload: "com.microsoft.samples.google.v1beta.SpeechClient.getOperationsClient*" type: "Method" package: "com.microsoft.samples.google.v1beta" - summary: "Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call." + summary: "Returns the OperationsClient that can be used to query the status of a long-running operation\n returned by another API method call." syntax: content: "public final OperationsClient getOperationsClient()" return: @@ -265,7 +265,7 @@ items: overload: "com.microsoft.samples.google.v1beta.SpeechClient.longRunningRecognizeAsync*" type: "Method" package: "com.microsoft.samples.google.v1beta" - summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface. Returns either an \\`Operation.error\\` or an \\`Operation.response\\` which contains a \\`LongRunningRecognizeResponse\\` message. For more information on asynchronous speech recognition, see the \\[how-to\\](https://cloud.google.com/speech-to-text/docs/async-recognize).\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n LongRunningRecognizeRequest request =\n LongRunningRecognizeRequest.newBuilder()\n .setConfig(RecognitionConfig.newBuilder().build())\n .setAudio(RecognitionAudio.newBuilder().build())\n .setOutputConfig(TranscriptOutputConfig.newBuilder().build())\n .build();\n LongRunningRecognizeResponse response = speechClient.longRunningRecognizeAsync(request).get();\n }\n```" + summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations\n interface. Returns either an Operation.error or an Operation.response which contains a\n LongRunningRecognizeResponse message. For more information on asynchronous speech\n recognition, see the how-to.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   LongRunningRecognizeRequest request =\n       LongRunningRecognizeRequest.newBuilder()\n           .setConfig(RecognitionConfig.newBuilder().build())\n           .setAudio(RecognitionAudio.newBuilder().build())\n           .setOutputConfig(TranscriptOutputConfig.newBuilder().build())\n           .build();\n   LongRunningRecognizeResponse response = speechClient.longRunningRecognizeAsync(request).get();\n }\n 
" syntax: content: "public final OperationFuture longRunningRecognizeAsync(LongRunningRecognizeRequest request)" parameters: @@ -285,7 +285,7 @@ items: overload: "com.microsoft.samples.google.v1beta.SpeechClient.longRunningRecognizeAsync*" type: "Method" package: "com.microsoft.samples.google.v1beta" - summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface. Returns either an \\`Operation.error\\` or an \\`Operation.response\\` which contains a \\`LongRunningRecognizeResponse\\` message. For more information on asynchronous speech recognition, see the \\[how-to\\](https://cloud.google.com/speech-to-text/docs/async-recognize).\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n RecognitionConfig config = RecognitionConfig.newBuilder().build();\n RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n LongRunningRecognizeResponse response =\n speechClient.longRunningRecognizeAsync(config, audio).get();\n }\n```" + summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations\n interface. Returns either an Operation.error or an Operation.response which contains a\n LongRunningRecognizeResponse message. For more information on asynchronous speech\n recognition, see the how-to.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   RecognitionConfig config = RecognitionConfig.newBuilder().build();\n   RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n   LongRunningRecognizeResponse response =\n       speechClient.longRunningRecognizeAsync(config, audio).get();\n }\n 
" syntax: content: "public final OperationFuture longRunningRecognizeAsync(RecognitionConfig config, RecognitionAudio audio)" parameters: @@ -308,7 +308,7 @@ items: overload: "com.microsoft.samples.google.v1beta.SpeechClient.longRunningRecognizeCallable*" type: "Method" package: "com.microsoft.samples.google.v1beta" - summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface. Returns either an \\`Operation.error\\` or an \\`Operation.response\\` which contains a \\`LongRunningRecognizeResponse\\` message. For more information on asynchronous speech recognition, see the \\[how-to\\](https://cloud.google.com/speech-to-text/docs/async-recognize).\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n LongRunningRecognizeRequest request =\n LongRunningRecognizeRequest.newBuilder()\n .setConfig(RecognitionConfig.newBuilder().build())\n .setAudio(RecognitionAudio.newBuilder().build())\n .setOutputConfig(TranscriptOutputConfig.newBuilder().build())\n .build();\n ApiFuture future = speechClient.longRunningRecognizeCallable().futureCall(request);\n // Do something.\n Operation response = future.get();\n }\n```" + summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations\n interface. Returns either an Operation.error or an Operation.response which contains a\n LongRunningRecognizeResponse message. For more information on asynchronous speech\n recognition, see the how-to.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   LongRunningRecognizeRequest request =\n       LongRunningRecognizeRequest.newBuilder()\n           .setConfig(RecognitionConfig.newBuilder().build())\n           .setAudio(RecognitionAudio.newBuilder().build())\n           .setOutputConfig(TranscriptOutputConfig.newBuilder().build())\n           .build();\n   ApiFuture future = speechClient.longRunningRecognizeCallable().futureCall(request);\n   // Do something.\n   Operation response = future.get();\n }\n 
" syntax: content: "public final UnaryCallable longRunningRecognizeCallable()" return: @@ -324,7 +324,7 @@ items: overload: "com.microsoft.samples.google.v1beta.SpeechClient.longRunningRecognizeOperationCallable*" type: "Method" package: "com.microsoft.samples.google.v1beta" - summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface. Returns either an \\`Operation.error\\` or an \\`Operation.response\\` which contains a \\`LongRunningRecognizeResponse\\` message. For more information on asynchronous speech recognition, see the \\[how-to\\](https://cloud.google.com/speech-to-text/docs/async-recognize).\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n LongRunningRecognizeRequest request =\n LongRunningRecognizeRequest.newBuilder()\n .setConfig(RecognitionConfig.newBuilder().build())\n .setAudio(RecognitionAudio.newBuilder().build())\n .setOutputConfig(TranscriptOutputConfig.newBuilder().build())\n .build();\n OperationFuture future =\n speechClient.longRunningRecognizeOperationCallable().futureCall(request);\n // Do something.\n LongRunningRecognizeResponse response = future.get();\n }\n```" + summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations\n interface. Returns either an Operation.error or an Operation.response which contains a\n LongRunningRecognizeResponse message. For more information on asynchronous speech\n recognition, see the how-to.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   LongRunningRecognizeRequest request =\n       LongRunningRecognizeRequest.newBuilder()\n           .setConfig(RecognitionConfig.newBuilder().build())\n           .setAudio(RecognitionAudio.newBuilder().build())\n           .setOutputConfig(TranscriptOutputConfig.newBuilder().build())\n           .build();\n   OperationFuture future =\n       speechClient.longRunningRecognizeOperationCallable().futureCall(request);\n   // Do something.\n   LongRunningRecognizeResponse response = future.get();\n }\n 
" syntax: content: "public final OperationCallable longRunningRecognizeOperationCallable()" return: @@ -340,7 +340,7 @@ items: overload: "com.microsoft.samples.google.v1beta.SpeechClient.recognize*" type: "Method" package: "com.microsoft.samples.google.v1beta" - summary: "Performs synchronous speech recognition: receive results after all audio has been sent and processed.\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n RecognitionConfig config = RecognitionConfig.newBuilder().build();\n RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n RecognizeResponse response = speechClient.recognize(config, audio);\n }\n```" + summary: "Performs synchronous speech recognition: receive results after all audio has been sent and\n processed.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   RecognitionConfig config = RecognitionConfig.newBuilder().build();\n   RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n   RecognizeResponse response = speechClient.recognize(config, audio);\n }\n 
" syntax: content: "public final RecognizeResponse recognize(RecognitionConfig config, RecognitionAudio audio)" parameters: @@ -363,7 +363,7 @@ items: overload: "com.microsoft.samples.google.v1beta.SpeechClient.recognize*" type: "Method" package: "com.microsoft.samples.google.v1beta" - summary: "Performs synchronous speech recognition: receive results after all audio has been sent and processed.\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n RecognizeRequest request =\n RecognizeRequest.newBuilder()\n .setConfig(RecognitionConfig.newBuilder().build())\n .setAudio(RecognitionAudio.newBuilder().build())\n .build();\n RecognizeResponse response = speechClient.recognize(request);\n }\n```" + summary: "Performs synchronous speech recognition: receive results after all audio has been sent and\n processed.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   RecognizeRequest request =\n       RecognizeRequest.newBuilder()\n           .setConfig(RecognitionConfig.newBuilder().build())\n           .setAudio(RecognitionAudio.newBuilder().build())\n           .build();\n   RecognizeResponse response = speechClient.recognize(request);\n }\n 
" syntax: content: "public final RecognizeResponse recognize(RecognizeRequest request)" parameters: @@ -383,7 +383,7 @@ items: overload: "com.microsoft.samples.google.v1beta.SpeechClient.recognizeCallable*" type: "Method" package: "com.microsoft.samples.google.v1beta" - summary: "Performs synchronous speech recognition: receive results after all audio has been sent and processed.\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n RecognizeRequest request =\n RecognizeRequest.newBuilder()\n .setConfig(RecognitionConfig.newBuilder().build())\n .setAudio(RecognitionAudio.newBuilder().build())\n .build();\n ApiFuture future = speechClient.recognizeCallable().futureCall(request);\n // Do something.\n RecognizeResponse response = future.get();\n }\n```" + summary: "Performs synchronous speech recognition: receive results after all audio has been sent and\n processed.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   RecognizeRequest request =\n       RecognizeRequest.newBuilder()\n           .setConfig(RecognitionConfig.newBuilder().build())\n           .setAudio(RecognitionAudio.newBuilder().build())\n           .build();\n   ApiFuture future = speechClient.recognizeCallable().futureCall(request);\n   // Do something.\n   RecognizeResponse response = future.get();\n }\n 
" syntax: content: "public final UnaryCallable recognizeCallable()" return: @@ -425,7 +425,7 @@ items: overload: "com.microsoft.samples.google.v1beta.SpeechClient.streamingRecognizeCallable*" type: "Method" package: "com.microsoft.samples.google.v1beta" - summary: "Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n BidiStream bidiStream =\n speechClient.streamingRecognizeCallable().call();\n StreamingRecognizeRequest request = StreamingRecognizeRequest.newBuilder().build();\n bidiStream.send(request);\n for (StreamingRecognizeResponse response : bidiStream) {\n // Do something when a response is received.\n }\n }\n```" + summary: "Performs bidirectional streaming speech recognition: receive results while sending audio. This\n method is only available via the gRPC API (not REST).\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   BidiStream bidiStream =\n       speechClient.streamingRecognizeCallable().call();\n   StreamingRecognizeRequest request = StreamingRecognizeRequest.newBuilder().build();\n   bidiStream.send(request);\n   for (StreamingRecognizeResponse response : bidiStream) {\n     // Do something when a response is received.\n   }\n }\n 
" syntax: content: "public final BidiStreamingCallable streamingRecognizeCallable()" return: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.v1p1alpha.SpeechClient.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.v1p1alpha.SpeechClient.yml index b3737107..0a5497ec 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.v1p1alpha.SpeechClient.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.v1p1alpha.SpeechClient.yml @@ -33,7 +33,7 @@ items: fullName: "com.microsoft.samples.google.v1p1alpha.SpeechClient" type: "Class" package: "com.microsoft.samples.google.v1p1alpha" - summary: "Service Description: Service that implements Google Cloud Speech API.\n\nThis class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n RecognitionConfig config = RecognitionConfig.newBuilder().build();\n RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n RecognizeResponse response = speechClient.recognize(config, audio);\n }\n```\n\nNote: close() needs to be called on the SpeechClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().\n\nThe surface of this class includes several types of Java methods for each of the API's methods:\n\n1. A \"flattened\" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.\n2. A \"request object\" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.\n3. A \"callable\" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.\n\nSee the individual methods for example code.\n\nMany parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.\n\nThis class can be customized by passing in a custom instance of SpeechSettings to create(). For example:\n\nTo customize credentials:\n\n```java\nSpeechSettings speechSettings =\n SpeechSettings.newBuilder()\n .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))\n .build();\n SpeechClient speechClient = SpeechClient.create(speechSettings);\n```\n\nTo customize the endpoint:\n\n```java\nSpeechSettings speechSettings = SpeechSettings.newBuilder().setEndpoint(myEndpoint).build();\n SpeechClient speechClient = SpeechClient.create(speechSettings);\n```\n\nPlease refer to the GitHub repository's samples for more quickstart code snippets." + summary: "Service Description: Service that implements Google Cloud Speech API.\n\n

This class provides the ability to make remote calls to the backing service through method\n calls that map to API methods. Sample code to get started:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   RecognitionConfig config = RecognitionConfig.newBuilder().build();\n   RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n   RecognizeResponse response = speechClient.recognize(config, audio);\n }\n 
\n\n

Note: close() needs to be called on the SpeechClient object to clean up resources such as\n threads. In the example above, try-with-resources is used, which automatically calls close().\n\n

The surface of this class includes several types of Java methods for each of the API's\n methods:\n\n

    \n
  1. A \"flattened\" method. With this type of method, the fields of the request type have been\n converted into function parameters. It may be the case that not all fields are available as\n parameters, and not every API method will have a flattened method entry point.\n
  2. A \"request object\" method. This type of method only takes one parameter, a request object,\n which must be constructed before the call. Not every API method will have a request object\n method.\n
  3. A \"callable\" method. This type of method takes no parameters and returns an immutable API\n callable object, which can be used to initiate calls to the service.\n
\n\n

See the individual methods for example code.\n\n

Many parameters require resource names to be formatted in a particular way. To assist with\n these names, this class includes a format method for each type of name, and additionally a parse\n method to extract the individual identifiers contained within names that are returned.\n\n

This class can be customized by passing in a custom instance of SpeechSettings to create().\n For example:\n\n

To customize credentials:\n\n

\n SpeechSettings speechSettings =\n     SpeechSettings.newBuilder()\n         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))\n         .build();\n SpeechClient speechClient = SpeechClient.create(speechSettings);\n 
\n\n

To customize the endpoint:\n\n

\n SpeechSettings speechSettings = SpeechSettings.newBuilder().setEndpoint(myEndpoint).build();\n SpeechClient speechClient = SpeechClient.create(speechSettings);\n 
\n\n

Please refer to the GitHub repository's samples for more quickstart code snippets." syntax: content: "public class SpeechClient implements BackgroundResource" inheritance: @@ -79,7 +79,7 @@ items: overload: "com.microsoft.samples.google.v1p1alpha.SpeechClient.SpeechClient*" type: "Constructor" package: "com.microsoft.samples.google.v1p1alpha" - summary: "Constructs an instance of SpeechClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred." + summary: "Constructs an instance of SpeechClient, using the given settings. This is protected so that it\n is easy to make a subclass, but otherwise, the static factory methods should be preferred." syntax: content: "protected SpeechClient(SpeechSettings settings)" parameters: @@ -149,7 +149,7 @@ items: overload: "com.microsoft.samples.google.v1p1alpha.SpeechClient.create*" type: "Method" package: "com.microsoft.samples.google.v1p1alpha" - summary: "Constructs an instance of SpeechClient, using the given stub for making calls. This is for advanced usage - prefer using create(SpeechSettings)." + summary: "Constructs an instance of SpeechClient, using the given stub for making calls. This is for\n advanced usage - prefer using create(SpeechSettings)." syntax: content: "public static final SpeechClient create(SpeechStub stub)" parameters: @@ -168,7 +168,7 @@ items: overload: "com.microsoft.samples.google.v1p1alpha.SpeechClient.create*" type: "Method" package: "com.microsoft.samples.google.v1p1alpha" - summary: "Constructs an instance of SpeechClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set." + summary: "Constructs an instance of SpeechClient, using the given settings. The channels are created\n based on the settings passed in, or defaults for any settings that are not set." syntax: content: "public static final SpeechClient create(SpeechSettings settings)" parameters: @@ -189,7 +189,7 @@ items: overload: "com.microsoft.samples.google.v1p1alpha.SpeechClient.getOperationsClient*" type: "Method" package: "com.microsoft.samples.google.v1p1alpha" - summary: "Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call." + summary: "Returns the OperationsClient that can be used to query the status of a long-running operation\n returned by another API method call." syntax: content: "public final OperationsClient getOperationsClient()" return: @@ -265,7 +265,7 @@ items: overload: "com.microsoft.samples.google.v1p1alpha.SpeechClient.longRunningRecognizeAsync*" type: "Method" package: "com.microsoft.samples.google.v1p1alpha" - summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface. Returns either an \\`Operation.error\\` or an \\`Operation.response\\` which contains a \\`LongRunningRecognizeResponse\\` message. For more information on asynchronous speech recognition, see the \\[how-to\\](https://cloud.google.com/speech-to-text/docs/async-recognize).\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n LongRunningRecognizeRequest request =\n LongRunningRecognizeRequest.newBuilder()\n .setConfig(RecognitionConfig.newBuilder().build())\n .setAudio(RecognitionAudio.newBuilder().build())\n .setOutputConfig(TranscriptOutputConfig.newBuilder().build())\n .build();\n LongRunningRecognizeResponse response = speechClient.longRunningRecognizeAsync(request).get();\n }\n```" + summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations\n interface. Returns either an Operation.error or an Operation.response which contains a\n LongRunningRecognizeResponse message. For more information on asynchronous speech\n recognition, see the how-to.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   LongRunningRecognizeRequest request =\n       LongRunningRecognizeRequest.newBuilder()\n           .setConfig(RecognitionConfig.newBuilder().build())\n           .setAudio(RecognitionAudio.newBuilder().build())\n           .setOutputConfig(TranscriptOutputConfig.newBuilder().build())\n           .build();\n   LongRunningRecognizeResponse response = speechClient.longRunningRecognizeAsync(request).get();\n }\n 
" syntax: content: "public final OperationFuture longRunningRecognizeAsync(LongRunningRecognizeRequest request)" parameters: @@ -285,7 +285,7 @@ items: overload: "com.microsoft.samples.google.v1p1alpha.SpeechClient.longRunningRecognizeAsync*" type: "Method" package: "com.microsoft.samples.google.v1p1alpha" - summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface. Returns either an \\`Operation.error\\` or an \\`Operation.response\\` which contains a \\`LongRunningRecognizeResponse\\` message. For more information on asynchronous speech recognition, see the \\[how-to\\](https://cloud.google.com/speech-to-text/docs/async-recognize).\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n RecognitionConfig config = RecognitionConfig.newBuilder().build();\n RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n LongRunningRecognizeResponse response =\n speechClient.longRunningRecognizeAsync(config, audio).get();\n }\n```" + summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations\n interface. Returns either an Operation.error or an Operation.response which contains a\n LongRunningRecognizeResponse message. For more information on asynchronous speech\n recognition, see the how-to.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   RecognitionConfig config = RecognitionConfig.newBuilder().build();\n   RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n   LongRunningRecognizeResponse response =\n       speechClient.longRunningRecognizeAsync(config, audio).get();\n }\n 
" syntax: content: "public final OperationFuture longRunningRecognizeAsync(RecognitionConfig config, RecognitionAudio audio)" parameters: @@ -308,7 +308,7 @@ items: overload: "com.microsoft.samples.google.v1p1alpha.SpeechClient.longRunningRecognizeCallable*" type: "Method" package: "com.microsoft.samples.google.v1p1alpha" - summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface. Returns either an \\`Operation.error\\` or an \\`Operation.response\\` which contains a \\`LongRunningRecognizeResponse\\` message. For more information on asynchronous speech recognition, see the \\[how-to\\](https://cloud.google.com/speech-to-text/docs/async-recognize).\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n LongRunningRecognizeRequest request =\n LongRunningRecognizeRequest.newBuilder()\n .setConfig(RecognitionConfig.newBuilder().build())\n .setAudio(RecognitionAudio.newBuilder().build())\n .setOutputConfig(TranscriptOutputConfig.newBuilder().build())\n .build();\n ApiFuture future = speechClient.longRunningRecognizeCallable().futureCall(request);\n // Do something.\n Operation response = future.get();\n }\n```" + summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations\n interface. Returns either an Operation.error or an Operation.response which contains a\n LongRunningRecognizeResponse message. For more information on asynchronous speech\n recognition, see the how-to.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   LongRunningRecognizeRequest request =\n       LongRunningRecognizeRequest.newBuilder()\n           .setConfig(RecognitionConfig.newBuilder().build())\n           .setAudio(RecognitionAudio.newBuilder().build())\n           .setOutputConfig(TranscriptOutputConfig.newBuilder().build())\n           .build();\n   ApiFuture future = speechClient.longRunningRecognizeCallable().futureCall(request);\n   // Do something.\n   Operation response = future.get();\n }\n 
" syntax: content: "public final UnaryCallable longRunningRecognizeCallable()" return: @@ -324,7 +324,7 @@ items: overload: "com.microsoft.samples.google.v1p1alpha.SpeechClient.longRunningRecognizeOperationCallable*" type: "Method" package: "com.microsoft.samples.google.v1p1alpha" - summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface. Returns either an \\`Operation.error\\` or an \\`Operation.response\\` which contains a \\`LongRunningRecognizeResponse\\` message. For more information on asynchronous speech recognition, see the \\[how-to\\](https://cloud.google.com/speech-to-text/docs/async-recognize).\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n LongRunningRecognizeRequest request =\n LongRunningRecognizeRequest.newBuilder()\n .setConfig(RecognitionConfig.newBuilder().build())\n .setAudio(RecognitionAudio.newBuilder().build())\n .setOutputConfig(TranscriptOutputConfig.newBuilder().build())\n .build();\n OperationFuture future =\n speechClient.longRunningRecognizeOperationCallable().futureCall(request);\n // Do something.\n LongRunningRecognizeResponse response = future.get();\n }\n```" + summary: "Performs asynchronous speech recognition: receive results via the google.longrunning.Operations\n interface. Returns either an Operation.error or an Operation.response which contains a\n LongRunningRecognizeResponse message. For more information on asynchronous speech\n recognition, see the how-to.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   LongRunningRecognizeRequest request =\n       LongRunningRecognizeRequest.newBuilder()\n           .setConfig(RecognitionConfig.newBuilder().build())\n           .setAudio(RecognitionAudio.newBuilder().build())\n           .setOutputConfig(TranscriptOutputConfig.newBuilder().build())\n           .build();\n   OperationFuture future =\n       speechClient.longRunningRecognizeOperationCallable().futureCall(request);\n   // Do something.\n   LongRunningRecognizeResponse response = future.get();\n }\n 
" syntax: content: "public final OperationCallable longRunningRecognizeOperationCallable()" return: @@ -340,7 +340,7 @@ items: overload: "com.microsoft.samples.google.v1p1alpha.SpeechClient.recognize*" type: "Method" package: "com.microsoft.samples.google.v1p1alpha" - summary: "Performs synchronous speech recognition: receive results after all audio has been sent and processed.\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n RecognitionConfig config = RecognitionConfig.newBuilder().build();\n RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n RecognizeResponse response = speechClient.recognize(config, audio);\n }\n```" + summary: "Performs synchronous speech recognition: receive results after all audio has been sent and\n processed.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   RecognitionConfig config = RecognitionConfig.newBuilder().build();\n   RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n   RecognizeResponse response = speechClient.recognize(config, audio);\n }\n 
" syntax: content: "public final RecognizeResponse recognize(RecognitionConfig config, RecognitionAudio audio)" parameters: @@ -363,7 +363,7 @@ items: overload: "com.microsoft.samples.google.v1p1alpha.SpeechClient.recognize*" type: "Method" package: "com.microsoft.samples.google.v1p1alpha" - summary: "Performs synchronous speech recognition: receive results after all audio has been sent and processed.\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n RecognizeRequest request =\n RecognizeRequest.newBuilder()\n .setConfig(RecognitionConfig.newBuilder().build())\n .setAudio(RecognitionAudio.newBuilder().build())\n .build();\n RecognizeResponse response = speechClient.recognize(request);\n }\n```" + summary: "Performs synchronous speech recognition: receive results after all audio has been sent and\n processed.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   RecognizeRequest request =\n       RecognizeRequest.newBuilder()\n           .setConfig(RecognitionConfig.newBuilder().build())\n           .setAudio(RecognitionAudio.newBuilder().build())\n           .build();\n   RecognizeResponse response = speechClient.recognize(request);\n }\n 
" syntax: content: "public final RecognizeResponse recognize(RecognizeRequest request)" parameters: @@ -383,7 +383,7 @@ items: overload: "com.microsoft.samples.google.v1p1alpha.SpeechClient.recognizeCallable*" type: "Method" package: "com.microsoft.samples.google.v1p1alpha" - summary: "Performs synchronous speech recognition: receive results after all audio has been sent and processed.\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n RecognizeRequest request =\n RecognizeRequest.newBuilder()\n .setConfig(RecognitionConfig.newBuilder().build())\n .setAudio(RecognitionAudio.newBuilder().build())\n .build();\n ApiFuture future = speechClient.recognizeCallable().futureCall(request);\n // Do something.\n RecognizeResponse response = future.get();\n }\n```" + summary: "Performs synchronous speech recognition: receive results after all audio has been sent and\n processed.\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   RecognizeRequest request =\n       RecognizeRequest.newBuilder()\n           .setConfig(RecognitionConfig.newBuilder().build())\n           .setAudio(RecognitionAudio.newBuilder().build())\n           .build();\n   ApiFuture future = speechClient.recognizeCallable().futureCall(request);\n   // Do something.\n   RecognizeResponse response = future.get();\n }\n 
" syntax: content: "public final UnaryCallable recognizeCallable()" return: @@ -425,7 +425,7 @@ items: overload: "com.microsoft.samples.google.v1p1alpha.SpeechClient.streamingRecognizeCallable*" type: "Method" package: "com.microsoft.samples.google.v1p1alpha" - summary: "Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).\n\nSample code:\n\n```java\ntry (SpeechClient speechClient = SpeechClient.create()) {\n BidiStream bidiStream =\n speechClient.streamingRecognizeCallable().call();\n StreamingRecognizeRequest request = StreamingRecognizeRequest.newBuilder().build();\n bidiStream.send(request);\n for (StreamingRecognizeResponse response : bidiStream) {\n // Do something when a response is received.\n }\n }\n```" + summary: "Performs bidirectional streaming speech recognition: receive results while sending audio. This\n method is only available via the gRPC API (not REST).\n\n

Sample code:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   BidiStream bidiStream =\n       speechClient.streamingRecognizeCallable().call();\n   StreamingRecognizeRequest request = StreamingRecognizeRequest.newBuilder().build();\n   bidiStream.send(request);\n   for (StreamingRecognizeResponse response : bidiStream) {\n     // Do something when a response is received.\n   }\n }\n 
" syntax: content: "public final BidiStreamingCallable streamingRecognizeCallable()" return: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.subpackage.Display.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.subpackage.Display.yml index 3df8476a..116528a9 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.subpackage.Display.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.subpackage.Display.yml @@ -13,7 +13,7 @@ items: fullName: "com.microsoft.samples.subpackage.Display" type: "Interface" package: "com.microsoft.samples.subpackage" - summary: "Do you see some `First` code block?\n\nOr this `Second` code block?" + summary: "Do you see some First code block?\n

\n Or this Second code block?" syntax: content: "public interface Display extends Serializable, List>" typeParameters: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.subpackage.Person.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.subpackage.Person.yml index b69fd41c..53fcb271 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.subpackage.Person.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.subpackage.Person.yml @@ -21,7 +21,7 @@ items: fullName: "com.microsoft.samples.subpackage.Person" type: "Class" package: "com.microsoft.samples.subpackage" - summary: "Class that describes some person This comment has links to:\n\n * Owner class Person\n * Its inner class Person.IdentificationInfo\n * Its method Person#setLastName(String lastName)\n * Its method without params Person#setLastName()\n * Its public field Person#age\n * Another class which used here Set\n * Another class which not used here List\n * Broken link sdfdsagdsfghfgh\n * Plain link someContent\n * Link that starts from '\\#' #setLastName()\n * Link with label WordOne\n\nThis is an \"at\" symbol: @" + summary: "Class that describes some person\n\n This comment has links to:\n

    \n
  • Owner class Person
  • \n
  • Its inner class Person.IdentificationInfo
  • \n
  • Its method Person#setLastName(String lastName)
  • \n
  • Its method without params Person#setLastName()
  • \n
  • Its public field Person#age
  • \n
  • Another class which used here Set
  • \n
  • Another class which not used here List
  • \n
  • Broken link sdfdsagdsfghfgh
  • \n
  • Plain link someContent
  • \n
  • Link that starts from '#' #setLastName()
  • \n
  • Link with label WordOne
  • \n
\n\n This is an \"at\" symbol: @" syntax: content: "public class Person" typeParameters: diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.yml index c2d29ec5..cf863b10 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.yml @@ -16,7 +16,7 @@ items: nameWithType: "com.microsoft.samples" fullName: "com.microsoft.samples" type: "Namespace" - summary: "This package contains the sample set of classes for testing DocFx doclet." + summary: "The interfaces provided are listed below, along with usage samples.\n\n

SpeechClient

\n\n

Service Description: Service that implements Google Cloud Speech API.\n\n

Sample for SpeechClient:\n\n

\n try (SpeechClient speechClient = SpeechClient.create()) {\n   RecognitionConfig config = RecognitionConfig.newBuilder().build();\n   RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n   RecognizeResponse response = speechClient.recognize(config, audio);\n }\n 
\n\n

AdaptationClient

\n\n

Service Description: Service that implements Google Cloud Speech Adaptation API.\n\n

Sample for AdaptationClient:\n\n

\n try (AdaptationClient adaptationClient = AdaptationClient.create()) {\n   LocationName parent = LocationName.of(\"[PROJECT]\", \"[LOCATION]\");\n   PhraseSet phraseSet = PhraseSet.newBuilder().build();\n   String phraseSetId = \"phraseSetId959902180\";\n   PhraseSet response = adaptationClient.createPhraseSet(parent, phraseSet, phraseSetId);\n }\n 
" syntax: content: "package com.microsoft.samples" references: