diff --git a/third_party/docfx-doclet-143274/src/main/java/com/microsoft/build/BuilderUtil.java b/third_party/docfx-doclet-143274/src/main/java/com/microsoft/build/BuilderUtil.java index f5bef0f6..46214575 100644 --- a/third_party/docfx-doclet-143274/src/main/java/com/microsoft/build/BuilderUtil.java +++ b/third_party/docfx-doclet-143274/src/main/java/com/microsoft/build/BuilderUtil.java @@ -37,14 +37,6 @@ final class BuilderUtil { private static final Pattern XREF_LINK_RESOLVE_PATTERN = Pattern.compile("(?\\w+)\\#(?\\w+)(\\((?.*)\\))?"); public final static String[] LANGS = {"java"}; - static String getDeprecatedSummary(String depMsg, String summary) { - String result = "

(deprecated) " + depMsg + "

"; - if (summary != null && !summary.equals("")) { - result = result + "\n" + summary; - } - return result; - } - static String populateUidValues(String text, LookupContext lookupContext) { if (StringUtils.isBlank(text)) { return text; @@ -196,6 +188,7 @@ static void populateItemFields(MetadataFileItem item, BaseLo item.setType(lookup.extractType(element)); item.setJavaType(lookup.extractJavaType(element)); item.setSummary(lookup.extractSummary(element)); + item.setStatus(lookup.extractStatus(element)); item.setContent(lookup.extractContent(element)); } } diff --git a/third_party/docfx-doclet-143274/src/main/java/com/microsoft/build/ClassBuilder.java b/third_party/docfx-doclet-143274/src/main/java/com/microsoft/build/ClassBuilder.java index 1ac99543..c70652f7 100644 --- a/third_party/docfx-doclet-143274/src/main/java/com/microsoft/build/ClassBuilder.java +++ b/third_party/docfx-doclet-143274/src/main/java/com/microsoft/build/ClassBuilder.java @@ -35,7 +35,6 @@ import java.util.stream.Collectors; import static com.microsoft.build.BuilderUtil.LANGS; -import static com.microsoft.build.BuilderUtil.getDeprecatedSummary; import static com.microsoft.build.BuilderUtil.populateItemFields; class ClassBuilder { @@ -97,11 +96,8 @@ private void addClassInfo(TypeElement classElement, MetadataFile classMetadataFi classItem.setInheritance(classLookup.extractSuperclass(classElement)); classItem.setInterfaces(classLookup.extractInterfaces(classElement)); classItem.setInheritedMethods(classLookup.extractInheritedMethods(classElement)); - String depMsg = classLookup.extractDeprecatedDescription(classElement); - if (depMsg != null) { - classItem.setSummary(getDeprecatedSummary(depMsg, classItem.getSummary())); - classItem.setStatus(Status.DEPRECATED.toString()); - } + classItem.setSummary(classLookup.extractSummary(classElement)); + classItem.setStatus(classLookup.extractStatus(classElement)); classMetadataFile.getItems().add(classItem); } @@ -111,11 +107,6 @@ void addConstructorsInfo(TypeElement classElement, MetadataFile classMetadataFil constructorItem.setOverload(classItemsLookup.extractOverload(constructorElement)); constructorItem.setContent(classItemsLookup.extractConstructorContent(constructorElement)); constructorItem.setParameters(classItemsLookup.extractParameters(constructorElement)); - String depMsg = classItemsLookup.extractDeprecatedDescription(constructorElement); - if (depMsg != null) { - constructorItem.setSummary(getDeprecatedSummary(depMsg, constructorItem.getSummary())); - constructorItem.setStatus(Status.DEPRECATED.toString()); - } classMetadataFile.getItems().add(constructorItem); referenceBuilder.addParameterReferences(constructorItem, classMetadataFile); @@ -134,11 +125,6 @@ private void addMethodsInfo(TypeElement classElement, MetadataFile classMetadata methodItem.setParameters(classItemsLookup.extractParameters(methodElement)); methodItem.setReturn(classItemsLookup.extractReturn(methodElement)); methodItem.setOverridden(classItemsLookup.extractOverridden(methodElement)); - String depMsg = classItemsLookup.extractDeprecatedDescription(methodElement); - if (depMsg != null) { - methodItem.setSummary(getDeprecatedSummary(depMsg, methodItem.getSummary())); - methodItem.setStatus(Status.DEPRECATED.toString()); - } classMetadataFile.getItems().add(methodItem); referenceBuilder.addExceptionReferences(methodItem, classMetadataFile); @@ -155,12 +141,6 @@ private void addFieldsInfo(TypeElement classElement, MetadataFile classMetadataF MetadataFileItem fieldItem = buildMetadataFileItem(fieldElement); fieldItem.setContent(classItemsLookup.extractFieldContent(fieldElement)); fieldItem.setReturn(classItemsLookup.extractReturn(fieldElement)); - String depMsg = classItemsLookup.extractDeprecatedDescription(fieldElement); - if (depMsg != null) { - fieldItem.setSummary(getDeprecatedSummary(depMsg, fieldItem.getSummary())); - fieldItem.setStatus(Status.DEPRECATED.toString()); - } - classMetadataFile.getItems().add(fieldItem); referenceBuilder.addReturnReferences(fieldItem, classMetadataFile); }); @@ -182,6 +162,7 @@ private MetadataFileItem buildMetadataFileItem(Element element) { setJavaType(classItemsLookup.extractJavaType(element)); setPackageName(classItemsLookup.extractPackageName(element)); setSummary(classItemsLookup.extractSummary(element)); + setStatus(classItemsLookup.extractStatus(element)); }}; } 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 1dfa0a71..94cd8abe 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 @@ -59,7 +59,7 @@ public boolean build() { for (PackageElement packageElement : elementUtil.extractPackageElements(environment.getIncludedElements())) { String packageUid = packageLookup.extractUid(packageElement); - String packageStatus = packageLookup.extractStatus(packageElement.getQualifiedName().toString()); + String packageStatus = packageLookup.extractStatus(packageElement); TocItem packageTocItem = new TocItem(packageUid, packageUid, packageStatus); // build package summary packageMetadataFiles.add(packageBuilder.buildPackageMetadataFile(packageElement)); diff --git a/third_party/docfx-doclet-143274/src/main/java/com/microsoft/lookup/BaseLookup.java b/third_party/docfx-doclet-143274/src/main/java/com/microsoft/lookup/BaseLookup.java index c386302c..c2e29a1c 100644 --- a/third_party/docfx-doclet-143274/src/main/java/com/microsoft/lookup/BaseLookup.java +++ b/third_party/docfx-doclet-143274/src/main/java/com/microsoft/lookup/BaseLookup.java @@ -1,21 +1,31 @@ package com.microsoft.lookup; import com.microsoft.lookup.model.ExtendedMetadataFileItem; -import com.microsoft.model.*; +import com.microsoft.model.ExceptionItem; +import com.microsoft.model.MetadataFileItem; +import com.microsoft.model.MethodParameter; +import com.microsoft.model.Return; +import com.microsoft.model.TypeParameter; import com.microsoft.util.YamlUtil; +import com.sun.source.doctree.DeprecatedTree; import com.sun.source.doctree.DocCommentTree; import com.sun.source.doctree.DocTree; import com.sun.source.doctree.LinkTree; import com.sun.source.doctree.LiteralTree; +import com.sun.source.doctree.SeeTree; import jdk.javadoc.doclet.DocletEnvironment; import org.apache.commons.lang3.RegExUtils; import org.apache.commons.lang3.StringUtils; import javax.lang.model.element.Element; import javax.lang.model.element.ElementKind; -import javax.lang.model.element.Modifier; -import javax.lang.model.element.TypeElement; -import java.util.*; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.Set; import java.util.stream.Collectors; import java.util.stream.Stream; @@ -157,6 +167,20 @@ public String extractOverridden(T key) { return resolve(key).getOverridden(); } + public String extractStatus(T element) { + Optional docCommentTree = getDocCommentTree(element); + if (docCommentTree.isPresent()) { + boolean isDeprecated = docCommentTree.get().getBlockTags().stream() + .filter(docTree -> docTree.getKind().equals(DocTree.Kind.DEPRECATED)) + .findFirst() + .isPresent(); + if (isDeprecated){ + return DocTree.Kind.DEPRECATED.name().toLowerCase(); + } + } + return null; + } + protected String determineType(T element) { return elementKindLookup.get(element.getKind()); } @@ -166,10 +190,38 @@ protected String determinePackageName(T element) { } protected String determineComment(T element) { - return getDocCommentTree(element) - .map(DocCommentTree::getFullBody) - .map(this::replaceLinksAndCodes) - .orElse(null); + Optional docCommentTree = getDocCommentTree(element); + if (docCommentTree.isPresent()) { + String comment = docCommentTree + .map(DocCommentTree::getFullBody) + .map(this::replaceLinksAndCodes) + .orElse(null); + return replaceBlockTags(docCommentTree.get(), comment); + } + return null; + } + + /** + * Provides support for deprecated and see tags + */ + String replaceBlockTags(DocCommentTree docCommentTree, String comment) { + List seeItems = new ArrayList<>(); + String commentWithBlockTags = comment; + for (DocTree blockTag : docCommentTree.getBlockTags()) { + switch (blockTag.getKind()) { + case DEPRECATED: + commentWithBlockTags = getDeprecatedSummary((DeprecatedTree) blockTag).concat(comment); + break; + case SEE: + seeItems.add(getSeeTagRef((SeeTree) blockTag)); + break; + default: + } + } + if (!seeItems.isEmpty()) { + commentWithBlockTags = commentWithBlockTags.concat(getSeeAlsoSummary(seeItems)); + } + return commentWithBlockTags; } /** @@ -231,4 +283,23 @@ public String makeTypeShort(String value) { .map(s -> RegExUtils.removeAll(s, "\\b[a-z0-9_.]+\\.")) .collect(Collectors.joining("<")); } + + private String getSeeAlsoSummary(List seeItems) { + return String.format("\nSee Also: %s\n", String.join(", ", seeItems)); + } + + private String getDeprecatedSummary(DeprecatedTree deprecatedTree) { + return String.format("\nDeprecated. %s\n\n", + replaceLinksAndCodes(deprecatedTree.getBody())); + } + + private String getSeeTagRef(SeeTree seeTree) { + String ref = seeTree.getReference().stream() + .map(r -> String.valueOf(r)).collect(Collectors.joining("")); + // if it's already a tag, use that otherwise build xref tag + if (ref.matches("^<.+>.*")) { + return ref; + } + return String.format("%1$s", ref); + } } diff --git a/third_party/docfx-doclet-143274/src/main/java/com/microsoft/lookup/ClassItemsLookup.java b/third_party/docfx-doclet-143274/src/main/java/com/microsoft/lookup/ClassItemsLookup.java index 009b67dd..1e60bd45 100644 --- a/third_party/docfx-doclet-143274/src/main/java/com/microsoft/lookup/ClassItemsLookup.java +++ b/third_party/docfx-doclet-143274/src/main/java/com/microsoft/lookup/ClassItemsLookup.java @@ -14,6 +14,7 @@ import javax.lang.model.type.TypeKind; import java.util.ArrayList; import java.util.List; +import java.util.Optional; import java.util.stream.Collectors; public class ClassItemsLookup extends BaseLookup { @@ -63,7 +64,7 @@ protected ExtendedMetadataFileItem buildMetadataFileItem(Element element) { result.setReturn(extractReturn(exeElement)); if (exeElement.getKind() == ElementKind.METHOD) { result.setOverridden(extractOverriddenUid(utils.overriddenMethod(exeElement))); - result.setSummary(getInheritedInlineCommentString(exeElement)); + result.setSummary(determineComment(exeElement)); } } result.setNameWithType(String.format("%s.%s", classSNameWithGenericsSupport, result.getName())); @@ -79,15 +80,6 @@ protected ExtendedMetadataFileItem buildMetadataFileItem(Element element) { return result; } - public String extractDeprecatedDescription(Element element) { - return getDocCommentTree(element).map(docTree -> docTree.getBlockTags().stream() - .filter(o -> o.getKind() == DocTree.Kind.DEPRECATED) - .map(o -> (DeprecatedTree) o) - .map(o -> replaceLinksAndCodes(o.getBody())) - .findFirst().orElse(null) - ).orElse(null); - } - List extractParameters(ExecutableElement element) { return element.getParameters().stream().map(o -> { String paramName = String.valueOf(o.getSimpleName()); @@ -156,19 +148,28 @@ String extractOverriddenUid(ExecutableElement ovr) { return ""; } + private String determineComment(ExecutableElement methodElement) { + String inheritedInlineComment = getInheritedInlineCommentString(methodElement); + Optional docCommentTree = getDocCommentTree(methodElement); + if (docCommentTree.isPresent()){ + return replaceBlockTags(docCommentTree.get(), inheritedInlineComment); + } + return inheritedInlineComment; + } + /** * If the item being inherited from is declared from external compiled package, * or is declared in the packages like java.lang.Object, * comments may be not available as doclet resolves from byte code. */ - String getInheritedInlineCommentString(ExecutableElement exeElement) { + private String getInheritedInlineCommentString(ExecutableElement exeElement) { CommentHelper ch = getInheritedInlineTags(new CommentHelper(exeElement, utils)); // Remove unresolved "@inheritDoc" tag. List dctree = utils.removeBlockTag(ch.inlineTags, DocTree.Kind.INHERIT_DOC); return replaceLinksAndCodes(dctree); } - CommentHelper getInheritedInlineTags(CommentHelper input) { + private CommentHelper getInheritedInlineTags(CommentHelper input) { CommentHelper output = input.copy(); if (!output.hasInheritDocTag() && !output.isSimpleOverride()) { return output; diff --git a/third_party/docfx-doclet-143274/src/main/java/com/microsoft/lookup/ClassLookup.java b/third_party/docfx-doclet-143274/src/main/java/com/microsoft/lookup/ClassLookup.java index 2d323863..91f097cc 100644 --- a/third_party/docfx-doclet-143274/src/main/java/com/microsoft/lookup/ClassLookup.java +++ b/third_party/docfx-doclet-143274/src/main/java/com/microsoft/lookup/ClassLookup.java @@ -2,22 +2,23 @@ import com.microsoft.lookup.model.ExtendedMetadataFileItem; import com.microsoft.model.MetadataFileItem; -import com.microsoft.model.Status; import com.microsoft.model.TypeParameter; import com.microsoft.util.Utils; -import com.sun.source.doctree.DeprecatedTree; -import com.sun.source.doctree.DocTree; import jdk.javadoc.doclet.DocletEnvironment; import org.apache.commons.collections4.CollectionUtils; import org.apache.commons.lang3.StringUtils; import javax.lang.model.element.Element; import javax.lang.model.element.ElementKind; -import javax.lang.model.element.Modifier; import javax.lang.model.element.TypeElement; import javax.lang.model.type.TypeKind; import javax.lang.model.type.TypeMirror; -import java.util.*; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.NoSuchElementException; +import java.util.Optional; +import java.util.Set; import java.util.stream.Collectors; public class ClassLookup extends BaseLookup { @@ -57,28 +58,6 @@ protected ExtendedMetadataFileItem buildMetadataFileItem(TypeElement classElemen return result; } - public String extractStatus(TypeElement classElement) { - DocTree deprecated = getDocCommentTree(classElement) - .map(docTree -> docTree.getBlockTags().stream() - .filter(o -> o.getKind() == DocTree.Kind.DEPRECATED) - .findFirst().orElse(null) - ).orElse(null); - - if (deprecated != null) { - return Status.DEPRECATED.toString(); - } - return null; - } - - public String extractDeprecatedDescription(TypeElement classElement) { - return getDocCommentTree(classElement).map(docTree -> docTree.getBlockTags().stream() - .filter(o -> o.getKind() == DocTree.Kind.DEPRECATED) - .map(o -> (DeprecatedTree) o) - .map(o -> replaceLinksAndCodes(o.getBody())) - .findFirst().orElse(null) - ).orElse(null); - } - void populateContent(TypeElement classElement, String shortNameWithGenericsSupport, ExtendedMetadataFileItem container) { String type = elementKindLookup.get(classElement.getKind()); diff --git a/third_party/docfx-doclet-143274/src/main/java/com/microsoft/lookup/PackageLookup.java b/third_party/docfx-doclet-143274/src/main/java/com/microsoft/lookup/PackageLookup.java index 9d1e9216..afc4a55d 100644 --- a/third_party/docfx-doclet-143274/src/main/java/com/microsoft/lookup/PackageLookup.java +++ b/third_party/docfx-doclet-143274/src/main/java/com/microsoft/lookup/PackageLookup.java @@ -5,7 +5,6 @@ import jdk.javadoc.doclet.DocletEnvironment; import javax.lang.model.element.PackageElement; -import javax.lang.model.element.TypeElement; public class PackageLookup extends BaseLookup { @@ -31,7 +30,8 @@ protected ExtendedMetadataFileItem buildMetadataFileItem(PackageElement packageE return result; } - public String extractStatus(String name) { + public String extractStatus(PackageElement packageElement) { + String name = String.valueOf(packageElement.getQualifiedName()); if (name.contains(Status.ALPHA.toString())) { return Status.ALPHA.toString(); } @@ -46,9 +46,9 @@ String determinePackageContent(PackageElement packageElement) { } public String extractJavaType(PackageElement element) { - String javatype = element.getKind().name().toLowerCase().replaceAll("_",""); - if (javatype.equals("package")){ - return javatype; + String javaType = element.getKind().name().toLowerCase().replaceAll("_", ""); + if (javaType.equals("package")) { + return javaType; } return null; } diff --git a/third_party/docfx-doclet-143274/src/test/java/com/microsoft/lookup/ClassItemsLookupTest.java b/third_party/docfx-doclet-143274/src/test/java/com/microsoft/lookup/ClassItemsLookupTest.java index cecc9784..ed5ce1a2 100644 --- a/third_party/docfx-doclet-143274/src/test/java/com/microsoft/lookup/ClassItemsLookupTest.java +++ b/third_party/docfx-doclet-143274/src/test/java/com/microsoft/lookup/ClassItemsLookupTest.java @@ -265,28 +265,4 @@ public void determineTypeForEnumConstant() { assertEquals(classItemsLookup.determineType(element.getEnclosedElements().get(0)), "Field"); assertEquals(classItemsLookup.determineType(element.getEnclosedElements().get(1)), "Field"); } - - @Test - public void extractDeprecatedDescription() { - TypeElement element = elements.getTypeElement("com.microsoft.samples.agreements.AgreementDetailsCollectionOperations"); - ExecutableElement method = ElementFilter.methodsIn(element.getEnclosedElements()).get(0); - String depMsg = "Deprecated Message :("; - - when(environment.getDocTrees()).thenReturn(docTrees); - when(docTrees.getDocCommentTree(method)).thenReturn(docCommentTree); - doReturn(Arrays.asList(deprecatedTree)).when(docCommentTree).getBlockTags(); - when(deprecatedTree.getKind()).thenReturn(Kind.DEPRECATED); - - doReturn(Arrays.asList(textTree)).when(deprecatedTree).getBody(); - when(textTree.getKind()).thenReturn(Kind.TEXT); - when(textTree.toString()).thenReturn(depMsg); - - String result = classItemsLookup.extractDeprecatedDescription(method); - - verify(environment).getDocTrees(); - verify(docTrees).getDocCommentTree(method); - verify(docCommentTree).getBlockTags(); - verify(deprecatedTree).getKind(); - assertEquals("Wrong description", result, depMsg); - } } diff --git a/third_party/docfx-doclet-143274/src/test/java/com/microsoft/lookup/ClassLookupTest.java b/third_party/docfx-doclet-143274/src/test/java/com/microsoft/lookup/ClassLookupTest.java index 21d9a2c6..9ec0557b 100644 --- a/third_party/docfx-doclet-143274/src/test/java/com/microsoft/lookup/ClassLookupTest.java +++ b/third_party/docfx-doclet-143274/src/test/java/com/microsoft/lookup/ClassLookupTest.java @@ -168,45 +168,6 @@ public void determineTypeForClass() { assertEquals(classLookup.determineType(element), "Class"); } - @Test - public void extractDeprecatedDescription() { - TypeElement element = elements.getTypeElement("com.microsoft.samples.agreements.AgreementDetailsCollectionOperations"); - String depMsg = "Deprecated Message :("; - - when(environment.getDocTrees()).thenReturn(docTrees); - when(docTrees.getDocCommentTree(element)).thenReturn(docCommentTree); - doReturn(Arrays.asList(deprecatedTree)).when(docCommentTree).getBlockTags(); - when(deprecatedTree.getKind()).thenReturn(DocTree.Kind.DEPRECATED); - - doReturn(Arrays.asList(textTree)).when(deprecatedTree).getBody(); - when(textTree.getKind()).thenReturn(DocTree.Kind.TEXT); - when(textTree.toString()).thenReturn(depMsg); - - String result = classLookup.extractDeprecatedDescription(element); - - verify(environment).getDocTrees(); - verify(docTrees).getDocCommentTree(element); - verify(docCommentTree).getBlockTags(); - verify(deprecatedTree).getKind(); - assertEquals("Wrong description", result, depMsg); - } - - @Test - public void extractDeprecatedDescriptionNull() { - TypeElement element = elements.getTypeElement("com.microsoft.samples.agreements.AgreementDetailsCollectionOperations"); - - when(environment.getDocTrees()).thenReturn(docTrees); - when(docTrees.getDocCommentTree(element)).thenReturn(docCommentTree); - doReturn(Arrays.asList()).when(docCommentTree).getBlockTags(); - - String result = classLookup.extractDeprecatedDescription(element); - - verify(environment).getDocTrees(); - verify(docTrees).getDocCommentTree(element); - verify(docCommentTree).getBlockTags(); - assertEquals("Wrong description", result, null); - } - @Test public void extractStatusDeprecated() { TypeElement element = elements.getTypeElement("com.microsoft.samples.agreements.AgreementDetailsCollectionOperations"); diff --git a/third_party/docfx-doclet-143274/src/test/java/com/microsoft/lookup/PackageLookupTest.java b/third_party/docfx-doclet-143274/src/test/java/com/microsoft/lookup/PackageLookupTest.java index 77fb3684..90408fb7 100644 --- a/third_party/docfx-doclet-143274/src/test/java/com/microsoft/lookup/PackageLookupTest.java +++ b/third_party/docfx-doclet-143274/src/test/java/com/microsoft/lookup/PackageLookupTest.java @@ -46,8 +46,8 @@ public void extractPackageStatus() { PackageElement elementBeta = elements.getPackageElement("com.microsoft.samples.google.v1beta"); PackageElement elementAlpha = elements.getPackageElement("com.microsoft.samples.google.v1p1alpha"); - String resultA = packageLookup.extractStatus(elementAlpha.getQualifiedName().toString()); - String resultB = packageLookup.extractStatus(elementBeta.getQualifiedName().toString()); + String resultA = packageLookup.extractStatus(elementAlpha); + String resultB = packageLookup.extractStatus(elementBeta); assertEquals("Wrong result", resultA, Status.ALPHA.toString()); assertEquals("Wrong result", resultB, Status.BETA.toString()); 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 543bfec2..0804e4c8 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 @@ -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

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

" + summary: "\nDeprecated. As of version 1.1, use . . . instead\n\n

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

\nSee Also: HERO-402\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 22c01beb..2ce93c0d 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.

\nAgreement details collection operations implementation class." + summary: "\nDeprecated. Use AgreementMetaData instead.\n\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

\nRetrieves the agreement details." + summary: "\nDeprecated. Some text\n\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.IAgreementDetailsCollection.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.agreements.IAgreementDetailsCollection.yml index 8afb653a..088a3262 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 :(

\nEncapsulates the operations on the agreement metadata collection." + summary: "\nDeprecated. This one is deprecated :(\n\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.google.RecognitionAudio.AudioSourceCase.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.RecognitionAudio.AudioSourceCase.yml index 8b389ba6..134a6841 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: "\nDeprecated. Use #forNumber(int) instead.\n\n" 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.v1beta.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.v1beta.yml index 2fe445d3..0e86ea88 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.v1beta.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.v1beta.yml @@ -12,6 +12,7 @@ items: type: "Namespace" syntax: content: "package com.microsoft.samples.google.v1beta" + status: "beta" javaType: "package" references: - uid: "com.microsoft.samples.google.v1beta.SpeechClient" diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.v1p1alpha.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.v1p1alpha.yml index 19fbd1f3..314148de 100644 --- a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.v1p1alpha.yml +++ b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.google.v1p1alpha.yml @@ -12,6 +12,7 @@ items: type: "Namespace" syntax: content: "package com.microsoft.samples.google.v1p1alpha" + status: "alpha" javaType: "package" references: - uid: "com.microsoft.samples.google.v1p1alpha.SpeechClient" 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 53fcb271..c994836c 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\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: @" + 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: @\nSee Also: Display\n" syntax: content: "public class Person" typeParameters: