From af64ed31027c176f7c3cfc7b263b5b15b28dc13e Mon Sep 17 00:00:00 2001 From: Yufei Huang Date: Mon, 21 Aug 2023 09:57:23 +0800 Subject: [PATCH] feat: option to sort enum member in declaring order (#9093) --- docs/reference/docfx-json-reference.md | 17 ++++- samples/seed/docfx.json | 1 + src/Docfx.Dotnet/DotnetApiCatalog.cs | 1 + .../ExtractMetadata/ExtractMetadataConfig.cs | 2 + .../ExtractMetadata/ExtractMetadataWorker.cs | 2 +- src/Docfx.Dotnet/MetadataJsonConfig.cs | 38 ++++++++--- src/Docfx.Dotnet/YamlViewModelExtensions.cs | 20 +++--- ...sRefType.ColorType.html.view.verified.json | 68 +++++++++---------- ...meration.ColorType.html.view.verified.json | 68 +++++++++---------- .../SamplesTest.Seed/index.verified.json | 4 +- 10 files changed, 131 insertions(+), 90 deletions(-) diff --git a/docs/reference/docfx-json-reference.md b/docs/reference/docfx-json-reference.md index 401f1c2d5fa..de9a79c1724 100644 --- a/docs/reference/docfx-json-reference.md +++ b/docs/reference/docfx-json-reference.md @@ -339,16 +339,29 @@ Do not run `dotnet restore` before building the projects. ### `namespaceLayout` -Defines how namespaces in TOC are organized. When set to *flattened*, renders namespaces as a single flat list. When set to *nested*, renders namespaces in a nested tree form. The default is *flattened*. +Defines how namespaces in TOC are organized: + +- `flattened` (default): Renders namespaces as a single flat list. +- `nested`: Renders namespaces in a nested tree form. ### `memberLayout` -Defines how member pages are organized. When set to *samePage*, places members in the same page as their containing type. When set to *separatePages*, places members in separate pages. The default is *samePage*. +Defines how member pages are organized: + +- `samePage` (default): Places members in the same page as their containing type. +- `separatePages`: Places members in separate pages. ### `allowCompilationErrors` When enabled, continues documentation generation in case of compilation errors. +### `EnumSortOrder` + +Defines how enum members are sorted: + +- `alphabetic` (default): Sort enum members in alphabetic order. +- `declaringOrder`: Sort enum members in the order as they are declared in the source code. + ## `pdf` Configuration options that are applied for `docfx pdf` command: diff --git a/samples/seed/docfx.json b/samples/seed/docfx.json index c09d194183b..f103937b4c5 100644 --- a/samples/seed/docfx.json +++ b/samples/seed/docfx.json @@ -17,6 +17,7 @@ } ], "namespaceLayout": "nested", + "enumSortOrder": "declaringOrder", "dest": "obj/api" } ], diff --git a/src/Docfx.Dotnet/DotnetApiCatalog.cs b/src/Docfx.Dotnet/DotnetApiCatalog.cs index 0dc13a574dc..03814d4750a 100644 --- a/src/Docfx.Dotnet/DotnetApiCatalog.cs +++ b/src/Docfx.Dotnet/DotnetApiCatalog.cs @@ -125,6 +125,7 @@ private static ExtractMetadataConfig ConvertConfig(MetadataJsonItemConfig config NoRestore = configModel?.NoRestore ?? false, NamespaceLayout = configModel?.NamespaceLayout ?? default, MemberLayout = configModel?.MemberLayout ?? default, + EnumSortOrder = configModel?.EnumSortOrder ?? default, AllowCompilationErrors = configModel?.AllowCompilationErrors ?? false, Files = expandedFiles.Items.SelectMany(s => s.Files).ToList(), References = expandedReferences?.Items.SelectMany(s => s.Files).ToList(), diff --git a/src/Docfx.Dotnet/ExtractMetadata/ExtractMetadataConfig.cs b/src/Docfx.Dotnet/ExtractMetadata/ExtractMetadataConfig.cs index befe01cdaff..5a04e5ea4d4 100644 --- a/src/Docfx.Dotnet/ExtractMetadata/ExtractMetadataConfig.cs +++ b/src/Docfx.Dotnet/ExtractMetadata/ExtractMetadataConfig.cs @@ -29,6 +29,8 @@ internal class ExtractMetadataConfig public MemberLayout MemberLayout { get; init; } + public EnumSortOrder EnumSortOrder { get; init; } + public Dictionary MSBuildProperties { get; init; } public bool AllowCompilationErrors { get; init; } diff --git a/src/Docfx.Dotnet/ExtractMetadata/ExtractMetadataWorker.cs b/src/Docfx.Dotnet/ExtractMetadata/ExtractMetadataWorker.cs index 0d9631c5c16..368bebcfe1c 100644 --- a/src/Docfx.Dotnet/ExtractMetadata/ExtractMetadataWorker.cs +++ b/src/Docfx.Dotnet/ExtractMetadata/ExtractMetadataWorker.cs @@ -232,7 +232,7 @@ private void ResolveAndExportYamlMetadata( var fileName = memberModel.Name.Replace('`', '-'); var outputFileName = GetUniqueFileNameWithSuffix(fileName + Constants.YamlExtension, outputFileNames); string itemFilePath = Path.Combine(_config.OutputFolder, outputFileName); - var memberViewModel = memberModel.ToPageViewModel(); + var memberViewModel = memberModel.ToPageViewModel(_config); memberViewModel.ShouldSkipMarkup = _config.ShouldSkipMarkup; memberViewModel.MemberLayout = _config.MemberLayout; YamlUtility.Serialize(itemFilePath, memberViewModel, YamlMime.ManagedReference); diff --git a/src/Docfx.Dotnet/MetadataJsonConfig.cs b/src/Docfx.Dotnet/MetadataJsonConfig.cs index 71d7c421507..4a5f50bc639 100644 --- a/src/Docfx.Dotnet/MetadataJsonConfig.cs +++ b/src/Docfx.Dotnet/MetadataJsonConfig.cs @@ -31,6 +31,22 @@ internal enum NamespaceLayout Nested, } +/// +/// Specifies the sort order for enums. +/// +internal enum EnumSortOrder +{ + /// + /// Sorts enums in alphabetic order. + /// + Alphabetic, + + /// + /// Sorts enums in the order they are declared. + /// + DeclaringOrder +} + /// /// MetadataJsonItemConfig. /// @@ -67,7 +83,6 @@ internal class MetadataJsonItemConfig [JsonProperty("filter")] public string FilterConfigFile { get; set; } - /// /// Include private or internal APIs. /// The default is false. @@ -114,23 +129,28 @@ internal class MetadataJsonItemConfig public bool NoRestore { get; set; } /// - /// Defines how namespaces in TOC are organized. - /// When set to flattened, renders namespaces as a single flat list. - /// When set to nested, renders namespaces in a nested tree form. - /// The default is flattened. + /// Defines how namespaces in TOC are organized: + /// - `flattened` (default): Renders namespaces as a single flat list. + /// - `nested`: Renders namespaces in a nested tree form. /// [JsonProperty("namespaceLayout")] public NamespaceLayout NamespaceLayout { get; set; } /// - /// Defines how member pages are organized. - /// When set to samePage, places members in the same page as their containing type. - /// When set to separatePages, places members in separate pages. - /// The default is samePage. + /// Defines how member pages are organized: + /// - `samePage` (default): Places members in the same page as their containing type. + /// - `separatePages`: Places members in separate pages. /// [JsonProperty("memberLayout")] public MemberLayout MemberLayout { get; set; } + /// + /// Defines how member pages are organized: + /// - `samePage` (default): Places members in the same page as their containing type. + /// - `separatePages`: Places members in separate pages. + /// + public EnumSortOrder EnumSortOrder { get; init; } + /// /// When enabled, continues documentation generation in case of compilation errors. /// diff --git a/src/Docfx.Dotnet/YamlViewModelExtensions.cs b/src/Docfx.Dotnet/YamlViewModelExtensions.cs index af5e1980289..4c24a2e95dc 100644 --- a/src/Docfx.Dotnet/YamlViewModelExtensions.cs +++ b/src/Docfx.Dotnet/YamlViewModelExtensions.cs @@ -150,17 +150,17 @@ public static TocItemViewModel ToTocItemViewModel(this MetadataItem item, string return result; } - public static PageViewModel ToPageViewModel(this MetadataItem model) + public static PageViewModel ToPageViewModel(this MetadataItem model, ExtractMetadataConfig config) { if (model == null) { return null; } var result = new PageViewModel(); - result.Items.Add(model.ToItemViewModel()); + result.Items.Add(model.ToItemViewModel(config)); if (model.Type.AllowMultipleItems()) { - AddChildren(model, result); + AddChildren(model, result, config); } foreach (var item in model.References) { @@ -229,13 +229,17 @@ private static ReferenceViewModel ToReferenceViewModel(KeyValuePair x.Name).ToList() + : model.Items?.Select(x => x.Name).OrderBy(s => s, StringComparer.Ordinal).ToList(); + var result = new ItemViewModel { Uid = model.Name, @@ -243,7 +247,7 @@ public static ItemViewModel ToItemViewModel(this MetadataItem model) IsExplicitInterfaceImplementation = model.IsExplicitInterfaceImplementation, IsExtensionMethod = model.IsExtensionMethod, Parent = model.Parent?.Name, - Children = model.Items?.Select(x => x.Name).OrderBy(s => s, StringComparer.Ordinal).ToList(), + Children = children, Type = model.Type, Source = model.Source, Documentation = model.Documentation, @@ -372,14 +376,14 @@ public static TValue GetLanguageProperty(this SortedList 0) { foreach (var item in model.Items) { - result.Items.Add(item.ToItemViewModel()); - AddChildren(item, result); + result.Items.Add(item.ToItemViewModel(config)); + AddChildren(item, result, config); } } } diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.ContainersRefType.ColorType.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.ContainersRefType.ColorType.html.view.verified.json index c4b61ff673d..65ebe686897 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.ContainersRefType.ColorType.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.ContainersRefType.ColorType.html.view.verified.json @@ -56,7 +56,7 @@ "id": "fields", "children": [ { - "uid": "CatLibrary.Core.ContainersRefType.ColorType.Blue", + "uid": "CatLibrary.Core.ContainersRefType.ColorType.Red", "isEii": false, "isExtensionMethod": false, "parent": "CatLibrary.Core.ContainersRefType.ColorType", @@ -64,52 +64,52 @@ "name": [ { "lang": "csharp", - "value": "Blue" + "value": "Red" }, { "lang": "vb", - "value": "Blue" + "value": "Red" } ], "nameWithType": [ { "lang": "csharp", - "value": "ContainersRefType.ColorType.Blue" + "value": "ContainersRefType.ColorType.Red" }, { "lang": "vb", - "value": "ContainersRefType.ColorType.Blue" + "value": "ContainersRefType.ColorType.Red" } ], "fullName": [ { "lang": "csharp", - "value": "CatLibrary.Core.ContainersRefType.ColorType.Blue" + "value": "CatLibrary.Core.ContainersRefType.ColorType.Red" }, { "lang": "vb", - "value": "CatLibrary.Core.ContainersRefType.ColorType.Blue" + "value": "CatLibrary.Core.ContainersRefType.ColorType.Red" } ], "specName": [ { "lang": "csharp", - "value": "" + "value": "" }, { "lang": "vb", - "value": "" + "value": "" } ], "syntax": { "content": [ { "lang": "csharp", - "value": "Blue = 1" + "value": "Red = 0" }, { "lang": "vb", - "value": "Blue = 1" + "value": "Red = 0" } ], "return": null, @@ -165,9 +165,9 @@ "branch": "main", "repo": "https://github.com/dotnet/docfx" }, - "id": "Blue", + "id": "Red", "path": "dotnet/solution/CatLibrary.Core/BaseClass.cs", - "startLine": 32.0, + "startLine": 28.0, "endLine": 0.0, "isExternal": false }, @@ -178,20 +178,20 @@ "example": [], "level": 0.0, "type": "field", - "summary": "

blue

\n", + "summary": "

red

\n", "platform": null, - "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Core_ContainersRefType_ColorType_Blue.md&value=---%0Auid%3A%20CatLibrary.Core.ContainersRefType.ColorType.Blue%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", - "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary.Core/BaseClass.cs/#L33", + "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Core_ContainersRefType_ColorType_Red.md&value=---%0Auid%3A%20CatLibrary.Core.ContainersRefType.ColorType.Red%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", + "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary.Core/BaseClass.cs/#L29", "remarks": "", "conceptual": "", "implements": "", "seealso": null, - "id": "CatLibrary_Core_ContainersRefType_ColorType_Blue", + "id": "CatLibrary_Core_ContainersRefType_ColorType_Red", "hideTitleType": false, "hideSubtitle": false }, { - "uid": "CatLibrary.Core.ContainersRefType.ColorType.Red", + "uid": "CatLibrary.Core.ContainersRefType.ColorType.Blue", "isEii": false, "isExtensionMethod": false, "parent": "CatLibrary.Core.ContainersRefType.ColorType", @@ -199,52 +199,52 @@ "name": [ { "lang": "csharp", - "value": "Red" + "value": "Blue" }, { "lang": "vb", - "value": "Red" + "value": "Blue" } ], "nameWithType": [ { "lang": "csharp", - "value": "ContainersRefType.ColorType.Red" + "value": "ContainersRefType.ColorType.Blue" }, { "lang": "vb", - "value": "ContainersRefType.ColorType.Red" + "value": "ContainersRefType.ColorType.Blue" } ], "fullName": [ { "lang": "csharp", - "value": "CatLibrary.Core.ContainersRefType.ColorType.Red" + "value": "CatLibrary.Core.ContainersRefType.ColorType.Blue" }, { "lang": "vb", - "value": "CatLibrary.Core.ContainersRefType.ColorType.Red" + "value": "CatLibrary.Core.ContainersRefType.ColorType.Blue" } ], "specName": [ { "lang": "csharp", - "value": "" + "value": "" }, { "lang": "vb", - "value": "" + "value": "" } ], "syntax": { "content": [ { "lang": "csharp", - "value": "Red = 0" + "value": "Blue = 1" }, { "lang": "vb", - "value": "Red = 0" + "value": "Blue = 1" } ], "return": null, @@ -300,9 +300,9 @@ "branch": "main", "repo": "https://github.com/dotnet/docfx" }, - "id": "Red", + "id": "Blue", "path": "dotnet/solution/CatLibrary.Core/BaseClass.cs", - "startLine": 28.0, + "startLine": 32.0, "endLine": 0.0, "isExternal": false }, @@ -313,15 +313,15 @@ "example": [], "level": 0.0, "type": "field", - "summary": "

red

\n", + "summary": "

blue

\n", "platform": null, - "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Core_ContainersRefType_ColorType_Red.md&value=---%0Auid%3A%20CatLibrary.Core.ContainersRefType.ColorType.Red%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", - "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary.Core/BaseClass.cs/#L29", + "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Core_ContainersRefType_ColorType_Blue.md&value=---%0Auid%3A%20CatLibrary.Core.ContainersRefType.ColorType.Blue%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", + "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary.Core/BaseClass.cs/#L33", "remarks": "", "conceptual": "", "implements": "", "seealso": null, - "id": "CatLibrary_Core_ContainersRefType_ColorType_Red", + "id": "CatLibrary_Core_ContainersRefType_ColorType_Blue", "hideTitleType": false, "hideSubtitle": false }, diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/MRef.Demo.Enumeration.ColorType.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/MRef.Demo.Enumeration.ColorType.html.view.verified.json index b4be711d6b0..64109ea5def 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/MRef.Demo.Enumeration.ColorType.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/MRef.Demo.Enumeration.ColorType.html.view.verified.json @@ -56,7 +56,7 @@ "id": "fields", "children": [ { - "uid": "MRef.Demo.Enumeration.ColorType.Blue", + "uid": "MRef.Demo.Enumeration.ColorType.Red", "isEii": false, "isExtensionMethod": false, "parent": "MRef.Demo.Enumeration.ColorType", @@ -64,52 +64,52 @@ "name": [ { "lang": "csharp", - "value": "Blue" + "value": "Red" }, { "lang": "vb", - "value": "Blue" + "value": "Red" } ], "nameWithType": [ { "lang": "csharp", - "value": "ColorType.Blue" + "value": "ColorType.Red" }, { "lang": "vb", - "value": "ColorType.Blue" + "value": "ColorType.Red" } ], "fullName": [ { "lang": "csharp", - "value": "MRef.Demo.Enumeration.ColorType.Blue" + "value": "MRef.Demo.Enumeration.ColorType.Red" }, { "lang": "vb", - "value": "MRef.Demo.Enumeration.ColorType.Blue" + "value": "MRef.Demo.Enumeration.ColorType.Red" } ], "specName": [ { "lang": "csharp", - "value": "" + "value": "" }, { "lang": "vb", - "value": "" + "value": "" } ], "syntax": { "content": [ { "lang": "csharp", - "value": "Blue = 1" + "value": "Red = 0" }, { "lang": "vb", - "value": "Blue = 1" + "value": "Red = 0" } ], "return": null, @@ -165,9 +165,9 @@ "branch": "main", "repo": "https://github.com/dotnet/docfx" }, - "id": "Blue", + "id": "Red", "path": "dotnet/solution/CatLibrary/Class1.cs", - "startLine": 408.0, + "startLine": 404.0, "endLine": 0.0, "isExternal": false }, @@ -178,20 +178,20 @@ "example": [], "level": 0.0, "type": "field", - "summary": "

blue like river

\n", + "summary": "

this color is red

\n", "platform": null, - "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=MRef_Demo_Enumeration_ColorType_Blue.md&value=---%0Auid%3A%20MRef.Demo.Enumeration.ColorType.Blue%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", - "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L409", + "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=MRef_Demo_Enumeration_ColorType_Red.md&value=---%0Auid%3A%20MRef.Demo.Enumeration.ColorType.Red%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", + "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L405", "remarks": "", "conceptual": "", "implements": "", "seealso": null, - "id": "MRef_Demo_Enumeration_ColorType_Blue", + "id": "MRef_Demo_Enumeration_ColorType_Red", "hideTitleType": false, "hideSubtitle": false }, { - "uid": "MRef.Demo.Enumeration.ColorType.Red", + "uid": "MRef.Demo.Enumeration.ColorType.Blue", "isEii": false, "isExtensionMethod": false, "parent": "MRef.Demo.Enumeration.ColorType", @@ -199,52 +199,52 @@ "name": [ { "lang": "csharp", - "value": "Red" + "value": "Blue" }, { "lang": "vb", - "value": "Red" + "value": "Blue" } ], "nameWithType": [ { "lang": "csharp", - "value": "ColorType.Red" + "value": "ColorType.Blue" }, { "lang": "vb", - "value": "ColorType.Red" + "value": "ColorType.Blue" } ], "fullName": [ { "lang": "csharp", - "value": "MRef.Demo.Enumeration.ColorType.Red" + "value": "MRef.Demo.Enumeration.ColorType.Blue" }, { "lang": "vb", - "value": "MRef.Demo.Enumeration.ColorType.Red" + "value": "MRef.Demo.Enumeration.ColorType.Blue" } ], "specName": [ { "lang": "csharp", - "value": "" + "value": "" }, { "lang": "vb", - "value": "" + "value": "" } ], "syntax": { "content": [ { "lang": "csharp", - "value": "Red = 0" + "value": "Blue = 1" }, { "lang": "vb", - "value": "Red = 0" + "value": "Blue = 1" } ], "return": null, @@ -300,9 +300,9 @@ "branch": "main", "repo": "https://github.com/dotnet/docfx" }, - "id": "Red", + "id": "Blue", "path": "dotnet/solution/CatLibrary/Class1.cs", - "startLine": 404.0, + "startLine": 408.0, "endLine": 0.0, "isExternal": false }, @@ -313,15 +313,15 @@ "example": [], "level": 0.0, "type": "field", - "summary": "

this color is red

\n", + "summary": "

blue like river

\n", "platform": null, - "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=MRef_Demo_Enumeration_ColorType_Red.md&value=---%0Auid%3A%20MRef.Demo.Enumeration.ColorType.Red%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", - "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L405", + "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=MRef_Demo_Enumeration_ColorType_Blue.md&value=---%0Auid%3A%20MRef.Demo.Enumeration.ColorType.Blue%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", + "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L409", "remarks": "", "conceptual": "", "implements": "", "seealso": null, - "id": "MRef_Demo_Enumeration_ColorType_Red", + "id": "MRef_Demo_Enumeration_ColorType_Blue", "hideTitleType": false, "hideSubtitle": false }, diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json index 9fe639b2f1e..b6718d7ef0d 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json @@ -157,7 +157,7 @@ "api/CatLibrary.Core.ContainersRefType.ColorType.html": { "href": "api/CatLibrary.Core.ContainersRefType.ColorType.html", "title": "Enum ContainersRefType.ColorType | docfx seed website", - "keywords": "Enum ContainersRefType.ColorType Namespace CatLibrary.Core Assembly CatLibrary.Core.dll Enumeration ColorType public enum ContainersRefType.ColorType Fields Blue = 1 blue Red = 0 red Yellow = 2 yellow" + "keywords": "Enum ContainersRefType.ColorType Namespace CatLibrary.Core Assembly CatLibrary.Core.dll Enumeration ColorType public enum ContainersRefType.ColorType Fields Red = 0 red Blue = 1 blue Yellow = 2 yellow" }, "api/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html": { "href": "api/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html", @@ -237,7 +237,7 @@ "api/MRef.Demo.Enumeration.ColorType.html": { "href": "api/MRef.Demo.Enumeration.ColorType.html", "title": "Enum ColorType | docfx seed website", - "keywords": "Enum ColorType Namespace MRef.Demo.Enumeration Assembly CatLibrary.dll Enumeration ColorType public enum ColorType Fields Blue = 1 blue like river Red = 0 this color is red Yellow = 2 yellow comes from desert Remarks Red/Blue/Yellow can become all color you want. See Also object" + "keywords": "Enum ColorType Namespace MRef.Demo.Enumeration Assembly CatLibrary.dll Enumeration ColorType public enum ColorType Fields Red = 0 this color is red Blue = 1 blue like river Yellow = 2 yellow comes from desert Remarks Red/Blue/Yellow can become all color you want. See Also object" }, "api/MRef.Demo.Enumeration.html": { "href": "api/MRef.Demo.Enumeration.html",