From e1b692a956ececeb81b378f58033d0e56f874272 Mon Sep 17 00:00:00 2001 From: filzrev Date: Wed, 13 Nov 2024 08:43:28 +0000 Subject: [PATCH] test(snapshot): update snapshots b6ccdd12b969f4f3b7f885855bac2b83daedb8f4 --- ...36.IJsonApiOptions.html.view.verified.json | 383 ++++++++ ...736.JsonApiOptions.html.view.verified.json | 819 ++++++++++++++++++ ...heritdoc.Issue9736.html.view.verified.json | 590 +++++++++++++ .../BuildFromProject.html.view.verified.json | 187 ++++ ...rary.ICatExtension.html.view.verified.json | 4 +- .../api/CatLibrary.html.view.verified.json | 2 +- .../api/toc.html.view.verified.json | 33 + .../api/toc.json.view.verified.json | 2 +- .../SamplesTest.Seed/api/toc.verified.json | 21 + ...36.IJsonApiOptions.html.view.verified.json | 20 + ...736.JsonApiOptions.html.view.verified.json | 20 + ...heritdoc.Issue9736.html.view.verified.json | 20 + .../BuildFromProject.html.view.verified.json | 2 +- ...rary.ICatExtension.html.view.verified.json | 4 +- .../CatLibrary.html.view.verified.json | 2 +- .../apipage/toc.html.view.verified.json | 27 + .../apipage/toc.json.view.verified.json | 2 +- .../apipage/toc.verified.json | 15 + .../articles/seed.pdf.verified.json | 36 +- .../SamplesTest.Seed/index.verified.json | 51 +- ...36.IJsonApiOptions.html.view.verified.json | 42 + ...736.JsonApiOptions.html.view.verified.json | 42 + ...heritdoc.Issue9736.html.view.verified.json | 42 + .../BuildFromProject.html.view.verified.json | 4 +- .../CatLibrary.Cat-2.html.view.verified.json | 2 +- ...rary.ICatExtension.html.view.verified.json | 2 +- .../md/CatLibrary.html.view.verified.json | 2 +- .../md/toc.html.view.verified.json | 27 + .../md/toc.json.view.verified.json | 2 +- .../SamplesTest.Seed/md/toc.verified.json | 15 + .../pdf/toc.html.view.verified.json | 33 + .../pdf/toc.json.view.verified.json | 2 +- .../SamplesTest.Seed/pdf/toc.verified.json | 21 + .../restapi/toc.pdf.verified.json | 54 +- .../SamplesTest.Seed/toc.pdf.verified.json | 44 +- .../SamplesTest.Seed/xrefmap.verified.yml | 44 + ...tdoc.Issue9736.IJsonApiOptions.verified.md | 40 + ...itdoc.Issue9736.JsonApiOptions.verified.md | 58 ++ ...omProject.Inheritdoc.Issue9736.verified.md | 24 + .../BuildFromProject.verified.md | 6 + .../CatLibrary.Cat-2.verified.md | 1 + .../CatLibrary.ICatExtension.verified.md | 3 +- .../CatLibrary.verified.md | 3 +- .../SamplesTest.SeedMarkdown/toc.verified.yml | 6 + 44 files changed, 2671 insertions(+), 88 deletions(-) create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue9736.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue9736.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue9736.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.verified.md create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.verified.md create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue9736.verified.md diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html.view.verified.json new file mode 100644 index 00000000000..d0666050a9e --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html.view.verified.json @@ -0,0 +1,383 @@ +{ + "uid": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions", + "isEii": false, + "isExtensionMethod": false, + "parent": { + "uid": "BuildFromProject", + "isEii": false, + "isExtensionMethod": false, + "href": "BuildFromProject.html", + "name": [ + { + "lang": "csharp", + "value": "BuildFromProject" + }, + { + "lang": "vb", + "value": "BuildFromProject" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "BuildFromProject" + }, + { + "lang": "vb", + "value": "BuildFromProject" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject" + }, + { + "lang": "vb", + "value": "BuildFromProject" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ], + "level": 0 + }, + "children": [ + { + "inProperty": true, + "typePropertyName": "inProperty", + "id": "properties", + "children": [ + { + "uid": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks", + "isEii": false, + "isExtensionMethod": false, + "parent": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions", + "isExternal": false, + "name": [ + { + "lang": "csharp", + "value": "UseRelativeLinks" + }, + { + "lang": "vb", + "value": "UseRelativeLinks" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks" + }, + { + "lang": "vb", + "value": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ], + "syntax": { + "content": [ + { + "lang": "csharp", + "value": "bool UseRelativeLinks { get; }" + }, + { + "lang": "vb", + "value": "ReadOnly Property UseRelativeLinks As Boolean" + } + ], + "parameters": [], + "return": null, + "propertyValue": { + "type": { + "uid": "System.Boolean", + "name": [ + { + "lang": "csharp", + "value": "bool" + }, + { + "lang": "vb", + "value": "Boolean" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "bool" + }, + { + "lang": "vb", + "value": "Boolean" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "bool" + }, + { + "lang": "vb", + "value": "Boolean" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ] + } + } + }, + "source": { + "remote": { + "path": "samples/seed/dotnet/project/Project/Inheritdoc.cs", + "branch": "main", + "repo": "https://github.com/dotnet/docfx" + }, + "id": "UseRelativeLinks", + "path": "dotnet/project/Project/Inheritdoc.cs", + "startLine": 138, + "endLine": 0 + }, + "assemblies": [ + "BuildFromProject" + ], + "namespace": "BuildFromProject", + "example": [ + "
options.UseRelativeLinks = true;
\n
{\n  \"type\": \"articles\",\n  \"id\": \"4309\",\n  \"relationships\": {\n     \"author\": {\n       \"links\": {\n         \"self\": \"/api/shopping/articles/4309/relationships/author\",\n         \"related\": \"/api/shopping/articles/4309/author\"\n       }\n     }\n  }\n}
\n" + ], + "overload": { + "uid": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks*", + "name": [ + { + "lang": "csharp", + "value": "UseRelativeLinks" + }, + { + "lang": "vb", + "value": "UseRelativeLinks" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks" + }, + { + "lang": "vb", + "value": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ], + "id": "BuildFromProject_Inheritdoc_Issue9736_IJsonApiOptions_UseRelativeLinks_" + }, + "level": 0, + "type": "property", + "summary": "

Whether to use relative links for all resources. false by default.

\n", + "platform": null, + "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Inheritdoc_Issue9736_IJsonApiOptions_UseRelativeLinks.md&value=---%0Auid%3A%20BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks%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/project/Project/Inheritdoc.cs/#L139", + "description": "", + "remarks": "", + "conceptual": "", + "implements": "", + "seealso": [], + "id": "BuildFromProject_Inheritdoc_Issue9736_IJsonApiOptions_UseRelativeLinks", + "hideTitleType": false, + "hideSubtitle": false + } + ] + } + ], + "langs": [ + "csharp", + "vb" + ], + "name": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736.IJsonApiOptions" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736.IJsonApiOptions" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736.IJsonApiOptions" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736.IJsonApiOptions" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions" + }, + { + "lang": "vb", + "value": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions" + } + ], + "type": "interface", + "source": { + "remote": { + "path": "samples/seed/dotnet/project/Project/Inheritdoc.cs", + "branch": "main", + "repo": "https://github.com/dotnet/docfx" + }, + "id": "IJsonApiOptions", + "path": "dotnet/project/Project/Inheritdoc.cs", + "startLine": 114, + "endLine": 0 + }, + "assemblies": [ + "BuildFromProject" + ], + "namespace": { + "uid": "BuildFromProject", + "isEii": false, + "isExtensionMethod": false, + "href": "BuildFromProject.html", + "name": [ + { + "lang": "csharp", + "value": "BuildFromProject" + }, + { + "lang": "vb", + "value": "BuildFromProject" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "BuildFromProject" + }, + { + "lang": "vb", + "value": "BuildFromProject" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject" + }, + { + "lang": "vb", + "value": "BuildFromProject" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ], + "level": 0 + }, + "syntax": { + "content": [ + { + "lang": "csharp", + "value": "public interface Inheritdoc.Issue9736.IJsonApiOptions" + }, + { + "lang": "vb", + "value": "Public Interface Inheritdoc.Issue9736.IJsonApiOptions" + } + ] + }, + "level": 0, + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "pdf": true, + "pdfTocPage": true, + "_key": "obj/api/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "api/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "_rel": "../", + "_tocKey": "~/obj/api/toc.yml", + "_tocPath": "api/toc.html", + "_tocRel": "toc.html", + "yamlmime": "ManagedReference", + "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Inheritdoc_Issue9736_IJsonApiOptions.md&value=---%0Auid%3A%20BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions%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/project/Project/Inheritdoc.cs/#L115", + "summary": "", + "description": "", + "remarks": "", + "conceptual": "", + "implements": "", + "example": "", + "seealso": [], + "id": "BuildFromProject_Inheritdoc_Issue9736_IJsonApiOptions", + "hideTitleType": false, + "hideSubtitle": false, + "isClass": true, + "inInterface": true, + "_disableToc": false, + "_disableNextArticle": true +} \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html.view.verified.json new file mode 100644 index 00000000000..74afad733c6 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html.view.verified.json @@ -0,0 +1,819 @@ +{ + "uid": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions", + "isEii": false, + "isExtensionMethod": false, + "parent": { + "uid": "BuildFromProject", + "isEii": false, + "isExtensionMethod": false, + "href": "BuildFromProject.html", + "name": [ + { + "lang": "csharp", + "value": "BuildFromProject" + }, + { + "lang": "vb", + "value": "BuildFromProject" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "BuildFromProject" + }, + { + "lang": "vb", + "value": "BuildFromProject" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject" + }, + { + "lang": "vb", + "value": "BuildFromProject" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ], + "level": 0 + }, + "children": [ + { + "inProperty": true, + "typePropertyName": "inProperty", + "id": "properties", + "children": [ + { + "uid": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks", + "isEii": false, + "isExtensionMethod": false, + "parent": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions", + "isExternal": false, + "name": [ + { + "lang": "csharp", + "value": "UseRelativeLinks" + }, + { + "lang": "vb", + "value": "UseRelativeLinks" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks" + }, + { + "lang": "vb", + "value": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ], + "syntax": { + "content": [ + { + "lang": "csharp", + "value": "public bool UseRelativeLinks { get; set; }" + }, + { + "lang": "vb", + "value": "Public Property UseRelativeLinks As Boolean" + } + ], + "parameters": [], + "return": null, + "propertyValue": { + "type": { + "uid": "System.Boolean", + "name": [ + { + "lang": "csharp", + "value": "bool" + }, + { + "lang": "vb", + "value": "Boolean" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "bool" + }, + { + "lang": "vb", + "value": "Boolean" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "bool" + }, + { + "lang": "vb", + "value": "Boolean" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ] + } + } + }, + "source": { + "remote": { + "path": "samples/seed/dotnet/project/Project/Inheritdoc.cs", + "branch": "main", + "repo": "https://github.com/dotnet/docfx" + }, + "id": "UseRelativeLinks", + "path": "dotnet/project/Project/Inheritdoc.cs", + "startLine": 144, + "endLine": 0 + }, + "assemblies": [ + "BuildFromProject" + ], + "namespace": "BuildFromProject", + "example": [ + "
options.UseRelativeLinks = true;
\n
{\n  \"type\": \"articles\",\n  \"id\": \"4309\",\n  \"relationships\": {\n     \"author\": {\n       \"links\": {\n         \"self\": \"/api/shopping/articles/4309/relationships/author\",\n         \"related\": \"/api/shopping/articles/4309/author\"\n       }\n     }\n  }\n}
\n" + ], + "overload": { + "uid": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks*", + "name": [ + { + "lang": "csharp", + "value": "UseRelativeLinks" + }, + { + "lang": "vb", + "value": "UseRelativeLinks" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks" + }, + { + "lang": "vb", + "value": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ], + "id": "BuildFromProject_Inheritdoc_Issue9736_JsonApiOptions_UseRelativeLinks_" + }, + "level": 0, + "implements": [ + { + "uid": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks", + "name": [ + { + "lang": "csharp", + "value": "UseRelativeLinks" + }, + { + "lang": "vb", + "value": "UseRelativeLinks" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks" + }, + { + "lang": "vb", + "value": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ] + } + ], + "type": "property", + "summary": "

Whether to use relative links for all resources. false by default.

\n", + "platform": null, + "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Inheritdoc_Issue9736_JsonApiOptions_UseRelativeLinks.md&value=---%0Auid%3A%20BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks%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/project/Project/Inheritdoc.cs/#L145", + "description": "", + "remarks": "", + "conceptual": "", + "seealso": [], + "id": "BuildFromProject_Inheritdoc_Issue9736_JsonApiOptions_UseRelativeLinks", + "hideTitleType": false, + "hideSubtitle": false + } + ] + } + ], + "langs": [ + "csharp", + "vb" + ], + "name": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736.JsonApiOptions" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736.JsonApiOptions" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736.JsonApiOptions" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736.JsonApiOptions" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions" + }, + { + "lang": "vb", + "value": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions" + } + ], + "type": "class", + "source": { + "remote": { + "path": "samples/seed/dotnet/project/Project/Inheritdoc.cs", + "branch": "main", + "repo": "https://github.com/dotnet/docfx" + }, + "id": "JsonApiOptions", + "path": "dotnet/project/Project/Inheritdoc.cs", + "startLine": 141, + "endLine": 0 + }, + "assemblies": [ + "BuildFromProject" + ], + "namespace": { + "uid": "BuildFromProject", + "isEii": false, + "isExtensionMethod": false, + "href": "BuildFromProject.html", + "name": [ + { + "lang": "csharp", + "value": "BuildFromProject" + }, + { + "lang": "vb", + "value": "BuildFromProject" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "BuildFromProject" + }, + { + "lang": "vb", + "value": "BuildFromProject" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject" + }, + { + "lang": "vb", + "value": "BuildFromProject" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ], + "level": 0 + }, + "syntax": { + "content": [ + { + "lang": "csharp", + "value": "public sealed class Inheritdoc.Issue9736.JsonApiOptions : Inheritdoc.Issue9736.IJsonApiOptions" + }, + { + "lang": "vb", + "value": "Public NotInheritable Class Inheritdoc.Issue9736.JsonApiOptions Implements Inheritdoc.Issue9736.IJsonApiOptions" + } + ] + }, + "inheritance": [ + { + "uid": "System.Object", + "isEii": false, + "isExtensionMethod": false, + "parent": "System", + "isExternal": true, + "href": "https://learn.microsoft.com/dotnet/api/system.object", + "name": [ + { + "lang": "csharp", + "value": "object" + }, + { + "lang": "vb", + "value": "Object" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "object" + }, + { + "lang": "vb", + "value": "Object" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "object" + }, + { + "lang": "vb", + "value": "Object" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ], + "level": 0, + "index": 0 + } + ], + "level": 1, + "implements": [ + { + "uid": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions", + "name": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736.IJsonApiOptions" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736.IJsonApiOptions" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736.IJsonApiOptions" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736.IJsonApiOptions" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions" + }, + { + "lang": "vb", + "value": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736.IJsonApiOptions" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736.IJsonApiOptions" + } + ] + } + ], + "inheritedMembers": [ + { + "uid": "System.Object.Equals(System.Object)", + "isEii": false, + "isExtensionMethod": false, + "parent": "System.Object", + "isExternal": true, + "href": "https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)", + "name": [ + { + "lang": "csharp", + "value": "Equals(object)" + }, + { + "lang": "vb", + "value": "Equals(Object)" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "object.Equals(object)" + }, + { + "lang": "vb", + "value": "Object.Equals(Object)" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "object.Equals(object)" + }, + { + "lang": "vb", + "value": "Object.Equals(Object)" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "Equals(object)" + }, + { + "lang": "vb", + "value": "Equals(Object)" + } + ], + "level": 0 + }, + { + "uid": "System.Object.Equals(System.Object,System.Object)", + "isEii": false, + "isExtensionMethod": false, + "parent": "System.Object", + "isExternal": true, + "href": "https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)", + "name": [ + { + "lang": "csharp", + "value": "Equals(object, object)" + }, + { + "lang": "vb", + "value": "Equals(Object, Object)" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "object.Equals(object, object)" + }, + { + "lang": "vb", + "value": "Object.Equals(Object, Object)" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "object.Equals(object, object)" + }, + { + "lang": "vb", + "value": "Object.Equals(Object, Object)" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "Equals(object, object)" + }, + { + "lang": "vb", + "value": "Equals(Object, Object)" + } + ], + "level": 0 + }, + { + "uid": "System.Object.GetHashCode", + "isEii": false, + "isExtensionMethod": false, + "parent": "System.Object", + "isExternal": true, + "href": "https://learn.microsoft.com/dotnet/api/system.object.gethashcode", + "name": [ + { + "lang": "csharp", + "value": "GetHashCode()" + }, + { + "lang": "vb", + "value": "GetHashCode()" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "object.GetHashCode()" + }, + { + "lang": "vb", + "value": "Object.GetHashCode()" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "object.GetHashCode()" + }, + { + "lang": "vb", + "value": "Object.GetHashCode()" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "GetHashCode()" + }, + { + "lang": "vb", + "value": "GetHashCode()" + } + ], + "level": 0 + }, + { + "uid": "System.Object.GetType", + "isEii": false, + "isExtensionMethod": false, + "parent": "System.Object", + "isExternal": true, + "href": "https://learn.microsoft.com/dotnet/api/system.object.gettype", + "name": [ + { + "lang": "csharp", + "value": "GetType()" + }, + { + "lang": "vb", + "value": "GetType()" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "object.GetType()" + }, + { + "lang": "vb", + "value": "Object.GetType()" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "object.GetType()" + }, + { + "lang": "vb", + "value": "Object.GetType()" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "GetType()" + }, + { + "lang": "vb", + "value": "GetType()" + } + ], + "level": 0 + }, + { + "uid": "System.Object.ReferenceEquals(System.Object,System.Object)", + "isEii": false, + "isExtensionMethod": false, + "parent": "System.Object", + "isExternal": true, + "href": "https://learn.microsoft.com/dotnet/api/system.object.referenceequals", + "name": [ + { + "lang": "csharp", + "value": "ReferenceEquals(object, object)" + }, + { + "lang": "vb", + "value": "ReferenceEquals(Object, Object)" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "object.ReferenceEquals(object, object)" + }, + { + "lang": "vb", + "value": "Object.ReferenceEquals(Object, Object)" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "object.ReferenceEquals(object, object)" + }, + { + "lang": "vb", + "value": "Object.ReferenceEquals(Object, Object)" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "ReferenceEquals(object, object)" + }, + { + "lang": "vb", + "value": "ReferenceEquals(Object, Object)" + } + ], + "level": 0 + }, + { + "uid": "System.Object.ToString", + "isEii": false, + "isExtensionMethod": false, + "parent": "System.Object", + "isExternal": true, + "href": "https://learn.microsoft.com/dotnet/api/system.object.tostring", + "name": [ + { + "lang": "csharp", + "value": "ToString()" + }, + { + "lang": "vb", + "value": "ToString()" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "object.ToString()" + }, + { + "lang": "vb", + "value": "Object.ToString()" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "object.ToString()" + }, + { + "lang": "vb", + "value": "Object.ToString()" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "ToString()" + }, + { + "lang": "vb", + "value": "ToString()" + } + ], + "level": 0 + } + ], + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "pdf": true, + "pdfTocPage": true, + "_key": "obj/api/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "api/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "_rel": "../", + "_tocKey": "~/obj/api/toc.yml", + "_tocPath": "api/toc.html", + "_tocRel": "toc.html", + "yamlmime": "ManagedReference", + "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Inheritdoc_Issue9736_JsonApiOptions.md&value=---%0Auid%3A%20BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions%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/project/Project/Inheritdoc.cs/#L142", + "summary": "", + "description": "", + "remarks": "", + "conceptual": "", + "example": "", + "seealso": [], + "id": "BuildFromProject_Inheritdoc_Issue9736_JsonApiOptions", + "hideTitleType": false, + "hideSubtitle": false, + "isClass": true, + "inClass": true, + "_disableToc": false, + "_disableNextArticle": true +} \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue9736.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue9736.html.view.verified.json new file mode 100644 index 00000000000..6135a144323 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue9736.html.view.verified.json @@ -0,0 +1,590 @@ +{ + "uid": "BuildFromProject.Inheritdoc.Issue9736", + "isEii": false, + "isExtensionMethod": false, + "parent": { + "uid": "BuildFromProject", + "isEii": false, + "isExtensionMethod": false, + "href": "BuildFromProject.html", + "name": [ + { + "lang": "csharp", + "value": "BuildFromProject" + }, + { + "lang": "vb", + "value": "BuildFromProject" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "BuildFromProject" + }, + { + "lang": "vb", + "value": "BuildFromProject" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject" + }, + { + "lang": "vb", + "value": "BuildFromProject" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ], + "level": 0 + }, + "children": [], + "langs": [ + "csharp", + "vb" + ], + "name": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject.Inheritdoc.Issue9736" + }, + { + "lang": "vb", + "value": "BuildFromProject.Inheritdoc.Issue9736" + } + ], + "type": "class", + "source": { + "remote": { + "path": "samples/seed/dotnet/project/Project/Inheritdoc.cs", + "branch": "main", + "repo": "https://github.com/dotnet/docfx" + }, + "id": "Issue9736", + "path": "dotnet/project/Project/Inheritdoc.cs", + "startLine": 112, + "endLine": 0 + }, + "assemblies": [ + "BuildFromProject" + ], + "namespace": { + "uid": "BuildFromProject", + "isEii": false, + "isExtensionMethod": false, + "href": "BuildFromProject.html", + "name": [ + { + "lang": "csharp", + "value": "BuildFromProject" + }, + { + "lang": "vb", + "value": "BuildFromProject" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "BuildFromProject" + }, + { + "lang": "vb", + "value": "BuildFromProject" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject" + }, + { + "lang": "vb", + "value": "BuildFromProject" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ], + "level": 0 + }, + "syntax": { + "content": [ + { + "lang": "csharp", + "value": "public class Inheritdoc.Issue9736" + }, + { + "lang": "vb", + "value": "Public Class Inheritdoc.Issue9736" + } + ] + }, + "inheritance": [ + { + "uid": "System.Object", + "isEii": false, + "isExtensionMethod": false, + "parent": "System", + "isExternal": true, + "href": "https://learn.microsoft.com/dotnet/api/system.object", + "name": [ + { + "lang": "csharp", + "value": "object" + }, + { + "lang": "vb", + "value": "Object" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "object" + }, + { + "lang": "vb", + "value": "Object" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "object" + }, + { + "lang": "vb", + "value": "Object" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ], + "level": 0, + "index": 0 + } + ], + "level": 1, + "inheritedMembers": [ + { + "uid": "System.Object.Equals(System.Object)", + "isEii": false, + "isExtensionMethod": false, + "parent": "System.Object", + "isExternal": true, + "href": "https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)", + "name": [ + { + "lang": "csharp", + "value": "Equals(object)" + }, + { + "lang": "vb", + "value": "Equals(Object)" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "object.Equals(object)" + }, + { + "lang": "vb", + "value": "Object.Equals(Object)" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "object.Equals(object)" + }, + { + "lang": "vb", + "value": "Object.Equals(Object)" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "Equals(object)" + }, + { + "lang": "vb", + "value": "Equals(Object)" + } + ], + "level": 0 + }, + { + "uid": "System.Object.Equals(System.Object,System.Object)", + "isEii": false, + "isExtensionMethod": false, + "parent": "System.Object", + "isExternal": true, + "href": "https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)", + "name": [ + { + "lang": "csharp", + "value": "Equals(object, object)" + }, + { + "lang": "vb", + "value": "Equals(Object, Object)" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "object.Equals(object, object)" + }, + { + "lang": "vb", + "value": "Object.Equals(Object, Object)" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "object.Equals(object, object)" + }, + { + "lang": "vb", + "value": "Object.Equals(Object, Object)" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "Equals(object, object)" + }, + { + "lang": "vb", + "value": "Equals(Object, Object)" + } + ], + "level": 0 + }, + { + "uid": "System.Object.GetHashCode", + "isEii": false, + "isExtensionMethod": false, + "parent": "System.Object", + "isExternal": true, + "href": "https://learn.microsoft.com/dotnet/api/system.object.gethashcode", + "name": [ + { + "lang": "csharp", + "value": "GetHashCode()" + }, + { + "lang": "vb", + "value": "GetHashCode()" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "object.GetHashCode()" + }, + { + "lang": "vb", + "value": "Object.GetHashCode()" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "object.GetHashCode()" + }, + { + "lang": "vb", + "value": "Object.GetHashCode()" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "GetHashCode()" + }, + { + "lang": "vb", + "value": "GetHashCode()" + } + ], + "level": 0 + }, + { + "uid": "System.Object.GetType", + "isEii": false, + "isExtensionMethod": false, + "parent": "System.Object", + "isExternal": true, + "href": "https://learn.microsoft.com/dotnet/api/system.object.gettype", + "name": [ + { + "lang": "csharp", + "value": "GetType()" + }, + { + "lang": "vb", + "value": "GetType()" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "object.GetType()" + }, + { + "lang": "vb", + "value": "Object.GetType()" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "object.GetType()" + }, + { + "lang": "vb", + "value": "Object.GetType()" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "GetType()" + }, + { + "lang": "vb", + "value": "GetType()" + } + ], + "level": 0 + }, + { + "uid": "System.Object.MemberwiseClone", + "isEii": false, + "isExtensionMethod": false, + "parent": "System.Object", + "isExternal": true, + "href": "https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone", + "name": [ + { + "lang": "csharp", + "value": "MemberwiseClone()" + }, + { + "lang": "vb", + "value": "MemberwiseClone()" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "object.MemberwiseClone()" + }, + { + "lang": "vb", + "value": "Object.MemberwiseClone()" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "object.MemberwiseClone()" + }, + { + "lang": "vb", + "value": "Object.MemberwiseClone()" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "MemberwiseClone()" + }, + { + "lang": "vb", + "value": "MemberwiseClone()" + } + ], + "level": 0 + }, + { + "uid": "System.Object.ReferenceEquals(System.Object,System.Object)", + "isEii": false, + "isExtensionMethod": false, + "parent": "System.Object", + "isExternal": true, + "href": "https://learn.microsoft.com/dotnet/api/system.object.referenceequals", + "name": [ + { + "lang": "csharp", + "value": "ReferenceEquals(object, object)" + }, + { + "lang": "vb", + "value": "ReferenceEquals(Object, Object)" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "object.ReferenceEquals(object, object)" + }, + { + "lang": "vb", + "value": "Object.ReferenceEquals(Object, Object)" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "object.ReferenceEquals(object, object)" + }, + { + "lang": "vb", + "value": "Object.ReferenceEquals(Object, Object)" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "ReferenceEquals(object, object)" + }, + { + "lang": "vb", + "value": "ReferenceEquals(Object, Object)" + } + ], + "level": 0 + }, + { + "uid": "System.Object.ToString", + "isEii": false, + "isExtensionMethod": false, + "parent": "System.Object", + "isExternal": true, + "href": "https://learn.microsoft.com/dotnet/api/system.object.tostring", + "name": [ + { + "lang": "csharp", + "value": "ToString()" + }, + { + "lang": "vb", + "value": "ToString()" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "object.ToString()" + }, + { + "lang": "vb", + "value": "Object.ToString()" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "object.ToString()" + }, + { + "lang": "vb", + "value": "Object.ToString()" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "ToString()" + }, + { + "lang": "vb", + "value": "ToString()" + } + ], + "level": 0 + } + ], + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "pdf": true, + "pdfTocPage": true, + "_key": "obj/api/BuildFromProject.Inheritdoc.Issue9736.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "api/BuildFromProject.Inheritdoc.Issue9736.html", + "_rel": "../", + "_tocKey": "~/obj/api/toc.yml", + "_tocPath": "api/toc.html", + "_tocRel": "toc.html", + "yamlmime": "ManagedReference", + "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Inheritdoc_Issue9736.md&value=---%0Auid%3A%20BuildFromProject.Inheritdoc.Issue9736%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/project/Project/Inheritdoc.cs/#L113", + "summary": "", + "description": "", + "remarks": "", + "conceptual": "", + "implements": "", + "example": "", + "seealso": [], + "id": "BuildFromProject_Inheritdoc_Issue9736", + "hideTitleType": false, + "hideSubtitle": false, + "isClass": true, + "inClass": true, + "_disableToc": false, + "_disableNextArticle": true +} \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.html.view.verified.json index 329625210cb..4817e7b3dc4 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.html.view.verified.json @@ -854,6 +854,130 @@ "hideTitleType": false, "hideSubtitle": false }, + { + "uid": "BuildFromProject.Inheritdoc.Issue9736", + "isExtensionMethod": false, + "href": "BuildFromProject.Inheritdoc.html", + "name": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject.Inheritdoc.Issue9736" + }, + { + "lang": "vb", + "value": "BuildFromProject.Inheritdoc.Issue9736" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736" + } + ], + "level": 0, + "summary": "", + "type": "class", + "platform": null, + "isEii": false, + "docurl": "", + "sourceurl": "", + "description": "", + "remarks": "", + "conceptual": "", + "syntax": "", + "implements": "", + "example": "", + "seealso": [], + "id": "BuildFromProject_Inheritdoc_Issue9736", + "hideTitleType": false, + "hideSubtitle": false + }, + { + "uid": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions", + "isExtensionMethod": false, + "href": "BuildFromProject.Inheritdoc.html", + "name": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736.JsonApiOptions" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736.JsonApiOptions" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736.JsonApiOptions" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736.JsonApiOptions" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions" + }, + { + "lang": "vb", + "value": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736.JsonApiOptions" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736.JsonApiOptions" + } + ], + "level": 0, + "summary": "", + "type": "class", + "platform": null, + "isEii": false, + "docurl": "", + "sourceurl": "", + "description": "", + "remarks": "", + "conceptual": "", + "syntax": "", + "implements": "", + "example": "", + "seealso": [], + "id": "BuildFromProject_Inheritdoc_Issue9736_JsonApiOptions", + "hideTitleType": false, + "hideSubtitle": false + }, { "uid": "BuildFromProject.Issue8725", "isExtensionMethod": false, @@ -1117,6 +1241,69 @@ "id": "BuildFromProject_IInheritdoc", "hideTitleType": false, "hideSubtitle": false + }, + { + "uid": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions", + "isExtensionMethod": false, + "parent": "BuildFromProject", + "href": "BuildFromProject.Inheritdoc.html", + "name": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736.IJsonApiOptions" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736.IJsonApiOptions" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736.IJsonApiOptions" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736.IJsonApiOptions" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions" + }, + { + "lang": "vb", + "value": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "Inheritdoc.Issue9736.IJsonApiOptions" + }, + { + "lang": "vb", + "value": "Inheritdoc.Issue9736.IJsonApiOptions" + } + ], + "level": 0, + "summary": "", + "type": "interface", + "platform": null, + "isEii": false, + "docurl": "", + "sourceurl": "", + "description": "", + "remarks": "", + "conceptual": "", + "syntax": "", + "implements": "", + "example": "", + "seealso": [], + "id": "BuildFromProject_Inheritdoc_Issue9736_IJsonApiOptions", + "hideTitleType": false, + "hideSubtitle": false } ] }, diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.ICatExtension.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.ICatExtension.html.view.verified.json index f750baa946d..9c053f9081b 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.ICatExtension.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.ICatExtension.html.view.verified.json @@ -612,7 +612,7 @@ ], "level": 0 }, - "summary": "

It's the class that contains ICat interface's extension method.

\n

This class must be public and static.

Also it shouldn't be a geneic class

\n", + "summary": "

It's the class that contains ICat interface's extension method.

\n

This class must be public and static.

\n

Also it shouldn't be a geneic class

\n", "example": [], "syntax": { "content": [ @@ -1041,7 +1041,7 @@ "yamlmime": "ManagedReference", "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_ICatExtension.md&value=---%0Auid%3A%20CatLibrary.ICatExtension%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/#L333", - "description": "It's the class that contains ICat interface's extension method. This class must be public and static.Also it shouldn't be a geneic class", + "description": "It's the class that contains ICat interface's extension method. This class must be public and static. Also it shouldn't be a geneic class", "remarks": "", "conceptual": "", "implements": "", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.html.view.verified.json index 2c984888109..94eb058cb00 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.html.view.verified.json @@ -310,7 +310,7 @@ } ], "level": 0, - "summary": "

It's the class that contains ICat interface's extension method.

\n

This class must be public and static.

Also it shouldn't be a geneic class

\n", + "summary": "

It's the class that contains ICat interface's extension method.

\n

This class must be public and static.

\n

Also it shouldn't be a geneic class

\n", "type": "class", "platform": null, "isEii": false, diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.html.view.verified.json index 63d9153bd40..5e35a908255 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.html.view.verified.json @@ -305,6 +305,39 @@ "items": [], "leaf": true }, + { + "name": "Inheritdoc.Issue9736", + "href": "BuildFromProject.Inheritdoc.Issue9736.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue9736.html", + "topicUid": "BuildFromProject.Inheritdoc.Issue9736", + "type": "Class", + "tocHref": null, + "level": 3, + "items": [], + "leaf": true + }, + { + "name": "Inheritdoc.Issue9736.IJsonApiOptions", + "href": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "topicUid": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions", + "type": "Interface", + "tocHref": null, + "level": 3, + "items": [], + "leaf": true + }, + { + "name": "Inheritdoc.Issue9736.JsonApiOptions", + "href": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "topicUid": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions", + "type": "Class", + "tocHref": null, + "level": 3, + "items": [], + "leaf": true + }, { "name": "Issue8725", "href": "BuildFromProject.Issue8725.html", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.json.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.json.view.verified.json index 89685ab92af..28e8e4ff916 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.json.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.json.view.verified.json @@ -1,3 +1,3 @@ { - "content": "{\"order\":100,\"items\":[{\"name\":\"BuildFromAssembly\",\"href\":\"BuildFromAssembly.html\",\"topicHref\":\"BuildFromAssembly.html\",\"topicUid\":\"BuildFromAssembly\",\"type\":\"Namespace\",\"items\":[{\"name\":\"Class1\",\"href\":\"BuildFromAssembly.Class1.html\",\"topicHref\":\"BuildFromAssembly.Class1.html\",\"topicUid\":\"BuildFromAssembly.Class1\",\"type\":\"Class\"},{\"name\":\"Issue5432\",\"href\":\"BuildFromAssembly.Issue5432.html\",\"topicHref\":\"BuildFromAssembly.Issue5432.html\",\"topicUid\":\"BuildFromAssembly.Issue5432\",\"type\":\"Struct\"}]},{\"name\":\"BuildFromCSharpSourceCode\",\"href\":\"BuildFromCSharpSourceCode.html\",\"topicHref\":\"BuildFromCSharpSourceCode.html\",\"topicUid\":\"BuildFromCSharpSourceCode\",\"type\":\"Namespace\",\"items\":[{\"name\":\"CSharp\",\"href\":\"BuildFromCSharpSourceCode.CSharp.html\",\"topicHref\":\"BuildFromCSharpSourceCode.CSharp.html\",\"topicUid\":\"BuildFromCSharpSourceCode.CSharp\",\"type\":\"Class\"}]},{\"name\":\"BuildFromProject\",\"href\":\"BuildFromProject.html\",\"topicHref\":\"BuildFromProject.html\",\"topicUid\":\"BuildFromProject\",\"type\":\"Namespace\",\"items\":[{\"name\":\"Issue8540\",\"href\":\"BuildFromProject.Issue8540.html\",\"topicHref\":\"BuildFromProject.Issue8540.html\",\"topicUid\":\"BuildFromProject.Issue8540\",\"type\":\"Namespace\",\"items\":[{\"name\":\"A\",\"href\":\"BuildFromProject.Issue8540.A.html\",\"topicHref\":\"BuildFromProject.Issue8540.A.html\",\"topicUid\":\"BuildFromProject.Issue8540.A\",\"type\":\"Namespace\",\"items\":[{\"name\":\"A\",\"href\":\"BuildFromProject.Issue8540.A.A.html\",\"topicHref\":\"BuildFromProject.Issue8540.A.A.html\",\"topicUid\":\"BuildFromProject.Issue8540.A.A\",\"type\":\"Class\"}]},{\"name\":\"B\",\"href\":\"BuildFromProject.Issue8540.B.html\",\"topicHref\":\"BuildFromProject.Issue8540.B.html\",\"topicUid\":\"BuildFromProject.Issue8540.B\",\"type\":\"Namespace\",\"items\":[{\"name\":\"B\",\"href\":\"BuildFromProject.Issue8540.B.B.html\",\"topicHref\":\"BuildFromProject.Issue8540.B.B.html\",\"topicUid\":\"BuildFromProject.Issue8540.B.B\",\"type\":\"Class\"}]}]},{\"name\":\"Class1\",\"href\":\"BuildFromProject.Class1.html\",\"topicHref\":\"BuildFromProject.Class1.html\",\"topicUid\":\"BuildFromProject.Class1\",\"type\":\"Class\"},{\"name\":\"Class1.IIssue8948\",\"href\":\"BuildFromProject.Class1.IIssue8948.html\",\"topicHref\":\"BuildFromProject.Class1.IIssue8948.html\",\"topicUid\":\"BuildFromProject.Class1.IIssue8948\",\"type\":\"Interface\"},{\"name\":\"Class1.Issue8665\",\"href\":\"BuildFromProject.Class1.Issue8665.html\",\"topicHref\":\"BuildFromProject.Class1.Issue8665.html\",\"topicUid\":\"BuildFromProject.Class1.Issue8665\",\"type\":\"Class\"},{\"name\":\"Class1.Issue8696Attribute\",\"href\":\"BuildFromProject.Class1.Issue8696Attribute.html\",\"topicHref\":\"BuildFromProject.Class1.Issue8696Attribute.html\",\"topicUid\":\"BuildFromProject.Class1.Issue8696Attribute\",\"type\":\"Class\"},{\"name\":\"Class1.Issue8948\",\"href\":\"BuildFromProject.Class1.Issue8948.html\",\"topicHref\":\"BuildFromProject.Class1.Issue8948.html\",\"topicUid\":\"BuildFromProject.Class1.Issue8948\",\"type\":\"Class\"},{\"name\":\"Class1.Issue9260\",\"href\":\"BuildFromProject.Class1.Issue9260.html\",\"topicHref\":\"BuildFromProject.Class1.Issue9260.html\",\"topicUid\":\"BuildFromProject.Class1.Issue9260\",\"type\":\"Enum\"},{\"name\":\"Class1.Test\",\"href\":\"BuildFromProject.Class1.Test-1.html\",\"topicHref\":\"BuildFromProject.Class1.Test-1.html\",\"topicUid\":\"BuildFromProject.Class1.Test`1\",\"type\":\"Class\"},{\"name\":\"Dog\",\"href\":\"BuildFromProject.Dog.html\",\"topicHref\":\"BuildFromProject.Dog.html\",\"topicUid\":\"BuildFromProject.Dog\",\"type\":\"Class\"},{\"name\":\"IInheritdoc\",\"href\":\"BuildFromProject.IInheritdoc.html\",\"topicHref\":\"BuildFromProject.IInheritdoc.html\",\"topicUid\":\"BuildFromProject.IInheritdoc\",\"type\":\"Interface\"},{\"name\":\"Inheritdoc\",\"href\":\"BuildFromProject.Inheritdoc.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.html\",\"topicUid\":\"BuildFromProject.Inheritdoc\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue6366\",\"href\":\"BuildFromProject.Inheritdoc.Issue6366.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue6366.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue6366\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue6366.Class1\",\"href\":\"BuildFromProject.Inheritdoc.Issue6366.Class1-1.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue6366.Class1-1.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue6366.Class1`1\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue6366.Class2\",\"href\":\"BuildFromProject.Inheritdoc.Issue6366.Class2.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue6366.Class2.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue6366.Class2\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue7035\",\"href\":\"BuildFromProject.Inheritdoc.Issue7035.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue7035.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue7035\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue7484\",\"href\":\"BuildFromProject.Inheritdoc.Issue7484.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue7484.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue7484\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue8101\",\"href\":\"BuildFromProject.Inheritdoc.Issue8101.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue8101.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue8101\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue8129\",\"href\":\"BuildFromProject.Inheritdoc.Issue8129.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue8129.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue8129\",\"type\":\"Struct\"},{\"name\":\"Issue8725\",\"href\":\"BuildFromProject.Issue8725.html\",\"topicHref\":\"BuildFromProject.Issue8725.html\",\"topicUid\":\"BuildFromProject.Issue8725\",\"type\":\"Class\"}]},{\"name\":\"BuildFromVBSourceCode\",\"href\":\"BuildFromVBSourceCode.html\",\"topicHref\":\"BuildFromVBSourceCode.html\",\"topicUid\":\"BuildFromVBSourceCode\",\"type\":\"Namespace\",\"items\":[{\"name\":\"BaseClass1\",\"href\":\"BuildFromVBSourceCode.BaseClass1.html\",\"topicHref\":\"BuildFromVBSourceCode.BaseClass1.html\",\"topicUid\":\"BuildFromVBSourceCode.BaseClass1\",\"type\":\"Class\"},{\"name\":\"Class1\",\"href\":\"BuildFromVBSourceCode.Class1.html\",\"topicHref\":\"BuildFromVBSourceCode.Class1.html\",\"topicUid\":\"BuildFromVBSourceCode.Class1\",\"type\":\"Class\"}]},{\"name\":\"CatLibrary\",\"href\":\"CatLibrary.html\",\"topicHref\":\"CatLibrary.html\",\"topicUid\":\"CatLibrary\",\"type\":\"Namespace\",\"items\":[{\"name\":\"Core\",\"href\":\"CatLibrary.Core.html\",\"topicHref\":\"CatLibrary.Core.html\",\"topicUid\":\"CatLibrary.Core\",\"type\":\"Namespace\",\"items\":[{\"name\":\"ContainersRefType\",\"href\":\"CatLibrary.Core.ContainersRefType.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType\",\"type\":\"Struct\"},{\"name\":\"ContainersRefType.ColorType\",\"href\":\"CatLibrary.Core.ContainersRefType.ColorType.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ColorType.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ColorType\",\"type\":\"Enum\"},{\"name\":\"ContainersRefType.ContainersRefTypeChild\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild\",\"type\":\"Class\"},{\"name\":\"ContainersRefType.ContainersRefTypeChildInterface\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface\",\"type\":\"Interface\"},{\"name\":\"ContainersRefType.ContainersRefTypeDelegate\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate\",\"type\":\"Delegate\"},{\"name\":\"ExplicitLayoutClass\",\"href\":\"CatLibrary.Core.ExplicitLayoutClass.html\",\"topicHref\":\"CatLibrary.Core.ExplicitLayoutClass.html\",\"topicUid\":\"CatLibrary.Core.ExplicitLayoutClass\",\"type\":\"Class\"},{\"name\":\"Issue231\",\"href\":\"CatLibrary.Core.Issue231.html\",\"topicHref\":\"CatLibrary.Core.Issue231.html\",\"topicUid\":\"CatLibrary.Core.Issue231\",\"type\":\"Class\"}]},{\"name\":\"CatException\",\"href\":\"CatLibrary.CatException-1.html\",\"topicHref\":\"CatLibrary.CatException-1.html\",\"topicUid\":\"CatLibrary.CatException`1\",\"type\":\"Class\"},{\"name\":\"Cat\",\"href\":\"CatLibrary.Cat-2.html\",\"topicHref\":\"CatLibrary.Cat-2.html\",\"topicUid\":\"CatLibrary.Cat`2\",\"type\":\"Class\"},{\"name\":\"Complex\",\"href\":\"CatLibrary.Complex-2.html\",\"topicHref\":\"CatLibrary.Complex-2.html\",\"topicUid\":\"CatLibrary.Complex`2\",\"type\":\"Class\"},{\"name\":\"FakeDelegate\",\"href\":\"CatLibrary.FakeDelegate-1.html\",\"topicHref\":\"CatLibrary.FakeDelegate-1.html\",\"topicUid\":\"CatLibrary.FakeDelegate`1\",\"type\":\"Delegate\"},{\"name\":\"IAnimal\",\"href\":\"CatLibrary.IAnimal.html\",\"topicHref\":\"CatLibrary.IAnimal.html\",\"topicUid\":\"CatLibrary.IAnimal\",\"type\":\"Interface\"},{\"name\":\"ICat\",\"href\":\"CatLibrary.ICat.html\",\"topicHref\":\"CatLibrary.ICat.html\",\"topicUid\":\"CatLibrary.ICat\",\"type\":\"Interface\"},{\"name\":\"ICatExtension\",\"href\":\"CatLibrary.ICatExtension.html\",\"topicHref\":\"CatLibrary.ICatExtension.html\",\"topicUid\":\"CatLibrary.ICatExtension\",\"type\":\"Class\"},{\"name\":\"MRefDelegate\",\"href\":\"CatLibrary.MRefDelegate-3.html\",\"topicHref\":\"CatLibrary.MRefDelegate-3.html\",\"topicUid\":\"CatLibrary.MRefDelegate`3\",\"type\":\"Delegate\"},{\"name\":\"MRefNormalDelegate\",\"href\":\"CatLibrary.MRefNormalDelegate.html\",\"topicHref\":\"CatLibrary.MRefNormalDelegate.html\",\"topicUid\":\"CatLibrary.MRefNormalDelegate\",\"type\":\"Delegate\"},{\"name\":\"Tom\",\"href\":\"CatLibrary.Tom.html\",\"topicHref\":\"CatLibrary.Tom.html\",\"topicUid\":\"CatLibrary.Tom\",\"type\":\"Class\"},{\"name\":\"TomFromBaseClass\",\"href\":\"CatLibrary.TomFromBaseClass.html\",\"topicHref\":\"CatLibrary.TomFromBaseClass.html\",\"topicUid\":\"CatLibrary.TomFromBaseClass\",\"type\":\"Class\"}]},{\"name\":\"MRef.Demo.Enumeration\",\"href\":\"MRef.Demo.Enumeration.html\",\"topicHref\":\"MRef.Demo.Enumeration.html\",\"topicUid\":\"MRef.Demo.Enumeration\",\"type\":\"Namespace\",\"items\":[{\"name\":\"ColorType\",\"href\":\"MRef.Demo.Enumeration.ColorType.html\",\"topicHref\":\"MRef.Demo.Enumeration.ColorType.html\",\"topicUid\":\"MRef.Demo.Enumeration.ColorType\",\"type\":\"Enum\"}]}],\"memberLayout\":\"SamePage\",\"pdf\":true,\"pdfTocPage\":true}" + "content": "{\"order\":100,\"items\":[{\"name\":\"BuildFromAssembly\",\"href\":\"BuildFromAssembly.html\",\"topicHref\":\"BuildFromAssembly.html\",\"topicUid\":\"BuildFromAssembly\",\"type\":\"Namespace\",\"items\":[{\"name\":\"Class1\",\"href\":\"BuildFromAssembly.Class1.html\",\"topicHref\":\"BuildFromAssembly.Class1.html\",\"topicUid\":\"BuildFromAssembly.Class1\",\"type\":\"Class\"},{\"name\":\"Issue5432\",\"href\":\"BuildFromAssembly.Issue5432.html\",\"topicHref\":\"BuildFromAssembly.Issue5432.html\",\"topicUid\":\"BuildFromAssembly.Issue5432\",\"type\":\"Struct\"}]},{\"name\":\"BuildFromCSharpSourceCode\",\"href\":\"BuildFromCSharpSourceCode.html\",\"topicHref\":\"BuildFromCSharpSourceCode.html\",\"topicUid\":\"BuildFromCSharpSourceCode\",\"type\":\"Namespace\",\"items\":[{\"name\":\"CSharp\",\"href\":\"BuildFromCSharpSourceCode.CSharp.html\",\"topicHref\":\"BuildFromCSharpSourceCode.CSharp.html\",\"topicUid\":\"BuildFromCSharpSourceCode.CSharp\",\"type\":\"Class\"}]},{\"name\":\"BuildFromProject\",\"href\":\"BuildFromProject.html\",\"topicHref\":\"BuildFromProject.html\",\"topicUid\":\"BuildFromProject\",\"type\":\"Namespace\",\"items\":[{\"name\":\"Issue8540\",\"href\":\"BuildFromProject.Issue8540.html\",\"topicHref\":\"BuildFromProject.Issue8540.html\",\"topicUid\":\"BuildFromProject.Issue8540\",\"type\":\"Namespace\",\"items\":[{\"name\":\"A\",\"href\":\"BuildFromProject.Issue8540.A.html\",\"topicHref\":\"BuildFromProject.Issue8540.A.html\",\"topicUid\":\"BuildFromProject.Issue8540.A\",\"type\":\"Namespace\",\"items\":[{\"name\":\"A\",\"href\":\"BuildFromProject.Issue8540.A.A.html\",\"topicHref\":\"BuildFromProject.Issue8540.A.A.html\",\"topicUid\":\"BuildFromProject.Issue8540.A.A\",\"type\":\"Class\"}]},{\"name\":\"B\",\"href\":\"BuildFromProject.Issue8540.B.html\",\"topicHref\":\"BuildFromProject.Issue8540.B.html\",\"topicUid\":\"BuildFromProject.Issue8540.B\",\"type\":\"Namespace\",\"items\":[{\"name\":\"B\",\"href\":\"BuildFromProject.Issue8540.B.B.html\",\"topicHref\":\"BuildFromProject.Issue8540.B.B.html\",\"topicUid\":\"BuildFromProject.Issue8540.B.B\",\"type\":\"Class\"}]}]},{\"name\":\"Class1\",\"href\":\"BuildFromProject.Class1.html\",\"topicHref\":\"BuildFromProject.Class1.html\",\"topicUid\":\"BuildFromProject.Class1\",\"type\":\"Class\"},{\"name\":\"Class1.IIssue8948\",\"href\":\"BuildFromProject.Class1.IIssue8948.html\",\"topicHref\":\"BuildFromProject.Class1.IIssue8948.html\",\"topicUid\":\"BuildFromProject.Class1.IIssue8948\",\"type\":\"Interface\"},{\"name\":\"Class1.Issue8665\",\"href\":\"BuildFromProject.Class1.Issue8665.html\",\"topicHref\":\"BuildFromProject.Class1.Issue8665.html\",\"topicUid\":\"BuildFromProject.Class1.Issue8665\",\"type\":\"Class\"},{\"name\":\"Class1.Issue8696Attribute\",\"href\":\"BuildFromProject.Class1.Issue8696Attribute.html\",\"topicHref\":\"BuildFromProject.Class1.Issue8696Attribute.html\",\"topicUid\":\"BuildFromProject.Class1.Issue8696Attribute\",\"type\":\"Class\"},{\"name\":\"Class1.Issue8948\",\"href\":\"BuildFromProject.Class1.Issue8948.html\",\"topicHref\":\"BuildFromProject.Class1.Issue8948.html\",\"topicUid\":\"BuildFromProject.Class1.Issue8948\",\"type\":\"Class\"},{\"name\":\"Class1.Issue9260\",\"href\":\"BuildFromProject.Class1.Issue9260.html\",\"topicHref\":\"BuildFromProject.Class1.Issue9260.html\",\"topicUid\":\"BuildFromProject.Class1.Issue9260\",\"type\":\"Enum\"},{\"name\":\"Class1.Test\",\"href\":\"BuildFromProject.Class1.Test-1.html\",\"topicHref\":\"BuildFromProject.Class1.Test-1.html\",\"topicUid\":\"BuildFromProject.Class1.Test`1\",\"type\":\"Class\"},{\"name\":\"Dog\",\"href\":\"BuildFromProject.Dog.html\",\"topicHref\":\"BuildFromProject.Dog.html\",\"topicUid\":\"BuildFromProject.Dog\",\"type\":\"Class\"},{\"name\":\"IInheritdoc\",\"href\":\"BuildFromProject.IInheritdoc.html\",\"topicHref\":\"BuildFromProject.IInheritdoc.html\",\"topicUid\":\"BuildFromProject.IInheritdoc\",\"type\":\"Interface\"},{\"name\":\"Inheritdoc\",\"href\":\"BuildFromProject.Inheritdoc.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.html\",\"topicUid\":\"BuildFromProject.Inheritdoc\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue6366\",\"href\":\"BuildFromProject.Inheritdoc.Issue6366.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue6366.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue6366\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue6366.Class1\",\"href\":\"BuildFromProject.Inheritdoc.Issue6366.Class1-1.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue6366.Class1-1.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue6366.Class1`1\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue6366.Class2\",\"href\":\"BuildFromProject.Inheritdoc.Issue6366.Class2.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue6366.Class2.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue6366.Class2\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue7035\",\"href\":\"BuildFromProject.Inheritdoc.Issue7035.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue7035.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue7035\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue7484\",\"href\":\"BuildFromProject.Inheritdoc.Issue7484.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue7484.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue7484\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue8101\",\"href\":\"BuildFromProject.Inheritdoc.Issue8101.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue8101.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue8101\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue8129\",\"href\":\"BuildFromProject.Inheritdoc.Issue8129.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue8129.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue8129\",\"type\":\"Struct\"},{\"name\":\"Inheritdoc.Issue9736\",\"href\":\"BuildFromProject.Inheritdoc.Issue9736.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue9736.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue9736\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue9736.IJsonApiOptions\",\"href\":\"BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions\",\"type\":\"Interface\"},{\"name\":\"Inheritdoc.Issue9736.JsonApiOptions\",\"href\":\"BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions\",\"type\":\"Class\"},{\"name\":\"Issue8725\",\"href\":\"BuildFromProject.Issue8725.html\",\"topicHref\":\"BuildFromProject.Issue8725.html\",\"topicUid\":\"BuildFromProject.Issue8725\",\"type\":\"Class\"}]},{\"name\":\"BuildFromVBSourceCode\",\"href\":\"BuildFromVBSourceCode.html\",\"topicHref\":\"BuildFromVBSourceCode.html\",\"topicUid\":\"BuildFromVBSourceCode\",\"type\":\"Namespace\",\"items\":[{\"name\":\"BaseClass1\",\"href\":\"BuildFromVBSourceCode.BaseClass1.html\",\"topicHref\":\"BuildFromVBSourceCode.BaseClass1.html\",\"topicUid\":\"BuildFromVBSourceCode.BaseClass1\",\"type\":\"Class\"},{\"name\":\"Class1\",\"href\":\"BuildFromVBSourceCode.Class1.html\",\"topicHref\":\"BuildFromVBSourceCode.Class1.html\",\"topicUid\":\"BuildFromVBSourceCode.Class1\",\"type\":\"Class\"}]},{\"name\":\"CatLibrary\",\"href\":\"CatLibrary.html\",\"topicHref\":\"CatLibrary.html\",\"topicUid\":\"CatLibrary\",\"type\":\"Namespace\",\"items\":[{\"name\":\"Core\",\"href\":\"CatLibrary.Core.html\",\"topicHref\":\"CatLibrary.Core.html\",\"topicUid\":\"CatLibrary.Core\",\"type\":\"Namespace\",\"items\":[{\"name\":\"ContainersRefType\",\"href\":\"CatLibrary.Core.ContainersRefType.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType\",\"type\":\"Struct\"},{\"name\":\"ContainersRefType.ColorType\",\"href\":\"CatLibrary.Core.ContainersRefType.ColorType.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ColorType.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ColorType\",\"type\":\"Enum\"},{\"name\":\"ContainersRefType.ContainersRefTypeChild\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild\",\"type\":\"Class\"},{\"name\":\"ContainersRefType.ContainersRefTypeChildInterface\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface\",\"type\":\"Interface\"},{\"name\":\"ContainersRefType.ContainersRefTypeDelegate\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate\",\"type\":\"Delegate\"},{\"name\":\"ExplicitLayoutClass\",\"href\":\"CatLibrary.Core.ExplicitLayoutClass.html\",\"topicHref\":\"CatLibrary.Core.ExplicitLayoutClass.html\",\"topicUid\":\"CatLibrary.Core.ExplicitLayoutClass\",\"type\":\"Class\"},{\"name\":\"Issue231\",\"href\":\"CatLibrary.Core.Issue231.html\",\"topicHref\":\"CatLibrary.Core.Issue231.html\",\"topicUid\":\"CatLibrary.Core.Issue231\",\"type\":\"Class\"}]},{\"name\":\"CatException\",\"href\":\"CatLibrary.CatException-1.html\",\"topicHref\":\"CatLibrary.CatException-1.html\",\"topicUid\":\"CatLibrary.CatException`1\",\"type\":\"Class\"},{\"name\":\"Cat\",\"href\":\"CatLibrary.Cat-2.html\",\"topicHref\":\"CatLibrary.Cat-2.html\",\"topicUid\":\"CatLibrary.Cat`2\",\"type\":\"Class\"},{\"name\":\"Complex\",\"href\":\"CatLibrary.Complex-2.html\",\"topicHref\":\"CatLibrary.Complex-2.html\",\"topicUid\":\"CatLibrary.Complex`2\",\"type\":\"Class\"},{\"name\":\"FakeDelegate\",\"href\":\"CatLibrary.FakeDelegate-1.html\",\"topicHref\":\"CatLibrary.FakeDelegate-1.html\",\"topicUid\":\"CatLibrary.FakeDelegate`1\",\"type\":\"Delegate\"},{\"name\":\"IAnimal\",\"href\":\"CatLibrary.IAnimal.html\",\"topicHref\":\"CatLibrary.IAnimal.html\",\"topicUid\":\"CatLibrary.IAnimal\",\"type\":\"Interface\"},{\"name\":\"ICat\",\"href\":\"CatLibrary.ICat.html\",\"topicHref\":\"CatLibrary.ICat.html\",\"topicUid\":\"CatLibrary.ICat\",\"type\":\"Interface\"},{\"name\":\"ICatExtension\",\"href\":\"CatLibrary.ICatExtension.html\",\"topicHref\":\"CatLibrary.ICatExtension.html\",\"topicUid\":\"CatLibrary.ICatExtension\",\"type\":\"Class\"},{\"name\":\"MRefDelegate\",\"href\":\"CatLibrary.MRefDelegate-3.html\",\"topicHref\":\"CatLibrary.MRefDelegate-3.html\",\"topicUid\":\"CatLibrary.MRefDelegate`3\",\"type\":\"Delegate\"},{\"name\":\"MRefNormalDelegate\",\"href\":\"CatLibrary.MRefNormalDelegate.html\",\"topicHref\":\"CatLibrary.MRefNormalDelegate.html\",\"topicUid\":\"CatLibrary.MRefNormalDelegate\",\"type\":\"Delegate\"},{\"name\":\"Tom\",\"href\":\"CatLibrary.Tom.html\",\"topicHref\":\"CatLibrary.Tom.html\",\"topicUid\":\"CatLibrary.Tom\",\"type\":\"Class\"},{\"name\":\"TomFromBaseClass\",\"href\":\"CatLibrary.TomFromBaseClass.html\",\"topicHref\":\"CatLibrary.TomFromBaseClass.html\",\"topicUid\":\"CatLibrary.TomFromBaseClass\",\"type\":\"Class\"}]},{\"name\":\"MRef.Demo.Enumeration\",\"href\":\"MRef.Demo.Enumeration.html\",\"topicHref\":\"MRef.Demo.Enumeration.html\",\"topicUid\":\"MRef.Demo.Enumeration\",\"type\":\"Namespace\",\"items\":[{\"name\":\"ColorType\",\"href\":\"MRef.Demo.Enumeration.ColorType.html\",\"topicHref\":\"MRef.Demo.Enumeration.ColorType.html\",\"topicUid\":\"MRef.Demo.Enumeration.ColorType\",\"type\":\"Enum\"}]}],\"memberLayout\":\"SamePage\",\"pdf\":true,\"pdfTocPage\":true}" } \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.verified.json index 7712e245639..aca0c1bd910 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.verified.json @@ -207,6 +207,27 @@ "topicUid": "BuildFromProject.Inheritdoc.Issue8129", "type": "Struct" }, + { + "name": "Inheritdoc.Issue9736", + "href": "BuildFromProject.Inheritdoc.Issue9736.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue9736.html", + "topicUid": "BuildFromProject.Inheritdoc.Issue9736", + "type": "Class" + }, + { + "name": "Inheritdoc.Issue9736.IJsonApiOptions", + "href": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "topicUid": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions", + "type": "Interface" + }, + { + "name": "Inheritdoc.Issue9736.JsonApiOptions", + "href": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "topicUid": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions", + "type": "Class" + }, { "name": "Issue8725", "href": "BuildFromProject.Issue8725.html", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html.view.verified.json new file mode 100644 index 00000000000..c42d83eadce --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html.view.verified.json @@ -0,0 +1,20 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "pdf": true, + "pdfTocPage": true, + "title": "Interface Inheritdoc.Issue9736.IJsonApiOptions", + "content": "

Interface Inheritdoc.Issue9736.IJsonApiOptions

\r\n
\r\n
Namespace
BuildFromProject
Assembly
BuildFromProject.dll
\r\n
public interface Inheritdoc.Issue9736.IJsonApiOptions

Properties

\r\n

Whether to use relative links for all resources. false by default.

\n
bool UseRelativeLinks { get; }

Property Value

bool
\r\n
\r\n\r\n\r\n\r\n

Examples

options.UseRelativeLinks = true;
\n
{\n  \"type\": \"articles\",\n  \"id\": \"4309\",\n  \"relationships\": {\n     \"author\": {\n       \"links\": {\n         \"self\": \"/api/shopping/articles/4309/relationships/author\",\n         \"related\": \"/api/shopping/articles/4309/author\"\n       }\n     }\n  }\n}
\n", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "_rel": "../", + "_tocKey": "~/obj/apipage/toc.yml", + "_tocPath": "apipage/toc.html", + "_tocRel": "toc.html" +} \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html.view.verified.json new file mode 100644 index 00000000000..a27af6becd0 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html.view.verified.json @@ -0,0 +1,20 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "pdf": true, + "pdfTocPage": true, + "title": "Class Inheritdoc.Issue9736.JsonApiOptions", + "content": "

Class Inheritdoc.Issue9736.JsonApiOptions

\r\n
\r\n
Namespace
BuildFromProject
Assembly
BuildFromProject.dll
\r\n
public sealed class Inheritdoc.Issue9736.JsonApiOptions : Inheritdoc.Issue9736.IJsonApiOptions

Inheritance

\r\n
\nobject\n
\n\n\r\n

Implements

\r\n\n\r\n

Inherited Members

\r\n\n\n\n\n\n\n\r\n

Properties

\r\n

Whether to use relative links for all resources. false by default.

\n
public bool UseRelativeLinks { get; set; }

Property Value

bool
\r\n
\r\n\r\n\r\n\r\n

Examples

options.UseRelativeLinks = true;
\n
{\n  \"type\": \"articles\",\n  \"id\": \"4309\",\n  \"relationships\": {\n     \"author\": {\n       \"links\": {\n         \"self\": \"/api/shopping/articles/4309/relationships/author\",\n         \"related\": \"/api/shopping/articles/4309/author\"\n       }\n     }\n  }\n}
\n", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "_rel": "../", + "_tocKey": "~/obj/apipage/toc.yml", + "_tocPath": "apipage/toc.html", + "_tocRel": "toc.html" +} \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue9736.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue9736.html.view.verified.json new file mode 100644 index 00000000000..d08faf8781c --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue9736.html.view.verified.json @@ -0,0 +1,20 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "pdf": true, + "pdfTocPage": true, + "title": "Class Inheritdoc.Issue9736", + "content": "

Class Inheritdoc.Issue9736

\r\n
\r\n
Namespace
BuildFromProject
Assembly
BuildFromProject.dll
\r\n
public class Inheritdoc.Issue9736

Inheritance

\r\n
\nobject\n
\n\n\r\n

Inherited Members

\r\n\n\n\n\n\n\n\n\r\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.Inheritdoc.Issue9736.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Inheritdoc.Issue9736.html", + "_rel": "../", + "_tocKey": "~/obj/apipage/toc.yml", + "_tocPath": "apipage/toc.html", + "_tocRel": "toc.html" +} \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.html.view.verified.json index 2c466f39f71..e0ec7686572 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.html.view.verified.json @@ -5,7 +5,7 @@ "pdf": true, "pdfTocPage": true, "title": "Namespace BuildFromProject", - "content": "

Namespace BuildFromProject

\r\n

Namespaces

BuildFromProject.Issue8540
\r\n
\r\n\r\n\r\n\r\n

Classes

Inheritdoc.Issue6366.Class1<T>
\r\n
\r\n\r\n\r\n\r\n
Class1
\r\n
\r\n\r\n\r\n\r\n
Inheritdoc.Issue6366.Class2
\r\n
\r\n\r\n\r\n\r\n
Dog
\r\n
\r\n\r\n\r\n

Class representing a dog.

\n\r\n
Inheritdoc
\r\n
\r\n\r\n\r\n\r\n
Inheritdoc.Issue6366
\r\n
\r\n\r\n\r\n\r\n
Inheritdoc.Issue7035
\r\n
\r\n\r\n\r\n\r\n
Inheritdoc.Issue7484
\r\n
\r\n\r\n\r\n

This is a test class to have something for DocFX to document.

\n\r\n
Inheritdoc.Issue8101
\r\n
\r\n\r\n\r\n\r\n
Class1.Issue8665
\r\n
\r\n\r\n\r\n\r\n
Class1.Issue8696Attribute
\r\n
\r\n\r\n\r\n\r\n
Issue8725
\r\n
\r\n\r\n\r\n

A nice class

\n\r\n
Class1.Issue8948
\r\n
\r\n\r\n\r\n\r\n
Class1.Test<T>
\r\n
\r\n\r\n\r\n\r\n

Structs

Inheritdoc.Issue8129
\r\n
\r\n\r\n\r\n\r\n

Interfaces

IInheritdoc
\r\n
\r\n\r\n\r\n\r\n
Class1.IIssue8948
\r\n
\r\n\r\n\r\n\r\n

Enums

Class1.Issue9260
\r\n
\r\n\r\n\r\n\r\n
", + "content": "

Namespace BuildFromProject

\r\n

Namespaces

BuildFromProject.Issue8540
\r\n
\r\n\r\n\r\n\r\n

Classes

Inheritdoc.Issue6366.Class1<T>
\r\n
\r\n\r\n\r\n\r\n
Class1
\r\n
\r\n\r\n\r\n\r\n
Inheritdoc.Issue6366.Class2
\r\n
\r\n\r\n\r\n\r\n
Dog
\r\n
\r\n\r\n\r\n

Class representing a dog.

\n\r\n
Inheritdoc
\r\n
\r\n\r\n\r\n\r\n
Inheritdoc.Issue6366
\r\n
\r\n\r\n\r\n\r\n
Inheritdoc.Issue7035
\r\n
\r\n\r\n\r\n\r\n
Inheritdoc.Issue7484
\r\n
\r\n\r\n\r\n

This is a test class to have something for DocFX to document.

\n\r\n
Inheritdoc.Issue8101
\r\n
\r\n\r\n\r\n\r\n
Class1.Issue8665
\r\n
\r\n\r\n\r\n\r\n
Class1.Issue8696Attribute
\r\n
\r\n\r\n\r\n\r\n
Issue8725
\r\n
\r\n\r\n\r\n

A nice class

\n\r\n
Class1.Issue8948
\r\n
\r\n\r\n\r\n\r\n
Inheritdoc.Issue9736
\r\n
\r\n\r\n\r\n\r\n
Inheritdoc.Issue9736.JsonApiOptions
\r\n
\r\n\r\n\r\n\r\n
Class1.Test<T>
\r\n
\r\n\r\n\r\n\r\n

Structs

Inheritdoc.Issue8129
\r\n
\r\n\r\n\r\n\r\n

Interfaces

IInheritdoc
\r\n
\r\n\r\n\r\n\r\n
Class1.IIssue8948
\r\n
\r\n\r\n\r\n\r\n
Inheritdoc.Issue9736.IJsonApiOptions
\r\n
\r\n\r\n\r\n\r\n

Enums

Class1.Issue9260
\r\n
\r\n\r\n\r\n\r\n
", "yamlmime": "ApiPage", "_disableNextArticle": true, "_key": "obj/apipage/BuildFromProject.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.ICatExtension.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.ICatExtension.html.view.verified.json index d3b7872bdda..9df7f45bb92 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.ICatExtension.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.ICatExtension.html.view.verified.json @@ -4,9 +4,9 @@ "_enableSearch": true, "pdf": true, "pdfTocPage": true, - "description": "It's the class that contains ICat interface's extension method.\nThis class must be public and static.Also it shouldn't be a geneic class", + "description": "It's the class that contains ICat interface's extension method.\nThis class must be public and static.\nAlso it shouldn't be a geneic class", "title": "Class ICatExtension", - "content": "

Class ICatExtension

\r\n
\r\n
Namespace
CatLibrary
Assembly
CatLibrary.dll
\r\n

It's the class that contains ICat interface's extension method.

\n

This class must be public and static.

Also it shouldn't be a geneic class

\n
public static class ICatExtension

Inheritance

\r\n
\nobject\n
\n\n\r\n

Inherited Members

\r\n\n\n\n\n\n\n\n\r\n

Methods

Play(ICat, ColorType)

\r\n

Extension method to let cat play

\n
public static void Play(this ICat icat, ContainersRefType.ColorType toy)

Parameters

icat ICat
\r\n
\r\n\r\n\r\n

Cat

\n\r\n
toy ContainersRefType.ColorType
\r\n
\r\n\r\n\r\n

Something to play

\n\r\n

Sleep(ICat, long)

\r\n

Extension method hint that how long the cat can sleep.

\n
public static void Sleep(this ICat icat, long hours)

Parameters

icat ICat
\r\n
\r\n\r\n\r\n

The type will be extended.

\n\r\n
hours long
\r\n
\r\n\r\n\r\n

The length of sleep.

\n\r\n
", + "content": "

Class ICatExtension

\r\n
\r\n
Namespace
CatLibrary
Assembly
CatLibrary.dll
\r\n

It's the class that contains ICat interface's extension method.

\n

This class must be public and static.

\n

Also it shouldn't be a geneic class

\n
public static class ICatExtension

Inheritance

\r\n
\nobject\n
\n\n\r\n

Inherited Members

\r\n\n\n\n\n\n\n\n\r\n

Methods

Play(ICat, ColorType)

\r\n

Extension method to let cat play

\n
public static void Play(this ICat icat, ContainersRefType.ColorType toy)

Parameters

icat ICat
\r\n
\r\n\r\n\r\n

Cat

\n\r\n
toy ContainersRefType.ColorType
\r\n
\r\n\r\n\r\n

Something to play

\n\r\n

Sleep(ICat, long)

\r\n

Extension method hint that how long the cat can sleep.

\n
public static void Sleep(this ICat icat, long hours)

Parameters

icat ICat
\r\n
\r\n\r\n\r\n

The type will be extended.

\n\r\n
hours long
\r\n
\r\n\r\n\r\n

The length of sleep.

\n\r\n
", "yamlmime": "ApiPage", "_disableNextArticle": true, "_key": "obj/apipage/CatLibrary.ICatExtension.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.html.view.verified.json index ea4ba3fcd50..b499ec11a90 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.html.view.verified.json @@ -5,7 +5,7 @@ "pdf": true, "pdfTocPage": true, "title": "Namespace CatLibrary", - "content": "

Namespace CatLibrary

\r\n

Namespaces

CatLibrary.Core
\r\n
\r\n\r\n\r\n\r\n

Classes

Cat<T, K>
\r\n
\r\n\r\n\r\n

Here's main class of this Demo.

\n

You can see mostly type of article within this class and you for more detail, please see the remarks.

\n

\n

this class is a template class. It has two Generic parameter. they are: T and K.

\n

The extension method of this class can refer to class

\n\r\n
CatException<T>
\r\n
\r\n\r\n\r\n\r\n
Complex<T, J>
\r\n
\r\n\r\n\r\n\r\n
ICatExtension
\r\n
\r\n\r\n\r\n

It's the class that contains ICat interface's extension method.

\n

This class must be public and static.

Also it shouldn't be a geneic class

\n\r\n
Tom
\r\n
\r\n\r\n\r\n

Tom class is only inherit from Object. Not any member inside itself.

\n\r\n
TomFromBaseClass
\r\n
\r\n\r\n\r\n

TomFromBaseClass inherits from @

\n\r\n

Interfaces

IAnimal
\r\n
\r\n\r\n\r\n

This is basic interface of all animal.

\n\r\n
ICat
\r\n
\r\n\r\n\r\n

Cat's interface

\n\r\n

Delegates

FakeDelegate<T>
\r\n
\r\n\r\n\r\n

Fake delegate

\n\r\n
MRefDelegate<K, T, L>
\r\n
\r\n\r\n\r\n

Generic delegate with many constrains.

\n\r\n
MRefNormalDelegate
\r\n
\r\n\r\n\r\n

Delegate in the namespace

\n\r\n
", + "content": "

Namespace CatLibrary

\r\n

Namespaces

CatLibrary.Core
\r\n
\r\n\r\n\r\n\r\n

Classes

Cat<T, K>
\r\n
\r\n\r\n\r\n

Here's main class of this Demo.

\n

You can see mostly type of article within this class and you for more detail, please see the remarks.

\n

\n

this class is a template class. It has two Generic parameter. they are: T and K.

\n

The extension method of this class can refer to class

\n\r\n
CatException<T>
\r\n
\r\n\r\n\r\n\r\n
Complex<T, J>
\r\n
\r\n\r\n\r\n\r\n
ICatExtension
\r\n
\r\n\r\n\r\n

It's the class that contains ICat interface's extension method.

\n

This class must be public and static.

\n

Also it shouldn't be a geneic class

\n\r\n
Tom
\r\n
\r\n\r\n\r\n

Tom class is only inherit from Object. Not any member inside itself.

\n\r\n
TomFromBaseClass
\r\n
\r\n\r\n\r\n

TomFromBaseClass inherits from @

\n\r\n

Interfaces

IAnimal
\r\n
\r\n\r\n\r\n

This is basic interface of all animal.

\n\r\n
ICat
\r\n
\r\n\r\n\r\n

Cat's interface

\n\r\n

Delegates

FakeDelegate<T>
\r\n
\r\n\r\n\r\n

Fake delegate

\n\r\n
MRefDelegate<K, T, L>
\r\n
\r\n\r\n\r\n

Generic delegate with many constrains.

\n\r\n
MRefNormalDelegate
\r\n
\r\n\r\n\r\n

Delegate in the namespace

\n\r\n
", "yamlmime": "ApiPage", "_disableNextArticle": true, "_key": "obj/apipage/CatLibrary.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.html.view.verified.json index 6f57af38f61..bdd79f7c926 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.html.view.verified.json @@ -260,6 +260,24 @@ "items": [], "leaf": true }, + { + "name": "Inheritdoc.Issue9736", + "href": "BuildFromProject.Inheritdoc.Issue9736.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue9736.html", + "tocHref": null, + "level": 3, + "items": [], + "leaf": true + }, + { + "name": "Inheritdoc.Issue9736.JsonApiOptions", + "href": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "tocHref": null, + "level": 3, + "items": [], + "leaf": true + }, { "name": "Issue8725", "href": "BuildFromProject.Issue8725.html", @@ -312,6 +330,15 @@ "items": [], "leaf": true }, + { + "name": "Inheritdoc.Issue9736.IJsonApiOptions", + "href": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "tocHref": null, + "level": 3, + "items": [], + "leaf": true + }, { "name": "Enums", "topicHref": null, diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.json.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.json.view.verified.json index 769ecbab285..bfdc7d78b39 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.json.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.json.view.verified.json @@ -1,3 +1,3 @@ { - "content": "{\"items\":[{\"name\":\"BuildFromAssembly\",\"href\":\"BuildFromAssembly.html\",\"topicHref\":\"BuildFromAssembly.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"Class1\",\"href\":\"BuildFromAssembly.Class1.html\",\"topicHref\":\"BuildFromAssembly.Class1.html\"},{\"name\":\"Structs\"},{\"name\":\"Issue5432\",\"href\":\"BuildFromAssembly.Issue5432.html\",\"topicHref\":\"BuildFromAssembly.Issue5432.html\"}]},{\"name\":\"BuildFromCSharpSourceCode\",\"href\":\"BuildFromCSharpSourceCode.html\",\"topicHref\":\"BuildFromCSharpSourceCode.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"CSharp\",\"href\":\"BuildFromCSharpSourceCode.CSharp.html\",\"topicHref\":\"BuildFromCSharpSourceCode.CSharp.html\"}]},{\"name\":\"BuildFromProject\",\"href\":\"BuildFromProject.html\",\"topicHref\":\"BuildFromProject.html\",\"items\":[{\"name\":\"Issue8540\",\"href\":\"BuildFromProject.Issue8540.html\",\"topicHref\":\"BuildFromProject.Issue8540.html\",\"items\":[{\"name\":\"A\",\"href\":\"BuildFromProject.Issue8540.A.html\",\"topicHref\":\"BuildFromProject.Issue8540.A.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"A\",\"href\":\"BuildFromProject.Issue8540.A.A.html\",\"topicHref\":\"BuildFromProject.Issue8540.A.A.html\"}]},{\"name\":\"B\",\"href\":\"BuildFromProject.Issue8540.B.html\",\"topicHref\":\"BuildFromProject.Issue8540.B.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"B\",\"href\":\"BuildFromProject.Issue8540.B.B.html\",\"topicHref\":\"BuildFromProject.Issue8540.B.B.html\"}]}]},{\"name\":\"Classes\"},{\"name\":\"Class1\",\"href\":\"BuildFromProject.Class1.html\",\"topicHref\":\"BuildFromProject.Class1.html\"},{\"name\":\"Class1.Issue8665\",\"href\":\"BuildFromProject.Class1.Issue8665.html\",\"topicHref\":\"BuildFromProject.Class1.Issue8665.html\"},{\"name\":\"Class1.Issue8696Attribute\",\"href\":\"BuildFromProject.Class1.Issue8696Attribute.html\",\"topicHref\":\"BuildFromProject.Class1.Issue8696Attribute.html\"},{\"name\":\"Class1.Issue8948\",\"href\":\"BuildFromProject.Class1.Issue8948.html\",\"topicHref\":\"BuildFromProject.Class1.Issue8948.html\"},{\"name\":\"Class1.Test\",\"href\":\"BuildFromProject.Class1.Test-1.html\",\"topicHref\":\"BuildFromProject.Class1.Test-1.html\"},{\"name\":\"Dog\",\"href\":\"BuildFromProject.Dog.html\",\"topicHref\":\"BuildFromProject.Dog.html\"},{\"name\":\"Inheritdoc\",\"href\":\"BuildFromProject.Inheritdoc.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.html\"},{\"name\":\"Inheritdoc.Issue6366\",\"href\":\"BuildFromProject.Inheritdoc.Issue6366.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue6366.html\"},{\"name\":\"Inheritdoc.Issue6366.Class1\",\"href\":\"BuildFromProject.Inheritdoc.Issue6366.Class1-1.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue6366.Class1-1.html\"},{\"name\":\"Inheritdoc.Issue6366.Class2\",\"href\":\"BuildFromProject.Inheritdoc.Issue6366.Class2.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue6366.Class2.html\"},{\"name\":\"Inheritdoc.Issue7035\",\"href\":\"BuildFromProject.Inheritdoc.Issue7035.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue7035.html\"},{\"name\":\"Inheritdoc.Issue7484\",\"href\":\"BuildFromProject.Inheritdoc.Issue7484.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue7484.html\"},{\"name\":\"Inheritdoc.Issue8101\",\"href\":\"BuildFromProject.Inheritdoc.Issue8101.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue8101.html\"},{\"name\":\"Issue8725\",\"href\":\"BuildFromProject.Issue8725.html\",\"topicHref\":\"BuildFromProject.Issue8725.html\"},{\"name\":\"Structs\"},{\"name\":\"Inheritdoc.Issue8129\",\"href\":\"BuildFromProject.Inheritdoc.Issue8129.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue8129.html\"},{\"name\":\"Interfaces\"},{\"name\":\"Class1.IIssue8948\",\"href\":\"BuildFromProject.Class1.IIssue8948.html\",\"topicHref\":\"BuildFromProject.Class1.IIssue8948.html\"},{\"name\":\"IInheritdoc\",\"href\":\"BuildFromProject.IInheritdoc.html\",\"topicHref\":\"BuildFromProject.IInheritdoc.html\"},{\"name\":\"Enums\"},{\"name\":\"Class1.Issue9260\",\"href\":\"BuildFromProject.Class1.Issue9260.html\",\"topicHref\":\"BuildFromProject.Class1.Issue9260.html\"}]},{\"name\":\"BuildFromVBSourceCode\",\"href\":\"BuildFromVBSourceCode.html\",\"topicHref\":\"BuildFromVBSourceCode.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"BaseClass1\",\"href\":\"BuildFromVBSourceCode.BaseClass1.html\",\"topicHref\":\"BuildFromVBSourceCode.BaseClass1.html\"},{\"name\":\"Class1\",\"href\":\"BuildFromVBSourceCode.Class1.html\",\"topicHref\":\"BuildFromVBSourceCode.Class1.html\"}]},{\"name\":\"CatLibrary\",\"href\":\"CatLibrary.html\",\"topicHref\":\"CatLibrary.html\",\"items\":[{\"name\":\"Core\",\"href\":\"CatLibrary.Core.html\",\"topicHref\":\"CatLibrary.Core.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"ContainersRefType.ContainersRefTypeChild\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\"},{\"name\":\"ExplicitLayoutClass\",\"href\":\"CatLibrary.Core.ExplicitLayoutClass.html\",\"topicHref\":\"CatLibrary.Core.ExplicitLayoutClass.html\"},{\"name\":\"Issue231\",\"href\":\"CatLibrary.Core.Issue231.html\",\"topicHref\":\"CatLibrary.Core.Issue231.html\"},{\"name\":\"Structs\"},{\"name\":\"ContainersRefType\",\"href\":\"CatLibrary.Core.ContainersRefType.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.html\"},{\"name\":\"Interfaces\"},{\"name\":\"ContainersRefType.ContainersRefTypeChildInterface\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\"},{\"name\":\"Enums\"},{\"name\":\"ContainersRefType.ColorType\",\"href\":\"CatLibrary.Core.ContainersRefType.ColorType.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ColorType.html\"},{\"name\":\"Delegates\"},{\"name\":\"ContainersRefType.ContainersRefTypeDelegate\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\"}]},{\"name\":\"Classes\"},{\"name\":\"Cat\",\"href\":\"CatLibrary.Cat-2.html\",\"topicHref\":\"CatLibrary.Cat-2.html\"},{\"name\":\"CatException\",\"href\":\"CatLibrary.CatException-1.html\",\"topicHref\":\"CatLibrary.CatException-1.html\"},{\"name\":\"Complex\",\"href\":\"CatLibrary.Complex-2.html\",\"topicHref\":\"CatLibrary.Complex-2.html\"},{\"name\":\"ICatExtension\",\"href\":\"CatLibrary.ICatExtension.html\",\"topicHref\":\"CatLibrary.ICatExtension.html\"},{\"name\":\"Tom\",\"href\":\"CatLibrary.Tom.html\",\"topicHref\":\"CatLibrary.Tom.html\"},{\"name\":\"TomFromBaseClass\",\"href\":\"CatLibrary.TomFromBaseClass.html\",\"topicHref\":\"CatLibrary.TomFromBaseClass.html\"},{\"name\":\"Interfaces\"},{\"name\":\"IAnimal\",\"href\":\"CatLibrary.IAnimal.html\",\"topicHref\":\"CatLibrary.IAnimal.html\"},{\"name\":\"ICat\",\"href\":\"CatLibrary.ICat.html\",\"topicHref\":\"CatLibrary.ICat.html\"},{\"name\":\"Delegates\"},{\"name\":\"FakeDelegate\",\"href\":\"CatLibrary.FakeDelegate-1.html\",\"topicHref\":\"CatLibrary.FakeDelegate-1.html\"},{\"name\":\"MRefDelegate\",\"href\":\"CatLibrary.MRefDelegate-3.html\",\"topicHref\":\"CatLibrary.MRefDelegate-3.html\"},{\"name\":\"MRefNormalDelegate\",\"href\":\"CatLibrary.MRefNormalDelegate.html\",\"topicHref\":\"CatLibrary.MRefNormalDelegate.html\"}]},{\"name\":\"MRef\",\"href\":\"MRef.html\",\"topicHref\":\"MRef.html\",\"items\":[{\"name\":\"Demo\",\"href\":\"MRef.Demo.html\",\"topicHref\":\"MRef.Demo.html\",\"items\":[{\"name\":\"Enumeration\",\"href\":\"MRef.Demo.Enumeration.html\",\"topicHref\":\"MRef.Demo.Enumeration.html\",\"items\":[{\"name\":\"Enums\"},{\"name\":\"ColorType\",\"href\":\"MRef.Demo.Enumeration.ColorType.html\",\"topicHref\":\"MRef.Demo.Enumeration.ColorType.html\"}]}]}]}],\"pdf\":true,\"pdfTocPage\":true}" + "content": "{\"items\":[{\"name\":\"BuildFromAssembly\",\"href\":\"BuildFromAssembly.html\",\"topicHref\":\"BuildFromAssembly.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"Class1\",\"href\":\"BuildFromAssembly.Class1.html\",\"topicHref\":\"BuildFromAssembly.Class1.html\"},{\"name\":\"Structs\"},{\"name\":\"Issue5432\",\"href\":\"BuildFromAssembly.Issue5432.html\",\"topicHref\":\"BuildFromAssembly.Issue5432.html\"}]},{\"name\":\"BuildFromCSharpSourceCode\",\"href\":\"BuildFromCSharpSourceCode.html\",\"topicHref\":\"BuildFromCSharpSourceCode.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"CSharp\",\"href\":\"BuildFromCSharpSourceCode.CSharp.html\",\"topicHref\":\"BuildFromCSharpSourceCode.CSharp.html\"}]},{\"name\":\"BuildFromProject\",\"href\":\"BuildFromProject.html\",\"topicHref\":\"BuildFromProject.html\",\"items\":[{\"name\":\"Issue8540\",\"href\":\"BuildFromProject.Issue8540.html\",\"topicHref\":\"BuildFromProject.Issue8540.html\",\"items\":[{\"name\":\"A\",\"href\":\"BuildFromProject.Issue8540.A.html\",\"topicHref\":\"BuildFromProject.Issue8540.A.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"A\",\"href\":\"BuildFromProject.Issue8540.A.A.html\",\"topicHref\":\"BuildFromProject.Issue8540.A.A.html\"}]},{\"name\":\"B\",\"href\":\"BuildFromProject.Issue8540.B.html\",\"topicHref\":\"BuildFromProject.Issue8540.B.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"B\",\"href\":\"BuildFromProject.Issue8540.B.B.html\",\"topicHref\":\"BuildFromProject.Issue8540.B.B.html\"}]}]},{\"name\":\"Classes\"},{\"name\":\"Class1\",\"href\":\"BuildFromProject.Class1.html\",\"topicHref\":\"BuildFromProject.Class1.html\"},{\"name\":\"Class1.Issue8665\",\"href\":\"BuildFromProject.Class1.Issue8665.html\",\"topicHref\":\"BuildFromProject.Class1.Issue8665.html\"},{\"name\":\"Class1.Issue8696Attribute\",\"href\":\"BuildFromProject.Class1.Issue8696Attribute.html\",\"topicHref\":\"BuildFromProject.Class1.Issue8696Attribute.html\"},{\"name\":\"Class1.Issue8948\",\"href\":\"BuildFromProject.Class1.Issue8948.html\",\"topicHref\":\"BuildFromProject.Class1.Issue8948.html\"},{\"name\":\"Class1.Test\",\"href\":\"BuildFromProject.Class1.Test-1.html\",\"topicHref\":\"BuildFromProject.Class1.Test-1.html\"},{\"name\":\"Dog\",\"href\":\"BuildFromProject.Dog.html\",\"topicHref\":\"BuildFromProject.Dog.html\"},{\"name\":\"Inheritdoc\",\"href\":\"BuildFromProject.Inheritdoc.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.html\"},{\"name\":\"Inheritdoc.Issue6366\",\"href\":\"BuildFromProject.Inheritdoc.Issue6366.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue6366.html\"},{\"name\":\"Inheritdoc.Issue6366.Class1\",\"href\":\"BuildFromProject.Inheritdoc.Issue6366.Class1-1.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue6366.Class1-1.html\"},{\"name\":\"Inheritdoc.Issue6366.Class2\",\"href\":\"BuildFromProject.Inheritdoc.Issue6366.Class2.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue6366.Class2.html\"},{\"name\":\"Inheritdoc.Issue7035\",\"href\":\"BuildFromProject.Inheritdoc.Issue7035.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue7035.html\"},{\"name\":\"Inheritdoc.Issue7484\",\"href\":\"BuildFromProject.Inheritdoc.Issue7484.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue7484.html\"},{\"name\":\"Inheritdoc.Issue8101\",\"href\":\"BuildFromProject.Inheritdoc.Issue8101.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue8101.html\"},{\"name\":\"Inheritdoc.Issue9736\",\"href\":\"BuildFromProject.Inheritdoc.Issue9736.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue9736.html\"},{\"name\":\"Inheritdoc.Issue9736.JsonApiOptions\",\"href\":\"BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html\"},{\"name\":\"Issue8725\",\"href\":\"BuildFromProject.Issue8725.html\",\"topicHref\":\"BuildFromProject.Issue8725.html\"},{\"name\":\"Structs\"},{\"name\":\"Inheritdoc.Issue8129\",\"href\":\"BuildFromProject.Inheritdoc.Issue8129.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue8129.html\"},{\"name\":\"Interfaces\"},{\"name\":\"Class1.IIssue8948\",\"href\":\"BuildFromProject.Class1.IIssue8948.html\",\"topicHref\":\"BuildFromProject.Class1.IIssue8948.html\"},{\"name\":\"IInheritdoc\",\"href\":\"BuildFromProject.IInheritdoc.html\",\"topicHref\":\"BuildFromProject.IInheritdoc.html\"},{\"name\":\"Inheritdoc.Issue9736.IJsonApiOptions\",\"href\":\"BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html\"},{\"name\":\"Enums\"},{\"name\":\"Class1.Issue9260\",\"href\":\"BuildFromProject.Class1.Issue9260.html\",\"topicHref\":\"BuildFromProject.Class1.Issue9260.html\"}]},{\"name\":\"BuildFromVBSourceCode\",\"href\":\"BuildFromVBSourceCode.html\",\"topicHref\":\"BuildFromVBSourceCode.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"BaseClass1\",\"href\":\"BuildFromVBSourceCode.BaseClass1.html\",\"topicHref\":\"BuildFromVBSourceCode.BaseClass1.html\"},{\"name\":\"Class1\",\"href\":\"BuildFromVBSourceCode.Class1.html\",\"topicHref\":\"BuildFromVBSourceCode.Class1.html\"}]},{\"name\":\"CatLibrary\",\"href\":\"CatLibrary.html\",\"topicHref\":\"CatLibrary.html\",\"items\":[{\"name\":\"Core\",\"href\":\"CatLibrary.Core.html\",\"topicHref\":\"CatLibrary.Core.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"ContainersRefType.ContainersRefTypeChild\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\"},{\"name\":\"ExplicitLayoutClass\",\"href\":\"CatLibrary.Core.ExplicitLayoutClass.html\",\"topicHref\":\"CatLibrary.Core.ExplicitLayoutClass.html\"},{\"name\":\"Issue231\",\"href\":\"CatLibrary.Core.Issue231.html\",\"topicHref\":\"CatLibrary.Core.Issue231.html\"},{\"name\":\"Structs\"},{\"name\":\"ContainersRefType\",\"href\":\"CatLibrary.Core.ContainersRefType.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.html\"},{\"name\":\"Interfaces\"},{\"name\":\"ContainersRefType.ContainersRefTypeChildInterface\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\"},{\"name\":\"Enums\"},{\"name\":\"ContainersRefType.ColorType\",\"href\":\"CatLibrary.Core.ContainersRefType.ColorType.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ColorType.html\"},{\"name\":\"Delegates\"},{\"name\":\"ContainersRefType.ContainersRefTypeDelegate\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\"}]},{\"name\":\"Classes\"},{\"name\":\"Cat\",\"href\":\"CatLibrary.Cat-2.html\",\"topicHref\":\"CatLibrary.Cat-2.html\"},{\"name\":\"CatException\",\"href\":\"CatLibrary.CatException-1.html\",\"topicHref\":\"CatLibrary.CatException-1.html\"},{\"name\":\"Complex\",\"href\":\"CatLibrary.Complex-2.html\",\"topicHref\":\"CatLibrary.Complex-2.html\"},{\"name\":\"ICatExtension\",\"href\":\"CatLibrary.ICatExtension.html\",\"topicHref\":\"CatLibrary.ICatExtension.html\"},{\"name\":\"Tom\",\"href\":\"CatLibrary.Tom.html\",\"topicHref\":\"CatLibrary.Tom.html\"},{\"name\":\"TomFromBaseClass\",\"href\":\"CatLibrary.TomFromBaseClass.html\",\"topicHref\":\"CatLibrary.TomFromBaseClass.html\"},{\"name\":\"Interfaces\"},{\"name\":\"IAnimal\",\"href\":\"CatLibrary.IAnimal.html\",\"topicHref\":\"CatLibrary.IAnimal.html\"},{\"name\":\"ICat\",\"href\":\"CatLibrary.ICat.html\",\"topicHref\":\"CatLibrary.ICat.html\"},{\"name\":\"Delegates\"},{\"name\":\"FakeDelegate\",\"href\":\"CatLibrary.FakeDelegate-1.html\",\"topicHref\":\"CatLibrary.FakeDelegate-1.html\"},{\"name\":\"MRefDelegate\",\"href\":\"CatLibrary.MRefDelegate-3.html\",\"topicHref\":\"CatLibrary.MRefDelegate-3.html\"},{\"name\":\"MRefNormalDelegate\",\"href\":\"CatLibrary.MRefNormalDelegate.html\",\"topicHref\":\"CatLibrary.MRefNormalDelegate.html\"}]},{\"name\":\"MRef\",\"href\":\"MRef.html\",\"topicHref\":\"MRef.html\",\"items\":[{\"name\":\"Demo\",\"href\":\"MRef.Demo.html\",\"topicHref\":\"MRef.Demo.html\",\"items\":[{\"name\":\"Enumeration\",\"href\":\"MRef.Demo.Enumeration.html\",\"topicHref\":\"MRef.Demo.Enumeration.html\",\"items\":[{\"name\":\"Enums\"},{\"name\":\"ColorType\",\"href\":\"MRef.Demo.Enumeration.ColorType.html\",\"topicHref\":\"MRef.Demo.Enumeration.ColorType.html\"}]}]}]}],\"pdf\":true,\"pdfTocPage\":true}" } \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.verified.json index 7438292da37..41c2f91ce3b 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.verified.json @@ -148,6 +148,16 @@ "href": "BuildFromProject.Inheritdoc.Issue8101.html", "topicHref": "BuildFromProject.Inheritdoc.Issue8101.html" }, + { + "name": "Inheritdoc.Issue9736", + "href": "BuildFromProject.Inheritdoc.Issue9736.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue9736.html" + }, + { + "name": "Inheritdoc.Issue9736.JsonApiOptions", + "href": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html" + }, { "name": "Issue8725", "href": "BuildFromProject.Issue8725.html", @@ -174,6 +184,11 @@ "href": "BuildFromProject.IInheritdoc.html", "topicHref": "BuildFromProject.IInheritdoc.html" }, + { + "name": "Inheritdoc.Issue9736.IJsonApiOptions", + "href": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html" + }, { "name": "Enums" }, diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/articles/seed.pdf.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/articles/seed.pdf.verified.json index 6eeb7b4254d..831a1c0daf2 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/articles/seed.pdf.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/articles/seed.pdf.verified.json @@ -8,7 +8,7 @@ }, { "Number": 2, - "Text": "Table of Contents\nGetting Started with docfx 3\nEngineering Docs\nSection 1\nEngineering Guidelines 5\nC# Coding Standards 8\nMarkdown 15\nMicrosoft Docs", + "Text": "Table of ContentsGetting Started with docfx3Engineering DocsSection 1Engineering Guidelines5C# Coding Standards8Markdown15Microsoft Docs", "Links": [ { "Uri": "https://docs.microsoft.com/en-us/" @@ -54,7 +54,7 @@ { "Number": 3, "NumberOfImages": 1, - "Text": "3 / 19\nGetting Started with docfx\nGetting Started\nThis is a seed.", + "Text": "3 / 19Getting Started with docfxGetting StartedThis is a seed.", "Links": [ { "Uri": "" @@ -66,22 +66,22 @@ }, { "Number": 4, - "Text": "4 / 19\ndocfx is an API documentation generator for .NET, currently support C# and VB. It has the\nability to extract triple slash comments out from your source code. What's more, it has\nsyntax to link additional files to API to add additional remarks. docfx will scan your source\ncode and your additional conceptual files and generate a complete HTML documentation\nwebsite for you. docfx provides the flexibility for you to customize the website through\ntemplates. We currently have several embedded templates, including websites containing\npure static html pages and also website managed by AngularJS.\nClick \"View Source\" for an API to route to the source code in GitHub (your API must be\npushed to GitHub)\ndocfx provide DNX version for cross platform use.\ndocfx can be used within Visual Studio seamlessly. NOTE offical docfx.msbuild nuget\npackage is now in pre-release version. You can also build your own with source code\nand use it locally.\nWe support Docfx Flavored Markdown(DFM) for writing conceptual files. DFM is\n100% compatible with Github Flavored Markdown(GFM) and add several new features\nincluding file inclusion, cross reference, and yaml header.", + "Text": "4 / 19docfx is an API documentation generator for .NET, currently support C# and VB. It has theability to extract triple slash comments out from your source code. What's more, it hassyntax to link additional files to API to add additional remarks. docfx will scan your sourcecode and your additional conceptual files and generate a complete HTML documentationwebsite for you. docfx provides the flexibility for you to customize the website throughtemplates. We currently have several embedded templates, including websites containingpure static html pages and also website managed by AngularJS.Click \"View Source\" for an API to route to the source code in GitHub (your API must bepushed to GitHub)docfx provide DNX version for cross platform use.docfx can be used within Visual Studio seamlessly. NOTE offical docfx.msbuild nugetpackage is now in pre-release version. You can also build your own with source codeand use it locally.We support Docfx Flavored Markdown(DFM) for writing conceptual files. DFM is100% compatible with Github Flavored Markdown(GFM) and add several new featuresincluding file inclusion, cross reference, and yaml header.", "Links": [] }, { "Number": 5, - "Text": "5 / 19\nEngineering Guidelines\nBasics\nCopyright header and license notice\nAll source code files require the following exact header according to its language (please do\nnot make any changes to it).\nextension: .cs\nextension: .js\nextension: .css\nextension: .tmpl, .tmpl.partial\nExternal dependencies\nThis refers to dependencies on projects (i.e. NuGet packages) outside of the docfx repo, and\nespecially outside of Microsoft. Adding new dependencies require additional approval.\nCurrent approved dependencies are:\nNewtonsoft.Json\nJint\nHtmlAgilityPack\n// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n// Licensed to the .NET Foundation under one or more agreements.\n// The .NET Foundation licenses this file to you under the MIT license.\n/**\n* Licensed to the .NET Foundation under one or more agreements.\n* The .NET Foundation licenses this file to you under the MIT license.\n*/\n{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation lic", + "Text": "5 / 19Engineering GuidelinesBasicsCopyright header and license noticeAll source code files require the following exact header according to its language (please donot make any changes to it).extension: .csextension: .jsextension: .cssextension: .tmpl, .tmpl.partialExternal dependenciesThis refers to dependencies on projects (i.e. NuGet packages) outside of the docfx repo, andespecially outside of Microsoft. Adding new dependencies require additional approval.Current approved dependencies are:Newtonsoft.JsonJintHtmlAgilityPack// Licensed to the .NET Foundation under one or more agreements.// The .NET Foundation licenses this file to you under the MIT license.// Licensed to the .NET Foundation under one or more agreements.// The .NET Foundation licenses this file to you under the MIT license./** * Licensed to the .NET Foundation under one or more agreements. * The .NET Foundation licenses this file to you under the MIT license. */{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation lic", "Links": [] }, { "Number": 6, - "Text": "6 / 19\nNustache\nYamlDotNet\nCode reviews and checkins\nTo help ensure that only the highest quality code makes its way into the project, please\nsubmit all your code changes to GitHub as PRs. This includes runtime code changes, unit\ntest updates, and deployment scripts. For example, sending a PR for just an update to a\nunit test might seem like a waste of time but the unit tests are just as important as the\nproduct code and as such, reviewing changes to them is also just as important.\nThe advantages are numerous: improving code quality, more visibility on changes and their\npotential impact, avoiding duplication of effort, and creating general awareness of progress\nbeing made in various areas.\nIn general a PR should be signed off(using the \uD83D\uDC4D emoticon) by the Owner of that code.\nTo commit the PR to the repo do not use the Big Green Button. Instead, do a typical\npush that you would use with Git (e.g. local pull, rebase, merge, push).\nSource Code Management\nBranch strategy\nIn general:\nmaster has the code for the latest release on NuGet.org. (e.g. 1.0.0, 1.1.0)\ndev has the code that is being worked on but not yet released. This is the branch into\nwhich devs normally submit pull requests and merge changes into. We run daily CI\ntowards dev branch and generate pre-release nuget package, e.g. 1.0.1-alpha-9-\nabcdefsd.\nhotfix has the code for fixing master bug after it is released. hotfix changes will be\nmerged back to master and dev once it is verified.\nSolution and project folder structure and naming\nSolution files go in the repo root. The default entry point is All.sln.\nEvery project also needs a project.json and a matching .xproj file. This project.json is the\nsource of truth for a project's dependencies and configuration options.\nSolution need to contain solution folders that match the physical folder (src, test, tools,\netc.).\nAssembly naming pattern", + "Text": "6 / 19NustacheYamlDotNetCode reviews and checkinsTo help ensure that only the highest quality code makes its way into the project, pleasesubmit all your code changes to GitHub as PRs. This includes runtime code changes, unittest updates, and deployment scripts. For example, sending a PR for just an update to aunit test might seem like a waste of time but the unit tests are just as important as theproduct code and as such, reviewing changes to them is also just as important.The advantages are numerous: improving code quality, more visibility on changes and theirpotential impact, avoiding duplication of effort, and creating general awareness of progressbeing made in various areas.In general a PR should be signed off(using the \uD83D\uDC4D emoticon) by the Owner of that code.To commit the PR to the repo do not use the Big Green Button. Instead, do a typicalpush that you would use with Git (e.g. local pull, rebase, merge, push).Source Code ManagementBranch strategyIn general:master has the code for the latest release on NuGet.org. (e.g. 1.0.0, 1.1.0)dev has the code that is being worked on but not yet released. This is the branch intowhich devs normally submit pull requests and merge changes into. We run daily CItowards dev branch and generate pre-release nuget package, e.g. 1.0.1-alpha-9-abcdefsd.hotfix has the code for fixing master bug after it is released. hotfix changes will bemerged back to master and dev once it is verified.Solution and project folder structure and namingSolution files go in the repo root. The default entry point is All.sln.Every project also needs a project.json and a matching .xproj file. This project.json is thesource of truth for a project's dependencies and configuration options.Solution need to contain solution folders that match the physical folder (src, test, tools,etc.).Assembly naming pattern", "Links": [] }, { "Number": 7, - "Text": "7 / 19\nThe general naming pattern is Docfx...\nUnit tests\nWe use xUnit.net for all unit testing.\nCoding Standards\nPlease refer to C# Coding standards for detailed guideline for C# coding standards.\nTODO Template Coding standards\nTODO Template Preprocess JS Coding standards", + "Text": "7 / 19The general naming pattern is Docfx...Unit testsWe use xUnit.net for all unit testing.Coding StandardsPlease refer to C# Coding standards for detailed guideline for C# coding standards.TODO Template Coding standardsTODO Template Preprocess JS Coding standards", "Links": [ { "Goto": { @@ -96,7 +96,7 @@ }, { "Number": 8, - "Text": "8 / 19\nC# Coding Standards\nIntroduction\nThe coding standard will be used in conjunction with customized version of StyleCop and\nFxCop [TODO] during both development and build process. This will help ensure that the\nstandard is followed by all developers on the team in a consistent manner.\n\"Any fool can write code that a computer can understand. Good programmers write\ncode that humans understand\".\nMartin Fowler. Refactoring: Improving the design of existing code.\nPurpose\nThe aim of this section is to define a set of C# coding standards to be used by CAPS build\nteam to guarantee maximum legibility, reliability, re-usability and homogeneity of our code.\nEach section is marked Mandatory or Recommended. Mandatory sections, will be enforced\nduring code reviews as well as tools like StyleCop and FxCop, and code will not be\nconsidered complete until it is compliant.\nScope\nThis section contains general C# coding standards which can be applied to any type of\napplication developed in C#, based on Framework Design Guidelines\uF1C5 .\nIt does not pretend to be a tutorial on C#. It only includes a set of limitations and\nrecommendations focused on clarifying the development.\nTools\nResharper\uF1C5 is a great 3rd party code cleanup and style tool.\nStyleCop\uF1C5 analyzes C# srouce code to enforce a set of style and consistency rules and\nhas been integrated into many 3rd party development tools such as Resharper.\nFxCop\uF1C5 is an application that analyzes managed code assemblies (code that targets\nthe .NET Framework common language runtime) and reports information about the\nassemblies, such as possible design, localization, performance, and security\nimprovements.\nC# Stylizer\uF1C5 does many of the style rules automatically\nHighlights of Coding Standards\nThis section is not intended to give a summary of all the coding standards that enabled by\nour customized StyleCop, but to give a highlight of some rules one will possibly meet in", + "Text": "8 / 19C# Coding StandardsIntroductionThe coding standard will be used in conjunction with customized version of StyleCop andFxCop [TODO] during both development and build process. This will help ensure that thestandard is followed by all developers on the team in a consistent manner.\"Any fool can write code that a computer can understand. Good programmers writecode that humans understand\".Martin Fowler. Refactoring: Improving the design of existing code.PurposeThe aim of this section is to define a set of C# coding standards to be used by CAPS buildteam to guarantee maximum legibility, reliability, re-usability and homogeneity of our code.Each section is marked Mandatory or Recommended. Mandatory sections, will be enforcedduring code reviews as well as tools like StyleCop and FxCop, and code will not beconsidered complete until it is compliant.ScopeThis section contains general C# coding standards which can be applied to any type ofapplication developed in C#, based on Framework Design Guidelines\uF1C5.It does not pretend to be a tutorial on C#. It only includes a set of limitations andrecommendations focused on clarifying the development.ToolsResharper\uF1C5 is a great 3rd party code cleanup and style tool.StyleCop\uF1C5 analyzes C# srouce code to enforce a set of style and consistency rules andhas been integrated into many 3rd party development tools such as Resharper.FxCop\uF1C5 is an application that analyzes managed code assemblies (code that targetsthe .NET Framework common language runtime) and reports information about theassemblies, such as possible design, localization, performance, and securityimprovements.C# Stylizer\uF1C5 does many of the style rules automaticallyHighlights of Coding StandardsThis section is not intended to give a summary of all the coding standards that enabled byour customized StyleCop, but to give a highlight of some rules one will possibly meet in", "Links": [ { "Uri": "http://msdn.microsoft.com/en-us/library/ms229042.aspx" @@ -147,12 +147,12 @@ }, { "Number": 9, - "Text": "9 / 19\ndaily coding life. It also provides some recommended however not mandatory(which means\nnot enabled in StyleCop) coding standards.\nFile Layout (Recommended)\nOnly one public class is allowed per file.\nThe file name is derived from the class name.\nClass Definition Order (Mandatory)\nThe class definition contains class members in the following order, from less restricted\nscope (public) to more restrictive (private):\nNested types, e.g. classes, enum, struct, etc.\nField members, e.g. member variables, const, etc.\nMember functions\nConstructors\nFinalizer (Do not use unless absolutely necessary)\nMethods (Properties, Events, Operations, Overridables, Static)\nPrivate nested types\nNaming (Mandatory)\nDO use PascalCasing for all public member, type, and namespace names consisting of\nmultiple words.\nNOTE: A special case is made for two-letter acronyms in which both letters are capitalized,\ne.g. IOStream\nDO use camelCasing for parameter names.\nClass : Observer\nFilename: Observer.cs\nPropertyDescriptor\nHtmlTag\nIOStream\npropertyDescriptor\nhtmlTag\nioStream", + "Text": "9 / 19daily coding life. It also provides some recommended however not mandatory(which meansnot enabled in StyleCop) coding standards.File Layout (Recommended)Only one public class is allowed per file.The file name is derived from the class name.Class Definition Order (Mandatory)The class definition contains class members in the following order, from less restrictedscope (public) to more restrictive (private):Nested types, e.g. classes, enum, struct, etc.Field members, e.g. member variables, const, etc.Member functionsConstructorsFinalizer (Do not use unless absolutely necessary)Methods (Properties, Events, Operations, Overridables, Static)Private nested typesNaming (Mandatory)DO use PascalCasing for all public member, type, and namespace names consisting ofmultiple words.NOTE: A special case is made for two-letter acronyms in which both letters are capitalized,e.g. IOStreamDO use camelCasing for parameter names.Class : ObserverFilename: Observer.cs PropertyDescriptor HtmlTag IOStream propertyDescriptor htmlTag ioStream", "Links": [] }, { "Number": 10, - "Text": "10 / 19\nDO start with underscore for private fields\nDO start static readonly fields, constants with capitalized case\nDO NOT capitalize each word in so-called closed-form compound words\uF1C5 .\nDO have \"Async\" explicitly in the Async method name to notice people how to use it\nproperly\nFormatting (Mandatory)\nDO use spaces over tabs, and always show all spaces/tabs in IDE\nTips\nVisual Studio > TOOLS > Options > Text Editor > C# > Tabs > Insert spaces (Tab size:\n4)\nVisual Studio > Edit > Advanced > View White Space\nDO add using inside namespace declaration\nDO add a space when:\n1. for (var i = 0; i < 1; i++)\n2. if (a == b)\nCross-platform coding\nOur code should supports multiple operating systems. Don't assume we only run (and\ndevelop) on Windows. Code should be sensitvie to the differences between OS's. Here are\nsome specifics to consider.\nprivate readonly Guid _userId = Guid.NewGuid();\nprivate static readonly IEntityAccessor EntityAccessor = null;\nprivate const string MetadataName = \"MetadataName\";\nnamespace Microsoft.Content.Build.BuildWorker.UnitTest\n{ \nusing System;\n}", + "Text": "10 / 19DO start with underscore for private fieldsDO start static readonly fields, constants with capitalized caseDO NOT capitalize each word in so-called closed-form compound words\uF1C5.DO have \"Async\" explicitly in the Async method name to notice people how to use itproperlyFormatting (Mandatory)DO use spaces over tabs, and always show all spaces/tabs in IDETipsVisual Studio > TOOLS > Options > Text Editor > C# > Tabs > Insert spaces (Tab size:4)Visual Studio > Edit > Advanced > View White SpaceDO add using inside namespace declarationDO add a space when:1. for (var i = 0; i < 1; i++)2. if (a == b)Cross-platform codingOur code should supports multiple operating systems. Don't assume we only run (anddevelop) on Windows. Code should be sensitvie to the differences between OS's. Here aresome specifics to consider. private readonly Guid _userId = Guid.NewGuid(); private static readonly IEntityAccessor EntityAccessor = null; private const string MetadataName = \"MetadataName\"; namespace Microsoft.Content.Build.BuildWorker.UnitTest { using System; }", "Links": [ { "Uri": "http://msdn.microsoft.com/en-us/library/ms229043.aspx" @@ -167,27 +167,27 @@ }, { "Number": 11, - "Text": "11 / 19\nDO use Enviroment.NewLine instead of hard-coding the line break instead of \\r\\n, as\nWindows uses \\r\\n and OSX/Linux uses \\n.\nNote\nBe aware that thes line-endings may cause problems in code when using @\"\" text blocks\nwith line breaks.\nDO Use Path.Combine() or Path.DirectorySeparatorChar to separate directories. If this is\nnot possible (such as in scripting), use a forward slash /. Windows is more forgiving\nthan Linux in this regard.\nUnit tests and functional tests\nAssembly naming\nThe unit tests for the Microsoft.Foo assembly live in the Microsoft.Foo.Tests assembly.\nThe functional tests for the Microsoft.Foo assmebly live in the\nMicrosoft.Foo.FunctionalTests assmebly.\nIn general there should be exactly one unit test assebmly for each product runtime\nassembly. In general there should be one functional test assembly per repo. Exceptions can\nbe made for both.\nUnit test class naming\nTest class names end with Test and live in the same namespace as the class being tested.\nFor example, the unit tests for the Microsoft.Foo.Boo class would be in a Microsoft.Foo.Boo\nclass in the test assembly.\nUnit test method naming\nUnit test method names must be descriptive about what is being tested, under what\nconditions, and what the expectations are. Pascal casing and underscores can be used to\nimprove readability. The following test names are correct:\nThe following test names are incorrect:\nPublicApiArgumentsShouldHaveNotNullAnnotation\nPublic_api_arguments_should_have_not_null_annotation\nTest1\nConstructor", + "Text": "11 / 19DO use Enviroment.NewLine instead of hard-coding the line break instead of \\r\\n, asWindows uses \\r\\n and OSX/Linux uses \\n.NoteBe aware that thes line-endings may cause problems in code when using @\"\" text blockswith line breaks.DO Use Path.Combine() or Path.DirectorySeparatorChar to separate directories. If this isnot possible (such as in scripting), use a forward slash /. Windows is more forgivingthan Linux in this regard.Unit tests and functional testsAssembly namingThe unit tests for the Microsoft.Foo assembly live in the Microsoft.Foo.Tests assembly.The functional tests for the Microsoft.Foo assmebly live in theMicrosoft.Foo.FunctionalTests assmebly.In general there should be exactly one unit test assebmly for each product runtimeassembly. In general there should be one functional test assembly per repo. Exceptions canbe made for both.Unit test class namingTest class names end with Test and live in the same namespace as the class being tested.For example, the unit tests for the Microsoft.Foo.Boo class would be in a Microsoft.Foo.Booclass in the test assembly.Unit test method namingUnit test method names must be descriptive about what is being tested, under whatconditions, and what the expectations are. Pascal casing and underscores can be used toimprove readability. The following test names are correct:The following test names are incorrect:PublicApiArgumentsShouldHaveNotNullAnnotationPublic_api_arguments_should_have_not_null_annotationTest1Constructor", "Links": [] }, { "Number": 12, - "Text": "12 / 19\nUnit test structure\nThe contents of every unit test should be split into three distinct stages, optionally\nseparated by these comments:\nThe crucial thing here is the Act stage is exactly one statement. That one statement is\nnothing more than a call to the one method that you are trying to test. keeping that one\nstatement as simple as possible is also very important. For example, this is not ideal:\nThis style is not recomended because way too many things can go wrong in this one\nstatement. All the GetComplexParamN() calls can throw for a variety of reasons unrelated to\nthe test itself. It is thus unclear to someone running into a problem why the failure occured.\nThe ideal pattern is to move the complex parameter building into the `Arrange section:\nNow the only reason the line with CallSomeMethod() can fail is if the method itself blew up.\nTesting exception messages\nIn general testing the specific exception message in a unit test is important. This ensures\nthat the exact desired exception is what is being tested rather than a different exception of\nFormatString\nGetData\n// Arrange\n// Act\n// Assert\nint result = myObj.CallSomeMethod(GetComplexParam1(), GetComplexParam2(),\nGetComplexParam3());\n// Arrange\nP1 p1 = GetComplexParam1();\nP2 p2 = GetComplexParam2();\nP3 p3 = GetComplexParam3();\n// Act\nint result = myObj.CallSomeMethod(p1, p2, p3);\n// Assert\nAssert.AreEqual(1234, result);", + "Text": "12 / 19Unit test structureThe contents of every unit test should be split into three distinct stages, optionallyseparated by these comments:The crucial thing here is the Act stage is exactly one statement. That one statement isnothing more than a call to the one method that you are trying to test. keeping that onestatement as simple as possible is also very important. For example, this is not ideal:This style is not recomended because way too many things can go wrong in this onestatement. All the GetComplexParamN() calls can throw for a variety of reasons unrelated tothe test itself. It is thus unclear to someone running into a problem why the failure occured.The ideal pattern is to move the complex parameter building into the `Arrange section:Now the only reason the line with CallSomeMethod() can fail is if the method itself blew up.Testing exception messagesIn general testing the specific exception message in a unit test is important. This ensuresthat the exact desired exception is what is being tested rather than a different exception ofFormatStringGetData// Arrange// Act// Assertint result = myObj.CallSomeMethod(GetComplexParam1(), GetComplexParam2(), GetComplexParam3());// ArrangeP1 p1 = GetComplexParam1();P2 p2 = GetComplexParam2();P3 p3 = GetComplexParam3();// Actint result = myObj.CallSomeMethod(p1, p2, p3);// AssertAssert.AreEqual(1234, result);", "Links": [] }, { "Number": 13, - "Text": "13 / 19\nthe same type. In order to verify the exact exception it is important to verify the message.\nUse xUnit.net's plethora of built-in assertions\nxUnit.net includes many kinds of assertions – please use the most appropriate one for your\ntest. This will make the tests a lot more readable and also allow the test runner report the\nbest possible errors (whether it's local or the CI machine). For example, these are bad:\nThese are good:\nParallel tests\nBy default all unit test assemblies should run in parallel mode, which is the default. Unit\ntests shouldn't depend on any shared state, and so should generally be runnable in\nparallel. If the tests fail in parallel, the first thing to do is to figure out why; do not just\ndisable parallel tests!\nvar ex = Assert.Throws(\n() => fruitBasket.GetBananaById(1234));\nAssert.Equal(\n\"1234\",\nex.Message);\nAssert.Equal(true, someBool);\nAssert.True(\"abc123\" == someString);\nAssert.True(list1.Length == list2.Length);\nfor (int i = 0; i < list1.Length; i++) {\nAssert.True(\nString.Equals\nlist1[i],\nlist2[i],\nStringComparison.OrdinalIgnoreCase));\n}\nAssert.True(someBool);\nAssert.Equal(\"abc123\", someString);\n// built-in collection assertions!\nAssert.Equal(list1, list2, StringComparer.OrdinalIgnoreCase);", + "Text": "13 / 19the same type. In order to verify the exact exception it is important to verify the message.Use xUnit.net's plethora of built-in assertionsxUnit.net includes many kinds of assertions – please use the most appropriate one for yourtest. This will make the tests a lot more readable and also allow the test runner report thebest possible errors (whether it's local or the CI machine). For example, these are bad:These are good:Parallel testsBy default all unit test assemblies should run in parallel mode, which is the default. Unittests shouldn't depend on any shared state, and so should generally be runnable inparallel. If the tests fail in parallel, the first thing to do is to figure out why; do not justdisable parallel tests!var ex = Assert.Throws( () => fruitBasket.GetBananaById(1234));Assert.Equal( \"1234\", ex.Message);Assert.Equal(true, someBool);Assert.True(\"abc123\" == someString);Assert.True(list1.Length == list2.Length);for (int i = 0; i < list1.Length; i++) { Assert.True( String.Equals list1[i], list2[i], StringComparison.OrdinalIgnoreCase));}Assert.True(someBool);Assert.Equal(\"abc123\", someString);// built-in collection assertions!Assert.Equal(list1, list2, StringComparer.OrdinalIgnoreCase);", "Links": [] }, { "Number": 14, - "Text": "14 / 19\nFor functional tests it is reasonable to disable parallel tests.", + "Text": "14 / 19For functional tests it is reasonable to disable parallel tests.", "Links": [] }, { "Number": 15, - "Text": "15 / 19\nMarkdown\nMarkdown\uF1C5 is a lightweight markup language with plain text formatting syntax. Docfx\nsupports CommonMark\uF1C5 compliant Markdown parsed through the Markdig\uF1C5 parsing\nengine.\nLink to Math Expressions\nBlock Quotes\nThis is a block quote.\nAlerts\nNOTE\nInformation the user should notice even if skimming.\n\uF431\nTIP\nOptional information to help a user be more successful.\n\uF431\nIMPORTANT\nEssential information required for user success.\n\uF623\nCAUTION\nNegative potential consequences of an action.\n\uF623\nWARNING\nDangerous certain consequences of an action.\n\uF333", + "Text": "15 / 19MarkdownMarkdown\uF1C5 is a lightweight markup language with plain text formatting syntax. Docfxsupports CommonMark\uF1C5 compliant Markdown parsed through the Markdig\uF1C5 parsingengine.Link to Math ExpressionsBlock QuotesThis is a block quote.AlertsNOTEInformation the user should notice even if skimming.\uF431TIPOptional information to help a user be more successful.\uF431IMPORTANTEssential information required for user success.\uF623CAUTIONNegative potential consequences of an action.\uF623WARNINGDangerous certain consequences of an action.\uF333", "Links": [ { "Uri": "https://daringfireball.net/projects/markdown/" @@ -230,7 +230,7 @@ { "Number": 16, "NumberOfImages": 1, - "Text": "16 / 19\nImage\nMermaid Diagrams\nFlowchart\nCode Snippet\nThe example highlights lines 2, line 5 to 7 and lines 9 to the end of the file.\nMY TODO\nThis is a TODO.\nText\nOne\nTwo\nHard Round Decision\nResult 1\nResult 2", + "Text": "16 / 19ImageMermaid DiagramsFlowchartCode SnippetThe example highlights lines 2, line 5 to 7 and lines 9 to the end of the file.MY TODOThis is a TODO.TextOneTwoHardRoundDecisionResult 1Result 2", "Links": [ { "Uri": "https://learn.microsoft.com/en-us/media/learn/not-found/learn-not-found-light-mode.png?branch=main" @@ -242,12 +242,12 @@ }, { "Number": 17, - "Text": "17 / 19\nMath Expressions\nThis sentence uses $ delimiters to show math inline:\nThe Cauchy-Schwarz Inequality\nThis expression uses \\$ to display a dollar sign:\nTo split $100 in half, we calculate\nusing System;\nusing Azure;\nusing Azure.Storage;\nusing Azure.Storage.Blobs;\nclass Program\n{ \nstatic void Main(string[] args)\n{ \n// Define the connection string for the storage account\nstring connectionString = \"DefaultEndpointsProtocol=https;AccountName=;AccountKey=;EndpointSuffix=core.windows.net\";\n// Create a new BlobServiceClient using the connection string\nvar blobServiceClient = new BlobServiceClient(connectionString);\n// Create a new container\nvar container = blobServiceClient.CreateBlobContainer(\"mycontainer\");\n// Upload a file to the container\nusing (var fileStream = File.OpenRead(\"path/to/file.txt\"))\n{ \ncontainer.UploadBlob(\"file.txt\", fileStream);\n} \n// Download the file from the container\nvar downloadedBlob = container.GetBlobClient(\"file.txt\").Download();\nusing (var fileStream = File.OpenWrite(\"path/to/downloaded-file.txt\"))\n{ \ndownloadedBlob.Value.Content.CopyTo(fileStream);\n} \n}\n}", + "Text": "17 / 19Math ExpressionsThis sentence uses $ delimiters to show math inline: The Cauchy-Schwarz InequalityThis expression uses \\$ to display a dollar sign: To split $100 in half, we calculate using System;using Azure;using Azure.Storage;using Azure.Storage.Blobs;class Program{ static void Main(string[] args) { // Define the connection string for the storage account string connectionString = \"DefaultEndpointsProtocol=https;AccountName=;AccountKey=;EndpointSuffix=core.windows.net\"; // Create a new BlobServiceClient using the connection string var blobServiceClient = new BlobServiceClient(connectionString); // Create a new container var container = blobServiceClient.CreateBlobContainer(\"mycontainer\"); // Upload a file to the container using (var fileStream = File.OpenRead(\"path/to/file.txt\")) { container.UploadBlob(\"file.txt\", fileStream); } // Download the file from the container var downloadedBlob = container.GetBlobClient(\"file.txt\").Download(); using (var fileStream = File.OpenWrite(\"path/to/downloaded-file.txt\")) { downloadedBlob.Value.Content.CopyTo(fileStream); } }}", "Links": [] }, { "Number": 18, - "Text": "18 / 19\nCustom Syntax Highlighting\nTabs\nLinux Windows\nThe above tab group was created with the following syntax:\nTabs are indicated by using a specific link syntax within a Markdown header. The syntax can\nbe described as follows:\nA tab starts with a Markdown header, #, and is followed by a Markdown link [](). The text\nof the link will become the text of the tab header, displayed to the customer. In order for\nthe header to be recognized as a tab, the link itself must start with #tab/ and be followed\nby an ID representing the content of the tab. The ID is used to sync all same-ID tabs across\nthe page. Using the above example, when a user selects a tab with the link #tab/windows, all\ntabs with the link #tab/windows on the page will be selected.\nDependent tabs\nresource storageAccount 'Microsoft.Storage/storageAccounts@2021-06-01' = {\nname: 'hello'\n// (...)\n}\nContent for Linux...\n# [Linux](#tab/linux)\nContent for Linux...\n# [Windows](#tab/windows)\nContent for Windows...\n---\n# [Tab Display Name](#tab/tab-id)", + "Text": "18 / 19Custom Syntax HighlightingTabsLinuxWindowsThe above tab group was created with the following syntax:Tabs are indicated by using a specific link syntax within a Markdown header. The syntax canbe described as follows:A tab starts with a Markdown header, #, and is followed by a Markdown link [](). The textof the link will become the text of the tab header, displayed to the customer. In order forthe header to be recognized as a tab, the link itself must start with #tab/ and be followedby an ID representing the content of the tab. The ID is used to sync all same-ID tabs acrossthe page. Using the above example, when a user selects a tab with the link #tab/windows, alltabs with the link #tab/windows on the page will be selected.Dependent tabsresource storageAccount 'Microsoft.Storage/storageAccounts@2021-06-01' = { name: 'hello' // (...)}Content for Linux...# [Linux](#tab/linux)Content for Linux...# [Windows](#tab/windows)Content for Windows...---# [Tab Display Name](#tab/tab-id)", "Links": [ { "Goto": { @@ -262,7 +262,7 @@ }, { "Number": 19, - "Text": "19 / 19\nIt's possible to make the selection in one set of tabs dependent on the selection in another\nset of tabs. Here's an example of that in action:\n.NET TypeScript REST API\nNotice how changing the Linux/Windows selection above changes the content in the .NET\nand TypeScript tabs. This is because the tab group defines two versions for each .NET and\nTypeScript, where the Windows/Linux selection above determines which version is shown\nfor .NET/TypeScript. Here's the markup that shows how this is done:\nDetails\nDemo\n.NET content for Linux...\n# [.NET](#tab/dotnet/linux)\n.NET content for Linux...\n# [.NET](#tab/dotnet/windows)\n.NET content for Windows...\n# [TypeScript](#tab/typescript/linux)\nTypeScript content for Linux...\n# [TypeScript](#tab/typescript/windows)\nTypeScript content for Windows...\n# [REST API](#tab/rest)\nREST API content, independent of platform...\n---", + "Text": "19 / 19It's possible to make the selection in one set of tabs dependent on the selection in anotherset of tabs. Here's an example of that in action:.NETTypeScriptREST APINotice how changing the Linux/Windows selection above changes the content in the .NETand TypeScript tabs. This is because the tab group defines two versions for each .NET andTypeScript, where the Windows/Linux selection above determines which version is shownfor .NET/TypeScript. Here's the markup that shows how this is done:DetailsDemo.NET content for Linux...# [.NET](#tab/dotnet/linux).NET content for Linux...# [.NET](#tab/dotnet/windows).NET content for Windows...# [TypeScript](#tab/typescript/linux)TypeScript content for Linux...# [TypeScript](#tab/typescript/windows)TypeScript content for Windows...# [REST API](#tab/rest)REST API content, independent of platform...---", "Links": [ { "Goto": { diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json index 181ac491d25..ed9056027ca 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json @@ -104,6 +104,21 @@ "title": "Struct Inheritdoc.Issue8129 | docfx seed website", "keywords": "Struct Inheritdoc.Issue8129 Namespace BuildFromProject Assembly BuildFromProject.dll public struct Inheritdoc.Issue8129 Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) Constructors Issue8129(string) public Issue8129(string foo) Parameters foo string" }, + "api/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html": { + "href": "api/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "title": "Interface Inheritdoc.Issue9736.IJsonApiOptions | docfx seed website", + "keywords": "Interface Inheritdoc.Issue9736.IJsonApiOptions Namespace BuildFromProject Assembly BuildFromProject.dll public interface Inheritdoc.Issue9736.IJsonApiOptions Properties UseRelativeLinks Whether to use relative links for all resources. false by default. bool UseRelativeLinks { get; } Property Value bool Examples options.UseRelativeLinks = true; { \"type\": \"articles\", \"id\": \"4309\", \"relationships\": { \"author\": { \"links\": { \"self\": \"/api/shopping/articles/4309/relationships/author\", \"related\": \"/api/shopping/articles/4309/author\" } } } }" + }, + "api/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html": { + "href": "api/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "title": "Class Inheritdoc.Issue9736.JsonApiOptions | docfx seed website", + "keywords": "Class Inheritdoc.Issue9736.JsonApiOptions Namespace BuildFromProject Assembly BuildFromProject.dll public sealed class Inheritdoc.Issue9736.JsonApiOptions : Inheritdoc.Issue9736.IJsonApiOptions Inheritance object Inheritdoc.Issue9736.JsonApiOptions Implements Inheritdoc.Issue9736.IJsonApiOptions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties UseRelativeLinks Whether to use relative links for all resources. false by default. public bool UseRelativeLinks { get; set; } Property Value bool Examples options.UseRelativeLinks = true; { \"type\": \"articles\", \"id\": \"4309\", \"relationships\": { \"author\": { \"links\": { \"self\": \"/api/shopping/articles/4309/relationships/author\", \"related\": \"/api/shopping/articles/4309/author\" } } } }" + }, + "api/BuildFromProject.Inheritdoc.Issue9736.html": { + "href": "api/BuildFromProject.Inheritdoc.Issue9736.html", + "title": "Class Inheritdoc.Issue9736 | docfx seed website", + "keywords": "Class Inheritdoc.Issue9736 Namespace BuildFromProject Assembly BuildFromProject.dll public class Inheritdoc.Issue9736 Inheritance object Inheritdoc.Issue9736 Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString()" + }, "api/BuildFromProject.Inheritdoc.html": { "href": "api/BuildFromProject.Inheritdoc.html", "title": "Class Inheritdoc | docfx seed website", @@ -142,7 +157,7 @@ "api/BuildFromProject.html": { "href": "api/BuildFromProject.html", "title": "Namespace BuildFromProject | docfx seed website", - "keywords": "Namespace BuildFromProject Namespaces BuildFromProject.Issue8540 Classes Class1 Class1.Issue8665 Class1.Issue8696Attribute Class1.Issue8948 Class1.Test Dog Class representing a dog. Inheritdoc Inheritdoc.Issue6366 Inheritdoc.Issue6366.Class1 Inheritdoc.Issue6366.Class2 Inheritdoc.Issue7035 Inheritdoc.Issue7484 This is a test class to have something for DocFX to document. Inheritdoc.Issue8101 Issue8725 A nice class Structs Inheritdoc.Issue8129 Interfaces Class1.IIssue8948 IInheritdoc Enums Class1.Issue9260" + "keywords": "Namespace BuildFromProject Namespaces BuildFromProject.Issue8540 Classes Class1 Class1.Issue8665 Class1.Issue8696Attribute Class1.Issue8948 Class1.Test Dog Class representing a dog. Inheritdoc Inheritdoc.Issue6366 Inheritdoc.Issue6366.Class1 Inheritdoc.Issue6366.Class2 Inheritdoc.Issue7035 Inheritdoc.Issue7484 This is a test class to have something for DocFX to document. Inheritdoc.Issue8101 Inheritdoc.Issue9736 Inheritdoc.Issue9736.JsonApiOptions Issue8725 A nice class Structs Inheritdoc.Issue8129 Interfaces Class1.IIssue8948 IInheritdoc Inheritdoc.Issue9736.IJsonApiOptions Enums Class1.Issue9260" }, "api/BuildFromVBSourceCode.BaseClass1.html": { "href": "api/BuildFromVBSourceCode.BaseClass1.html", @@ -374,6 +389,21 @@ "title": "Struct Inheritdoc.Issue8129 | docfx seed website", "keywords": "Struct Inheritdoc.Issue8129 Namespace BuildFromProject Assembly BuildFromProject.dll public struct Inheritdoc.Issue8129 Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.ReferenceEquals(object?, object?) object.ToString() Constructors Issue8129(string) public Issue8129(string foo) Parameters foo string" }, + "apipage/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html": { + "href": "apipage/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "title": "Interface Inheritdoc.Issue9736.IJsonApiOptions | docfx seed website", + "keywords": "Interface Inheritdoc.Issue9736.IJsonApiOptions Namespace BuildFromProject Assembly BuildFromProject.dll public interface Inheritdoc.Issue9736.IJsonApiOptions Properties UseRelativeLinks Whether to use relative links for all resources. false by default. bool UseRelativeLinks { get; } Property Value bool Examples options.UseRelativeLinks = true; { \"type\": \"articles\", \"id\": \"4309\", \"relationships\": { \"author\": { \"links\": { \"self\": \"/api/shopping/articles/4309/relationships/author\", \"related\": \"/api/shopping/articles/4309/author\" } } } }" + }, + "apipage/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html": { + "href": "apipage/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "title": "Class Inheritdoc.Issue9736.JsonApiOptions | docfx seed website", + "keywords": "Class Inheritdoc.Issue9736.JsonApiOptions Namespace BuildFromProject Assembly BuildFromProject.dll public sealed class Inheritdoc.Issue9736.JsonApiOptions : Inheritdoc.Issue9736.IJsonApiOptions Inheritance object Inheritdoc.Issue9736.JsonApiOptions Implements Inheritdoc.Issue9736.IJsonApiOptions Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.ReferenceEquals(object?, object?) object.ToString() Properties UseRelativeLinks Whether to use relative links for all resources. false by default. public bool UseRelativeLinks { get; set; } Property Value bool Examples options.UseRelativeLinks = true; { \"type\": \"articles\", \"id\": \"4309\", \"relationships\": { \"author\": { \"links\": { \"self\": \"/api/shopping/articles/4309/relationships/author\", \"related\": \"/api/shopping/articles/4309/author\" } } } }" + }, + "apipage/BuildFromProject.Inheritdoc.Issue9736.html": { + "href": "apipage/BuildFromProject.Inheritdoc.Issue9736.html", + "title": "Class Inheritdoc.Issue9736 | docfx seed website", + "keywords": "Class Inheritdoc.Issue9736 Namespace BuildFromProject Assembly BuildFromProject.dll public class Inheritdoc.Issue9736 Inheritance object Inheritdoc.Issue9736 Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString()" + }, "apipage/BuildFromProject.Inheritdoc.html": { "href": "apipage/BuildFromProject.Inheritdoc.html", "title": "Class Inheritdoc | docfx seed website", @@ -412,7 +442,7 @@ "apipage/BuildFromProject.html": { "href": "apipage/BuildFromProject.html", "title": "Namespace BuildFromProject | docfx seed website", - "keywords": "Namespace BuildFromProject Namespaces BuildFromProject.Issue8540 Classes Inheritdoc.Issue6366.Class1 Class1 Inheritdoc.Issue6366.Class2 Dog Class representing a dog. Inheritdoc Inheritdoc.Issue6366 Inheritdoc.Issue7035 Inheritdoc.Issue7484 This is a test class to have something for DocFX to document. Inheritdoc.Issue8101 Class1.Issue8665 Class1.Issue8696Attribute Issue8725 A nice class Class1.Issue8948 Class1.Test Structs Inheritdoc.Issue8129 Interfaces IInheritdoc Class1.IIssue8948 Enums Class1.Issue9260" + "keywords": "Namespace BuildFromProject Namespaces BuildFromProject.Issue8540 Classes Inheritdoc.Issue6366.Class1 Class1 Inheritdoc.Issue6366.Class2 Dog Class representing a dog. Inheritdoc Inheritdoc.Issue6366 Inheritdoc.Issue7035 Inheritdoc.Issue7484 This is a test class to have something for DocFX to document. Inheritdoc.Issue8101 Class1.Issue8665 Class1.Issue8696Attribute Issue8725 A nice class Class1.Issue8948 Inheritdoc.Issue9736 Inheritdoc.Issue9736.JsonApiOptions Class1.Test Structs Inheritdoc.Issue8129 Interfaces IInheritdoc Class1.IIssue8948 Inheritdoc.Issue9736.IJsonApiOptions Enums Class1.Issue9260" }, "apipage/BuildFromVBSourceCode.BaseClass1.html": { "href": "apipage/BuildFromVBSourceCode.BaseClass1.html", @@ -679,6 +709,21 @@ "title": "Struct Inheritdoc.Issue8129 | docfx seed website", "keywords": "Struct Inheritdoc.Issue8129 Namespace: BuildFromProject Assembly: BuildFromProject.dll public struct Inheritdoc.Issue8129 Inherited Members object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString() Constructors Issue8129(string) public Issue8129(string foo) Parameters foo string" }, + "md/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html": { + "href": "md/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "title": "Interface Inheritdoc.Issue9736.IJsonApiOptions | docfx seed website", + "keywords": "Interface Inheritdoc.Issue9736.IJsonApiOptions Namespace: BuildFromProject Assembly: BuildFromProject.dll public interface Inheritdoc.Issue9736.IJsonApiOptions Properties UseRelativeLinks Whether to use relative links for all resources. false by default. bool UseRelativeLinks { get; } Property Value bool Examples options.UseRelativeLinks = true; { \"type\": \"articles\", \"id\": \"4309\", \"relationships\": { \"author\": { \"links\": { \"self\": \"/api/shopping/articles/4309/relationships/author\", \"related\": \"/api/shopping/articles/4309/author\" } } } }" + }, + "md/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html": { + "href": "md/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "title": "Class Inheritdoc.Issue9736.JsonApiOptions | docfx seed website", + "keywords": "Class Inheritdoc.Issue9736.JsonApiOptions Namespace: BuildFromProject Assembly: BuildFromProject.dll public sealed class Inheritdoc.Issue9736.JsonApiOptions : Inheritdoc.Issue9736.IJsonApiOptions Inheritance object ← Inheritdoc.Issue9736.JsonApiOptions Implements Inheritdoc.Issue9736.IJsonApiOptions Inherited Members object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString() Properties UseRelativeLinks Whether to use relative links for all resources. false by default. public bool UseRelativeLinks { get; set; } Property Value bool Examples options.UseRelativeLinks = true; { \"type\": \"articles\", \"id\": \"4309\", \"relationships\": { \"author\": { \"links\": { \"self\": \"/api/shopping/articles/4309/relationships/author\", \"related\": \"/api/shopping/articles/4309/author\" } } } }" + }, + "md/BuildFromProject.Inheritdoc.Issue9736.html": { + "href": "md/BuildFromProject.Inheritdoc.Issue9736.html", + "title": "Class Inheritdoc.Issue9736 | docfx seed website", + "keywords": "Class Inheritdoc.Issue9736 Namespace: BuildFromProject Assembly: BuildFromProject.dll public class Inheritdoc.Issue9736 Inheritance object ← Inheritdoc.Issue9736 Inherited Members object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()" + }, "md/BuildFromProject.Inheritdoc.html": { "href": "md/BuildFromProject.Inheritdoc.html", "title": "Class Inheritdoc | docfx seed website", @@ -717,7 +762,7 @@ "md/BuildFromProject.html": { "href": "md/BuildFromProject.html", "title": "Namespace BuildFromProject | docfx seed website", - "keywords": "Namespace BuildFromProject Namespaces BuildFromProject.Issue8540 Classes Inheritdoc.Issue6366.Class1 Class1 Inheritdoc.Issue6366.Class2 Dog Class representing a dog. Inheritdoc Inheritdoc.Issue6366 Inheritdoc.Issue7035 Inheritdoc.Issue7484 This is a test class to have something for DocFX to document. Inheritdoc.Issue8101 Class1.Issue8665 Class1.Issue8696Attribute Issue8725 A nice class Class1.Issue8948 Class1.Test Structs Inheritdoc.Issue8129 Interfaces IInheritdoc Class1.IIssue8948 Enums Class1.Issue9260" + "keywords": "Namespace BuildFromProject Namespaces BuildFromProject.Issue8540 Classes Inheritdoc.Issue6366.Class1 Class1 Inheritdoc.Issue6366.Class2 Dog Class representing a dog. Inheritdoc Inheritdoc.Issue6366 Inheritdoc.Issue7035 Inheritdoc.Issue7484 This is a test class to have something for DocFX to document. Inheritdoc.Issue8101 Class1.Issue8665 Class1.Issue8696Attribute Issue8725 A nice class Class1.Issue8948 Inheritdoc.Issue9736 Inheritdoc.Issue9736.JsonApiOptions Class1.Test Structs Inheritdoc.Issue8129 Interfaces IInheritdoc Class1.IIssue8948 Inheritdoc.Issue9736.IJsonApiOptions Enums Class1.Issue9260" }, "md/BuildFromVBSourceCode.BaseClass1.html": { "href": "md/BuildFromVBSourceCode.BaseClass1.html", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html.view.verified.json new file mode 100644 index 00000000000..cdf79226229 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html.view.verified.json @@ -0,0 +1,42 @@ +{ + "conceptual": "\n

Namespace: BuildFromProject
\nAssembly: BuildFromProject.dll

\n
public interface Inheritdoc.Issue9736.IJsonApiOptions\n
\n

Properties

\n

UseRelativeLinks

\n

Whether to use relative links for all resources. false by default.

\n
bool UseRelativeLinks { get; }\n
\n

Property Value

\n

bool

\n

Examples

\n
options.UseRelativeLinks = true;
\n
{\n  \"type\": \"articles\",\n  \"id\": \"4309\",\n  \"relationships\": {\n     \"author\": {\n       \"links\": {\n         \"self\": \"/api/shopping/articles/4309/relationships/author\",\n         \"related\": \"/api/shopping/articles/4309/author\"\n       }\n     }\n  }\n}
\n", + "type": "Conceptual", + "source": { + "remote": { + "path": "samples/seed/obj/md/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.md", + "branch": "main", + "repo": "https://github.com/dotnet/docfx" + }, + "startLine": 0, + "endLine": 0 + }, + "path": "obj/md/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.md", + "documentation": { + "remote": { + "path": "samples/seed/obj/md/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.md", + "branch": "main", + "repo": "https://github.com/dotnet/docfx" + }, + "startLine": 0, + "endLine": 0 + }, + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "pdf": true, + "pdfTocPage": true, + "rawTitle": "

Interface Inheritdoc.Issue9736.IJsonApiOptions

", + "title": " Interface Inheritdoc.Issue9736.IJsonApiOptions", + "wordCount": 51, + "_key": "obj/md/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.md", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "md/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "_rel": "../", + "_tocKey": "~/obj/md/toc.yml", + "_tocPath": "md/toc.html", + "_tocRel": "toc.html", + "_disableToc": false, + "docurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/obj/md/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.md/#L1" +} \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html.view.verified.json new file mode 100644 index 00000000000..9fe6c1db07a --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html.view.verified.json @@ -0,0 +1,42 @@ +{ + "conceptual": "\n

Namespace: BuildFromProject
\nAssembly: BuildFromProject.dll

\n
public sealed class Inheritdoc.Issue9736.JsonApiOptions : Inheritdoc.Issue9736.IJsonApiOptions\n
\n

Inheritance

\n

object ←\nInheritdoc.Issue9736.JsonApiOptions

\n

Implements

\n

Inheritdoc.Issue9736.IJsonApiOptions

\n

Inherited Members

\n

object.Equals(object?),\nobject.Equals(object?, object?),\nobject.GetHashCode(),\nobject.GetType(),\nobject.ReferenceEquals(object?, object?),\nobject.ToString()

\n

Properties

\n

UseRelativeLinks

\n

Whether to use relative links for all resources. false by default.

\n
public bool UseRelativeLinks { get; set; }\n
\n

Property Value

\n

bool

\n

Examples

\n
options.UseRelativeLinks = true;
\n
{\n  \"type\": \"articles\",\n  \"id\": \"4309\",\n  \"relationships\": {\n     \"author\": {\n       \"links\": {\n         \"self\": \"/api/shopping/articles/4309/relationships/author\",\n         \"related\": \"/api/shopping/articles/4309/author\"\n       }\n     }\n  }\n}
\n", + "type": "Conceptual", + "source": { + "remote": { + "path": "samples/seed/obj/md/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.md", + "branch": "main", + "repo": "https://github.com/dotnet/docfx" + }, + "startLine": 0, + "endLine": 0 + }, + "path": "obj/md/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.md", + "documentation": { + "remote": { + "path": "samples/seed/obj/md/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.md", + "branch": "main", + "repo": "https://github.com/dotnet/docfx" + }, + "startLine": 0, + "endLine": 0 + }, + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "pdf": true, + "pdfTocPage": true, + "rawTitle": "

Class Inheritdoc.Issue9736.JsonApiOptions

", + "title": " Class Inheritdoc.Issue9736.JsonApiOptions", + "wordCount": 71, + "_key": "obj/md/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.md", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "md/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "_rel": "../", + "_tocKey": "~/obj/md/toc.yml", + "_tocPath": "md/toc.html", + "_tocRel": "toc.html", + "_disableToc": false, + "docurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/obj/md/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.md/#L1" +} \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue9736.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue9736.html.view.verified.json new file mode 100644 index 00000000000..62d1a464f0e --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue9736.html.view.verified.json @@ -0,0 +1,42 @@ +{ + "conceptual": "\n

Namespace: BuildFromProject
\nAssembly: BuildFromProject.dll

\n
public class Inheritdoc.Issue9736\n
\n

Inheritance

\n

object ←\nInheritdoc.Issue9736

\n

Inherited Members

\n

object.Equals(object?),\nobject.Equals(object?, object?),\nobject.GetHashCode(),\nobject.GetType(),\nobject.MemberwiseClone(),\nobject.ReferenceEquals(object?, object?),\nobject.ToString()

\n", + "type": "Conceptual", + "source": { + "remote": { + "path": "samples/seed/obj/md/BuildFromProject.Inheritdoc.Issue9736.md", + "branch": "main", + "repo": "https://github.com/dotnet/docfx" + }, + "startLine": 0, + "endLine": 0 + }, + "path": "obj/md/BuildFromProject.Inheritdoc.Issue9736.md", + "documentation": { + "remote": { + "path": "samples/seed/obj/md/BuildFromProject.Inheritdoc.Issue9736.md", + "branch": "main", + "repo": "https://github.com/dotnet/docfx" + }, + "startLine": 0, + "endLine": 0 + }, + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "pdf": true, + "pdfTocPage": true, + "rawTitle": "

Class Inheritdoc.Issue9736

", + "title": " Class Inheritdoc.Issue9736", + "wordCount": 22, + "_key": "obj/md/BuildFromProject.Inheritdoc.Issue9736.md", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "md/BuildFromProject.Inheritdoc.Issue9736.html", + "_rel": "../", + "_tocKey": "~/obj/md/toc.yml", + "_tocPath": "md/toc.html", + "_tocRel": "toc.html", + "_disableToc": false, + "docurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/obj/md/BuildFromProject.Inheritdoc.Issue9736.md/#L1" +} \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.html.view.verified.json index 9646d1fdc65..feadbf92625 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

Namespaces

\n

BuildFromProject.Issue8540

\n

Classes

\n

Inheritdoc.Issue6366.Class1<T>

\n

Class1

\n

Inheritdoc.Issue6366.Class2

\n

Dog

\n

Class representing a dog.

\n

Inheritdoc

\n

Inheritdoc.Issue6366

\n

Inheritdoc.Issue7035

\n

Inheritdoc.Issue7484

\n

This is a test class to have something for DocFX to document.

\n

Inheritdoc.Issue8101

\n

Class1.Issue8665

\n

Class1.Issue8696Attribute

\n

Issue8725

\n

A nice class

\n

Class1.Issue8948

\n

Class1.Test<T>

\n

Structs

\n

Inheritdoc.Issue8129

\n

Interfaces

\n

IInheritdoc

\n

Class1.IIssue8948

\n

Enums

\n

Class1.Issue9260

\n", + "conceptual": "\n

Namespaces

\n

BuildFromProject.Issue8540

\n

Classes

\n

Inheritdoc.Issue6366.Class1<T>

\n

Class1

\n

Inheritdoc.Issue6366.Class2

\n

Dog

\n

Class representing a dog.

\n

Inheritdoc

\n

Inheritdoc.Issue6366

\n

Inheritdoc.Issue7035

\n

Inheritdoc.Issue7484

\n

This is a test class to have something for DocFX to document.

\n

Inheritdoc.Issue8101

\n

Class1.Issue8665

\n

Class1.Issue8696Attribute

\n

Issue8725

\n

A nice class

\n

Class1.Issue8948

\n

Inheritdoc.Issue9736

\n

Inheritdoc.Issue9736.JsonApiOptions

\n

Class1.Test<T>

\n

Structs

\n

Inheritdoc.Issue8129

\n

Interfaces

\n

IInheritdoc

\n

Class1.IIssue8948

\n

Inheritdoc.Issue9736.IJsonApiOptions

\n

Enums

\n

Class1.Issue9260

\n", "type": "Conceptual", "source": { "remote": { @@ -27,7 +27,7 @@ "pdfTocPage": true, "rawTitle": "

Namespace BuildFromProject

", "title": " Namespace BuildFromProject", - "wordCount": 43, + "wordCount": 46, "_key": "obj/md/BuildFromProject.md", "_navKey": "~/toc.yml", "_navPath": "toc.html", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Cat-2.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Cat-2.html.view.verified.json index f38b9648951..fc358188bf6 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Cat-2.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Cat-2.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

Namespace: CatLibrary
\nAssembly: CatLibrary.dll

\n

Here's main class of this Demo.

\n

You can see mostly type of article within this class and you for more detail, please see the remarks.

\n

\n

this class is a template class. It has two Generic parameter. they are: T and K.

\n

The extension method of this class can refer to class

\n
[Serializable]\n[Obsolete]\npublic class Cat<T, K> : ICat, IAnimal where T : class, new() where K : struct\n
\n

Type Parameters

\n

T

\n

This type should be class and can new instance.

\n

K

\n

This type is a struct type, class type can't be used for this parameter.

\n

Inheritance

\n

object ←\nCat<T, K>

\n

Implements

\n

ICat,\nIAnimal

\n

Inherited Members

\n

object.Equals(object?),\nobject.Equals(object?, object?),\nobject.GetHashCode(),\nobject.GetType(),\nobject.MemberwiseClone(),\nobject.ReferenceEquals(object?, object?),\nobject.ToString()

\n

Extension Methods

\n

ICatExtension.Play(ICat, ContainersRefType.ColorType),\nICatExtension.Sleep(ICat, long)

\n

Examples

\n

Here's example of how to create an instance of this class. As T is limited with class and K is limited with struct.

\n
var a = new Cat(object, int)();\nint catNumber = new int();\nunsafe\n{\n    a.GetFeetLength(catNumber);\n}
\n

As you see, here we bring in pointer so we need to add unsafe keyword.

\n

Remarks

\n

Here's all the content you can see in this class.

\n

Constructors

\n

Cat()

\n

Default constructor.

\n
public Cat()\n
\n

Cat(T)

\n

Constructor with one generic parameter.

\n
public Cat(T ownType)\n
\n

Parameters

\n

ownType T

\n

This parameter type defined by class.

\n

Cat(string, out int, string, bool)

\n

It's a complex constructor. The parameter will have some attributes.

\n
public Cat(string nickName, out int age, string realName, bool isHealthy)\n
\n

Parameters

\n

nickName string

\n

it's string type.

\n

age int

\n

It's an out and ref parameter.

\n

realName string

\n

It's an out paramter.

\n

isHealthy bool

\n

It's an in parameter.

\n

Fields

\n

isHealthy

\n

Field with attribute.

\n
[ContextStatic]\n[NonSerialized]\n[Obsolete]\npublic bool isHealthy\n
\n

Field Value

\n

bool

\n

Properties

\n

Age

\n

Hint cat's age.

\n
[Obsolete]\nprotected int Age { get; set; }\n
\n

Property Value

\n

int

\n

Name

\n

EII property.

\n
public string Name { get; }\n
\n

Property Value

\n

string

\n

this[string]

\n

This is index property of Cat. You can see that the visibility is different between get and set method.

\n
public int this[string a] { protected get; set; }\n
\n

Property Value

\n

int

\n

Methods

\n

CalculateFood(DateTime)

\n

It's a method with complex return type.

\n
public Dictionary<string, List<int>> CalculateFood(DateTime date)\n
\n

Parameters

\n

date DateTime

\n

Date time to now.

\n

Returns

\n

Dictionary<string, List<int>>

\n

It's a relationship map of different kind food.

\n

Equals(object)

\n

Override the method of Object.Equals(object obj).

\n
public override bool Equals(object obj)\n
\n

Parameters

\n

obj object

\n

Can pass any class type.

\n

Returns

\n

bool

\n

The return value tell you whehter the compare operation is successful.

\n

GetTailLength(int*, params object[])

\n

It's an unsafe method.\nAs you see, catName is a pointer, so we need to add unsafe keyword.

\n
public long GetTailLength(int* catName, params object[] parameters)\n
\n

Parameters

\n

catName int*

\n

Thie represent for cat name length.

\n

parameters object[]

\n

Optional parameters.

\n

Returns

\n

long

\n

Return cat tail's length.

\n

Jump(T, K, ref bool)

\n

This method have attribute above it.

\n
[Conditional("Debug")]\npublic void Jump(T ownType, K anotherOwnType, ref bool cheat)\n
\n

Parameters

\n

ownType T

\n

Type come from class define.

\n

anotherOwnType K

\n

Type come from class define.

\n

cheat bool

\n

Hint whether this cat has cheat mode.

\n

Exceptions

\n

ArgumentException

\n

This is an argument exception

\n

ownEat

\n

Eat event of this cat

\n
[Obsolete("This _event handler_ is deprecated.")]\npublic event EventHandler ownEat\n
\n

Event Type

\n

EventHandler

\n

Operators

\n

operator +(Cat<T, K>, int)

\n

Addition operator of this class.

\n
public static int operator +(Cat<T, K> lsr, int rsr)\n
\n

Parameters

\n

lsr Cat<T, K>

\n

..

\n

rsr int

\n

~~

\n

Returns

\n

int

\n

Result with int type.

\n

explicit operator Tom(Cat<T, K>)

\n

Expilicit operator of this class.

\n

It means this cat can evolve to change to Tom. Tom and Jerry.

\n
public static explicit operator Tom(Cat<T, K> src)\n
\n

Parameters

\n

src Cat<T, K>

\n

Instance of this class.

\n

Returns

\n

Tom

\n

Advanced class type of cat.

\n

operator -(Cat<T, K>, int)

\n

Similar with operaotr +, refer to that topic.

\n
public static int operator -(Cat<T, K> lsr, int rsr)\n
\n

Parameters

\n

lsr Cat<T, K>

\n

rsr int

\n

Returns

\n

int

\n", + "conceptual": "\n

Namespace: CatLibrary
\nAssembly: CatLibrary.dll

\n

Here's main class of this Demo.

\n

You can see mostly type of article within this class and you for more detail, please see the remarks.

\n

\n

this class is a template class. It has two Generic parameter. they are: T and K.

\n

The extension method of this class can refer to class

\n
[Serializable]\n[Obsolete]\npublic class Cat<T, K> : ICat, IAnimal where T : class, new() where K : struct\n
\n

Type Parameters

\n

T

\n

This type should be class and can new instance.

\n

K

\n

This type is a struct type, class type can't be used for this parameter.

\n

Inheritance

\n

object ←\nCat<T, K>

\n

Implements

\n

ICat,\nIAnimal

\n

Inherited Members

\n

object.Equals(object?),\nobject.Equals(object?, object?),\nobject.GetHashCode(),\nobject.GetType(),\nobject.MemberwiseClone(),\nobject.ReferenceEquals(object?, object?),\nobject.ToString()

\n

Extension Methods

\n

ICatExtension.Play(ICat, ContainersRefType.ColorType),\nICatExtension.Sleep(ICat, long)

\n

Examples

\n

Here's example of how to create an instance of this class. As T is limited with class and K is limited with struct.

\n
var a = new Cat(object, int)();\nint catNumber = new int();\nunsafe\n{\n    a.GetFeetLength(catNumber);\n}
\n

As you see, here we bring in pointer so we need to add unsafe keyword.

\n

Remarks

\n

Here's all the content you can see in this class.

\n

Constructors

\n

Cat()

\n

Default constructor.

\n
public Cat()\n
\n

Cat(T)

\n

Constructor with one generic parameter.

\n
public Cat(T ownType)\n
\n

Parameters

\n

ownType T

\n

This parameter type defined by class.

\n

Cat(string, out int, string, bool)

\n

It's a complex constructor. The parameter will have some attributes.

\n
public Cat(string nickName, out int age, string realName, bool isHealthy)\n
\n

Parameters

\n

nickName string

\n

it's string type.

\n

age int

\n

It's an out and ref parameter.

\n

realName string

\n

It's an out paramter.

\n

isHealthy bool

\n

It's an in parameter.

\n

Fields

\n

isHealthy

\n

Field with attribute.

\n
[ContextStatic]\n[NonSerialized]\n[Obsolete]\npublic bool isHealthy\n
\n

Field Value

\n

bool

\n

Properties

\n

Age

\n

Hint cat's age.

\n
[Obsolete]\nprotected int Age { get; set; }\n
\n

Property Value

\n

int

\n

Name

\n

EII property.

\n
public string Name { get; }\n
\n

Property Value

\n

string

\n

this[string]

\n

This is index property of Cat. You can see that the visibility is different between get and set method.

\n
public int this[string a] { protected get; set; }\n
\n

Property Value

\n

int

\n

Methods

\n

CalculateFood(DateTime)

\n

It's a method with complex return type.

\n
public Dictionary<string, List<int>> CalculateFood(DateTime date)\n
\n

Parameters

\n

date DateTime

\n

Date time to now.

\n

Returns

\n

Dictionary<string, List<int>>

\n

It's a relationship map of different kind food.

\n

Equals(object)

\n

Override the method of Object.Equals(object obj).

\n
public override bool Equals(object obj)\n
\n

Parameters

\n

obj object

\n

Can pass any class type.

\n

Returns

\n

bool

\n

The return value tell you whehter the compare operation is successful.

\n

GetTailLength(int*, params object[])

\n

It's an unsafe method.\nAs you see, catName is a pointer, so we need to add unsafe keyword.

\n
public long GetTailLength(int* catName, params object[] parameters)\n
\n

Parameters

\n

catName int*

\n

Thie represent for cat name length.

\n

parameters object[]

\n

Optional parameters.

\n

Returns

\n

long

\n

Return cat tail's length.

\n

Jump(T, K, ref bool)

\n

This method have attribute above it.

\n
[Conditional("Debug")]\npublic void Jump(T ownType, K anotherOwnType, ref bool cheat)\n
\n

Parameters

\n

ownType T

\n

Type come from class define.

\n

anotherOwnType K

\n

Type come from class define.

\n

cheat bool

\n

Hint whether this cat has cheat mode.

\n

Exceptions

\n

ArgumentException

\n

This is an argument exception

\n

ownEat

\n

Eat event of this cat

\n
[Obsolete("This _event handler_ is deprecated.")]\npublic event EventHandler ownEat\n
\n

Event Type

\n

EventHandler

\n

Operators

\n

operator +(Cat<T, K>, int)

\n

Addition operator of this class.

\n
public static int operator +(Cat<T, K> lsr, int rsr)\n
\n

Parameters

\n

lsr Cat<T, K>

\n

..

\n

rsr int

\n

~~

\n

Returns

\n

int

\n

Result with int type.

\n

explicit operator Tom(Cat<T, K>)

\n

Expilicit operator of this class.

\n

It means this cat can evolve to change to Tom. Tom and Jerry.

\n
public static explicit operator Tom(Cat<T, K> src)\n
\n

Parameters

\n

src Cat<T, K>

\n

Instance of this class.

\n

Returns

\n

Tom

\n

Advanced class type of cat.

\n

operator -(Cat<T, K>, int)

\n

Similar with operaotr +, refer to that topic.

\n
public static int operator -(Cat<T, K> lsr, int rsr)\n
\n

Parameters

\n

lsr Cat<T, K>

\n

rsr int

\n

Returns

\n

int

\n", "type": "Conceptual", "source": { "remote": { diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.ICatExtension.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.ICatExtension.html.view.verified.json index 3048684c691..384c39aa5b8 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.ICatExtension.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.ICatExtension.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

Namespace: CatLibrary
\nAssembly: CatLibrary.dll

\n

It's the class that contains ICat interface's extension method.

\n

This class must be public and static.

Also it shouldn't be a geneic class

\n
public static class ICatExtension\n
\n

Inheritance

\n

object ←\nICatExtension

\n

Inherited Members

\n

object.Equals(object?),\nobject.Equals(object?, object?),\nobject.GetHashCode(),\nobject.GetType(),\nobject.MemberwiseClone(),\nobject.ReferenceEquals(object?, object?),\nobject.ToString()

\n

Methods

\n

Play(ICat, ColorType)

\n

Extension method to let cat play

\n
public static void Play(this ICat icat, ContainersRefType.ColorType toy)\n
\n

Parameters

\n

icat ICat

\n

Cat

\n

toy ContainersRefType.ColorType

\n

Something to play

\n

Sleep(ICat, long)

\n

Extension method hint that how long the cat can sleep.

\n
public static void Sleep(this ICat icat, long hours)\n
\n

Parameters

\n

icat ICat

\n

The type will be extended.

\n

hours long

\n

The length of sleep.

\n", + "conceptual": "\n

Namespace: CatLibrary
\nAssembly: CatLibrary.dll

\n

It's the class that contains ICat interface's extension method.

\n

This class must be public and static.

\n

Also it shouldn't be a geneic class

\n
public static class ICatExtension\n
\n

Inheritance

\n

object ←\nICatExtension

\n

Inherited Members

\n

object.Equals(object?),\nobject.Equals(object?, object?),\nobject.GetHashCode(),\nobject.GetType(),\nobject.MemberwiseClone(),\nobject.ReferenceEquals(object?, object?),\nobject.ToString()

\n

Methods

\n

Play(ICat, ColorType)

\n

Extension method to let cat play

\n
public static void Play(this ICat icat, ContainersRefType.ColorType toy)\n
\n

Parameters

\n

icat ICat

\n

Cat

\n

toy ContainersRefType.ColorType

\n

Something to play

\n

Sleep(ICat, long)

\n

Extension method hint that how long the cat can sleep.

\n
public static void Sleep(this ICat icat, long hours)\n
\n

Parameters

\n

icat ICat

\n

The type will be extended.

\n

hours long

\n

The length of sleep.

\n", "type": "Conceptual", "source": { "remote": { diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.html.view.verified.json index 84116296562..eec926a8103 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

Namespaces

\n

CatLibrary.Core

\n

Classes

\n

Cat<T, K>

\n

Here's main class of this Demo.

\n

You can see mostly type of article within this class and you for more detail, please see the remarks.

\n

\n

this class is a template class. It has two Generic parameter. they are: T and K.

\n

The extension method of this class can refer to class

\n

CatException<T>

\n

Complex<T, J>

\n

ICatExtension

\n

It's the class that contains ICat interface's extension method.

\n

This class must be public and static.

Also it shouldn't be a geneic class

\n

Tom

\n

Tom class is only inherit from Object. Not any member inside itself.

\n

TomFromBaseClass

\n

TomFromBaseClass inherits from @

\n

Interfaces

\n

IAnimal

\n

This is basic interface of all animal.

\n

ICat

\n

Cat's interface

\n

Delegates

\n

FakeDelegate<T>

\n

Fake delegate

\n

MRefDelegate<K, T, L>

\n

Generic delegate with many constrains.

\n

MRefNormalDelegate

\n

Delegate in the namespace

\n", + "conceptual": "\n

Namespaces

\n

CatLibrary.Core

\n

Classes

\n

Cat<T, K>

\n

Here's main class of this Demo.

\n

You can see mostly type of article within this class and you for more detail, please see the remarks.

\n

\n

this class is a template class. It has two Generic parameter. they are: T and K.

\n

The extension method of this class can refer to class

\n

CatException<T>

\n

Complex<T, J>

\n

ICatExtension

\n

It's the class that contains ICat interface's extension method.

\n

This class must be public and static.

\n

Also it shouldn't be a geneic class

\n

Tom

\n

Tom class is only inherit from Object. Not any member inside itself.

\n

TomFromBaseClass

\n

TomFromBaseClass inherits from @

\n

Interfaces

\n

IAnimal

\n

This is basic interface of all animal.

\n

ICat

\n

Cat's interface

\n

Delegates

\n

FakeDelegate<T>

\n

Fake delegate

\n

MRefDelegate<K, T, L>

\n

Generic delegate with many constrains.

\n

MRefNormalDelegate

\n

Delegate in the namespace

\n", "type": "Conceptual", "source": { "remote": { diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/toc.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/toc.html.view.verified.json index 13e585813c0..2bc12ed1ed1 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/toc.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/toc.html.view.verified.json @@ -260,6 +260,24 @@ "items": [], "leaf": true }, + { + "name": "Inheritdoc.Issue9736", + "href": "BuildFromProject.Inheritdoc.Issue9736.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue9736.html", + "tocHref": null, + "level": 3, + "items": [], + "leaf": true + }, + { + "name": "Inheritdoc.Issue9736.JsonApiOptions", + "href": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "tocHref": null, + "level": 3, + "items": [], + "leaf": true + }, { "name": "Issue8725", "href": "BuildFromProject.Issue8725.html", @@ -312,6 +330,15 @@ "items": [], "leaf": true }, + { + "name": "Inheritdoc.Issue9736.IJsonApiOptions", + "href": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "tocHref": null, + "level": 3, + "items": [], + "leaf": true + }, { "name": "Enums", "topicHref": null, diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/toc.json.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/toc.json.view.verified.json index 769ecbab285..bfdc7d78b39 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/toc.json.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/toc.json.view.verified.json @@ -1,3 +1,3 @@ { - "content": "{\"items\":[{\"name\":\"BuildFromAssembly\",\"href\":\"BuildFromAssembly.html\",\"topicHref\":\"BuildFromAssembly.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"Class1\",\"href\":\"BuildFromAssembly.Class1.html\",\"topicHref\":\"BuildFromAssembly.Class1.html\"},{\"name\":\"Structs\"},{\"name\":\"Issue5432\",\"href\":\"BuildFromAssembly.Issue5432.html\",\"topicHref\":\"BuildFromAssembly.Issue5432.html\"}]},{\"name\":\"BuildFromCSharpSourceCode\",\"href\":\"BuildFromCSharpSourceCode.html\",\"topicHref\":\"BuildFromCSharpSourceCode.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"CSharp\",\"href\":\"BuildFromCSharpSourceCode.CSharp.html\",\"topicHref\":\"BuildFromCSharpSourceCode.CSharp.html\"}]},{\"name\":\"BuildFromProject\",\"href\":\"BuildFromProject.html\",\"topicHref\":\"BuildFromProject.html\",\"items\":[{\"name\":\"Issue8540\",\"href\":\"BuildFromProject.Issue8540.html\",\"topicHref\":\"BuildFromProject.Issue8540.html\",\"items\":[{\"name\":\"A\",\"href\":\"BuildFromProject.Issue8540.A.html\",\"topicHref\":\"BuildFromProject.Issue8540.A.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"A\",\"href\":\"BuildFromProject.Issue8540.A.A.html\",\"topicHref\":\"BuildFromProject.Issue8540.A.A.html\"}]},{\"name\":\"B\",\"href\":\"BuildFromProject.Issue8540.B.html\",\"topicHref\":\"BuildFromProject.Issue8540.B.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"B\",\"href\":\"BuildFromProject.Issue8540.B.B.html\",\"topicHref\":\"BuildFromProject.Issue8540.B.B.html\"}]}]},{\"name\":\"Classes\"},{\"name\":\"Class1\",\"href\":\"BuildFromProject.Class1.html\",\"topicHref\":\"BuildFromProject.Class1.html\"},{\"name\":\"Class1.Issue8665\",\"href\":\"BuildFromProject.Class1.Issue8665.html\",\"topicHref\":\"BuildFromProject.Class1.Issue8665.html\"},{\"name\":\"Class1.Issue8696Attribute\",\"href\":\"BuildFromProject.Class1.Issue8696Attribute.html\",\"topicHref\":\"BuildFromProject.Class1.Issue8696Attribute.html\"},{\"name\":\"Class1.Issue8948\",\"href\":\"BuildFromProject.Class1.Issue8948.html\",\"topicHref\":\"BuildFromProject.Class1.Issue8948.html\"},{\"name\":\"Class1.Test\",\"href\":\"BuildFromProject.Class1.Test-1.html\",\"topicHref\":\"BuildFromProject.Class1.Test-1.html\"},{\"name\":\"Dog\",\"href\":\"BuildFromProject.Dog.html\",\"topicHref\":\"BuildFromProject.Dog.html\"},{\"name\":\"Inheritdoc\",\"href\":\"BuildFromProject.Inheritdoc.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.html\"},{\"name\":\"Inheritdoc.Issue6366\",\"href\":\"BuildFromProject.Inheritdoc.Issue6366.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue6366.html\"},{\"name\":\"Inheritdoc.Issue6366.Class1\",\"href\":\"BuildFromProject.Inheritdoc.Issue6366.Class1-1.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue6366.Class1-1.html\"},{\"name\":\"Inheritdoc.Issue6366.Class2\",\"href\":\"BuildFromProject.Inheritdoc.Issue6366.Class2.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue6366.Class2.html\"},{\"name\":\"Inheritdoc.Issue7035\",\"href\":\"BuildFromProject.Inheritdoc.Issue7035.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue7035.html\"},{\"name\":\"Inheritdoc.Issue7484\",\"href\":\"BuildFromProject.Inheritdoc.Issue7484.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue7484.html\"},{\"name\":\"Inheritdoc.Issue8101\",\"href\":\"BuildFromProject.Inheritdoc.Issue8101.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue8101.html\"},{\"name\":\"Issue8725\",\"href\":\"BuildFromProject.Issue8725.html\",\"topicHref\":\"BuildFromProject.Issue8725.html\"},{\"name\":\"Structs\"},{\"name\":\"Inheritdoc.Issue8129\",\"href\":\"BuildFromProject.Inheritdoc.Issue8129.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue8129.html\"},{\"name\":\"Interfaces\"},{\"name\":\"Class1.IIssue8948\",\"href\":\"BuildFromProject.Class1.IIssue8948.html\",\"topicHref\":\"BuildFromProject.Class1.IIssue8948.html\"},{\"name\":\"IInheritdoc\",\"href\":\"BuildFromProject.IInheritdoc.html\",\"topicHref\":\"BuildFromProject.IInheritdoc.html\"},{\"name\":\"Enums\"},{\"name\":\"Class1.Issue9260\",\"href\":\"BuildFromProject.Class1.Issue9260.html\",\"topicHref\":\"BuildFromProject.Class1.Issue9260.html\"}]},{\"name\":\"BuildFromVBSourceCode\",\"href\":\"BuildFromVBSourceCode.html\",\"topicHref\":\"BuildFromVBSourceCode.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"BaseClass1\",\"href\":\"BuildFromVBSourceCode.BaseClass1.html\",\"topicHref\":\"BuildFromVBSourceCode.BaseClass1.html\"},{\"name\":\"Class1\",\"href\":\"BuildFromVBSourceCode.Class1.html\",\"topicHref\":\"BuildFromVBSourceCode.Class1.html\"}]},{\"name\":\"CatLibrary\",\"href\":\"CatLibrary.html\",\"topicHref\":\"CatLibrary.html\",\"items\":[{\"name\":\"Core\",\"href\":\"CatLibrary.Core.html\",\"topicHref\":\"CatLibrary.Core.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"ContainersRefType.ContainersRefTypeChild\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\"},{\"name\":\"ExplicitLayoutClass\",\"href\":\"CatLibrary.Core.ExplicitLayoutClass.html\",\"topicHref\":\"CatLibrary.Core.ExplicitLayoutClass.html\"},{\"name\":\"Issue231\",\"href\":\"CatLibrary.Core.Issue231.html\",\"topicHref\":\"CatLibrary.Core.Issue231.html\"},{\"name\":\"Structs\"},{\"name\":\"ContainersRefType\",\"href\":\"CatLibrary.Core.ContainersRefType.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.html\"},{\"name\":\"Interfaces\"},{\"name\":\"ContainersRefType.ContainersRefTypeChildInterface\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\"},{\"name\":\"Enums\"},{\"name\":\"ContainersRefType.ColorType\",\"href\":\"CatLibrary.Core.ContainersRefType.ColorType.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ColorType.html\"},{\"name\":\"Delegates\"},{\"name\":\"ContainersRefType.ContainersRefTypeDelegate\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\"}]},{\"name\":\"Classes\"},{\"name\":\"Cat\",\"href\":\"CatLibrary.Cat-2.html\",\"topicHref\":\"CatLibrary.Cat-2.html\"},{\"name\":\"CatException\",\"href\":\"CatLibrary.CatException-1.html\",\"topicHref\":\"CatLibrary.CatException-1.html\"},{\"name\":\"Complex\",\"href\":\"CatLibrary.Complex-2.html\",\"topicHref\":\"CatLibrary.Complex-2.html\"},{\"name\":\"ICatExtension\",\"href\":\"CatLibrary.ICatExtension.html\",\"topicHref\":\"CatLibrary.ICatExtension.html\"},{\"name\":\"Tom\",\"href\":\"CatLibrary.Tom.html\",\"topicHref\":\"CatLibrary.Tom.html\"},{\"name\":\"TomFromBaseClass\",\"href\":\"CatLibrary.TomFromBaseClass.html\",\"topicHref\":\"CatLibrary.TomFromBaseClass.html\"},{\"name\":\"Interfaces\"},{\"name\":\"IAnimal\",\"href\":\"CatLibrary.IAnimal.html\",\"topicHref\":\"CatLibrary.IAnimal.html\"},{\"name\":\"ICat\",\"href\":\"CatLibrary.ICat.html\",\"topicHref\":\"CatLibrary.ICat.html\"},{\"name\":\"Delegates\"},{\"name\":\"FakeDelegate\",\"href\":\"CatLibrary.FakeDelegate-1.html\",\"topicHref\":\"CatLibrary.FakeDelegate-1.html\"},{\"name\":\"MRefDelegate\",\"href\":\"CatLibrary.MRefDelegate-3.html\",\"topicHref\":\"CatLibrary.MRefDelegate-3.html\"},{\"name\":\"MRefNormalDelegate\",\"href\":\"CatLibrary.MRefNormalDelegate.html\",\"topicHref\":\"CatLibrary.MRefNormalDelegate.html\"}]},{\"name\":\"MRef\",\"href\":\"MRef.html\",\"topicHref\":\"MRef.html\",\"items\":[{\"name\":\"Demo\",\"href\":\"MRef.Demo.html\",\"topicHref\":\"MRef.Demo.html\",\"items\":[{\"name\":\"Enumeration\",\"href\":\"MRef.Demo.Enumeration.html\",\"topicHref\":\"MRef.Demo.Enumeration.html\",\"items\":[{\"name\":\"Enums\"},{\"name\":\"ColorType\",\"href\":\"MRef.Demo.Enumeration.ColorType.html\",\"topicHref\":\"MRef.Demo.Enumeration.ColorType.html\"}]}]}]}],\"pdf\":true,\"pdfTocPage\":true}" + "content": "{\"items\":[{\"name\":\"BuildFromAssembly\",\"href\":\"BuildFromAssembly.html\",\"topicHref\":\"BuildFromAssembly.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"Class1\",\"href\":\"BuildFromAssembly.Class1.html\",\"topicHref\":\"BuildFromAssembly.Class1.html\"},{\"name\":\"Structs\"},{\"name\":\"Issue5432\",\"href\":\"BuildFromAssembly.Issue5432.html\",\"topicHref\":\"BuildFromAssembly.Issue5432.html\"}]},{\"name\":\"BuildFromCSharpSourceCode\",\"href\":\"BuildFromCSharpSourceCode.html\",\"topicHref\":\"BuildFromCSharpSourceCode.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"CSharp\",\"href\":\"BuildFromCSharpSourceCode.CSharp.html\",\"topicHref\":\"BuildFromCSharpSourceCode.CSharp.html\"}]},{\"name\":\"BuildFromProject\",\"href\":\"BuildFromProject.html\",\"topicHref\":\"BuildFromProject.html\",\"items\":[{\"name\":\"Issue8540\",\"href\":\"BuildFromProject.Issue8540.html\",\"topicHref\":\"BuildFromProject.Issue8540.html\",\"items\":[{\"name\":\"A\",\"href\":\"BuildFromProject.Issue8540.A.html\",\"topicHref\":\"BuildFromProject.Issue8540.A.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"A\",\"href\":\"BuildFromProject.Issue8540.A.A.html\",\"topicHref\":\"BuildFromProject.Issue8540.A.A.html\"}]},{\"name\":\"B\",\"href\":\"BuildFromProject.Issue8540.B.html\",\"topicHref\":\"BuildFromProject.Issue8540.B.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"B\",\"href\":\"BuildFromProject.Issue8540.B.B.html\",\"topicHref\":\"BuildFromProject.Issue8540.B.B.html\"}]}]},{\"name\":\"Classes\"},{\"name\":\"Class1\",\"href\":\"BuildFromProject.Class1.html\",\"topicHref\":\"BuildFromProject.Class1.html\"},{\"name\":\"Class1.Issue8665\",\"href\":\"BuildFromProject.Class1.Issue8665.html\",\"topicHref\":\"BuildFromProject.Class1.Issue8665.html\"},{\"name\":\"Class1.Issue8696Attribute\",\"href\":\"BuildFromProject.Class1.Issue8696Attribute.html\",\"topicHref\":\"BuildFromProject.Class1.Issue8696Attribute.html\"},{\"name\":\"Class1.Issue8948\",\"href\":\"BuildFromProject.Class1.Issue8948.html\",\"topicHref\":\"BuildFromProject.Class1.Issue8948.html\"},{\"name\":\"Class1.Test\",\"href\":\"BuildFromProject.Class1.Test-1.html\",\"topicHref\":\"BuildFromProject.Class1.Test-1.html\"},{\"name\":\"Dog\",\"href\":\"BuildFromProject.Dog.html\",\"topicHref\":\"BuildFromProject.Dog.html\"},{\"name\":\"Inheritdoc\",\"href\":\"BuildFromProject.Inheritdoc.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.html\"},{\"name\":\"Inheritdoc.Issue6366\",\"href\":\"BuildFromProject.Inheritdoc.Issue6366.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue6366.html\"},{\"name\":\"Inheritdoc.Issue6366.Class1\",\"href\":\"BuildFromProject.Inheritdoc.Issue6366.Class1-1.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue6366.Class1-1.html\"},{\"name\":\"Inheritdoc.Issue6366.Class2\",\"href\":\"BuildFromProject.Inheritdoc.Issue6366.Class2.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue6366.Class2.html\"},{\"name\":\"Inheritdoc.Issue7035\",\"href\":\"BuildFromProject.Inheritdoc.Issue7035.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue7035.html\"},{\"name\":\"Inheritdoc.Issue7484\",\"href\":\"BuildFromProject.Inheritdoc.Issue7484.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue7484.html\"},{\"name\":\"Inheritdoc.Issue8101\",\"href\":\"BuildFromProject.Inheritdoc.Issue8101.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue8101.html\"},{\"name\":\"Inheritdoc.Issue9736\",\"href\":\"BuildFromProject.Inheritdoc.Issue9736.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue9736.html\"},{\"name\":\"Inheritdoc.Issue9736.JsonApiOptions\",\"href\":\"BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html\"},{\"name\":\"Issue8725\",\"href\":\"BuildFromProject.Issue8725.html\",\"topicHref\":\"BuildFromProject.Issue8725.html\"},{\"name\":\"Structs\"},{\"name\":\"Inheritdoc.Issue8129\",\"href\":\"BuildFromProject.Inheritdoc.Issue8129.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue8129.html\"},{\"name\":\"Interfaces\"},{\"name\":\"Class1.IIssue8948\",\"href\":\"BuildFromProject.Class1.IIssue8948.html\",\"topicHref\":\"BuildFromProject.Class1.IIssue8948.html\"},{\"name\":\"IInheritdoc\",\"href\":\"BuildFromProject.IInheritdoc.html\",\"topicHref\":\"BuildFromProject.IInheritdoc.html\"},{\"name\":\"Inheritdoc.Issue9736.IJsonApiOptions\",\"href\":\"BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html\",\"topicHref\":\"BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html\"},{\"name\":\"Enums\"},{\"name\":\"Class1.Issue9260\",\"href\":\"BuildFromProject.Class1.Issue9260.html\",\"topicHref\":\"BuildFromProject.Class1.Issue9260.html\"}]},{\"name\":\"BuildFromVBSourceCode\",\"href\":\"BuildFromVBSourceCode.html\",\"topicHref\":\"BuildFromVBSourceCode.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"BaseClass1\",\"href\":\"BuildFromVBSourceCode.BaseClass1.html\",\"topicHref\":\"BuildFromVBSourceCode.BaseClass1.html\"},{\"name\":\"Class1\",\"href\":\"BuildFromVBSourceCode.Class1.html\",\"topicHref\":\"BuildFromVBSourceCode.Class1.html\"}]},{\"name\":\"CatLibrary\",\"href\":\"CatLibrary.html\",\"topicHref\":\"CatLibrary.html\",\"items\":[{\"name\":\"Core\",\"href\":\"CatLibrary.Core.html\",\"topicHref\":\"CatLibrary.Core.html\",\"items\":[{\"name\":\"Classes\"},{\"name\":\"ContainersRefType.ContainersRefTypeChild\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\"},{\"name\":\"ExplicitLayoutClass\",\"href\":\"CatLibrary.Core.ExplicitLayoutClass.html\",\"topicHref\":\"CatLibrary.Core.ExplicitLayoutClass.html\"},{\"name\":\"Issue231\",\"href\":\"CatLibrary.Core.Issue231.html\",\"topicHref\":\"CatLibrary.Core.Issue231.html\"},{\"name\":\"Structs\"},{\"name\":\"ContainersRefType\",\"href\":\"CatLibrary.Core.ContainersRefType.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.html\"},{\"name\":\"Interfaces\"},{\"name\":\"ContainersRefType.ContainersRefTypeChildInterface\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\"},{\"name\":\"Enums\"},{\"name\":\"ContainersRefType.ColorType\",\"href\":\"CatLibrary.Core.ContainersRefType.ColorType.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ColorType.html\"},{\"name\":\"Delegates\"},{\"name\":\"ContainersRefType.ContainersRefTypeDelegate\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\"}]},{\"name\":\"Classes\"},{\"name\":\"Cat\",\"href\":\"CatLibrary.Cat-2.html\",\"topicHref\":\"CatLibrary.Cat-2.html\"},{\"name\":\"CatException\",\"href\":\"CatLibrary.CatException-1.html\",\"topicHref\":\"CatLibrary.CatException-1.html\"},{\"name\":\"Complex\",\"href\":\"CatLibrary.Complex-2.html\",\"topicHref\":\"CatLibrary.Complex-2.html\"},{\"name\":\"ICatExtension\",\"href\":\"CatLibrary.ICatExtension.html\",\"topicHref\":\"CatLibrary.ICatExtension.html\"},{\"name\":\"Tom\",\"href\":\"CatLibrary.Tom.html\",\"topicHref\":\"CatLibrary.Tom.html\"},{\"name\":\"TomFromBaseClass\",\"href\":\"CatLibrary.TomFromBaseClass.html\",\"topicHref\":\"CatLibrary.TomFromBaseClass.html\"},{\"name\":\"Interfaces\"},{\"name\":\"IAnimal\",\"href\":\"CatLibrary.IAnimal.html\",\"topicHref\":\"CatLibrary.IAnimal.html\"},{\"name\":\"ICat\",\"href\":\"CatLibrary.ICat.html\",\"topicHref\":\"CatLibrary.ICat.html\"},{\"name\":\"Delegates\"},{\"name\":\"FakeDelegate\",\"href\":\"CatLibrary.FakeDelegate-1.html\",\"topicHref\":\"CatLibrary.FakeDelegate-1.html\"},{\"name\":\"MRefDelegate\",\"href\":\"CatLibrary.MRefDelegate-3.html\",\"topicHref\":\"CatLibrary.MRefDelegate-3.html\"},{\"name\":\"MRefNormalDelegate\",\"href\":\"CatLibrary.MRefNormalDelegate.html\",\"topicHref\":\"CatLibrary.MRefNormalDelegate.html\"}]},{\"name\":\"MRef\",\"href\":\"MRef.html\",\"topicHref\":\"MRef.html\",\"items\":[{\"name\":\"Demo\",\"href\":\"MRef.Demo.html\",\"topicHref\":\"MRef.Demo.html\",\"items\":[{\"name\":\"Enumeration\",\"href\":\"MRef.Demo.Enumeration.html\",\"topicHref\":\"MRef.Demo.Enumeration.html\",\"items\":[{\"name\":\"Enums\"},{\"name\":\"ColorType\",\"href\":\"MRef.Demo.Enumeration.ColorType.html\",\"topicHref\":\"MRef.Demo.Enumeration.ColorType.html\"}]}]}]}],\"pdf\":true,\"pdfTocPage\":true}" } \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/toc.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/toc.verified.json index 7438292da37..41c2f91ce3b 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/toc.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/toc.verified.json @@ -148,6 +148,16 @@ "href": "BuildFromProject.Inheritdoc.Issue8101.html", "topicHref": "BuildFromProject.Inheritdoc.Issue8101.html" }, + { + "name": "Inheritdoc.Issue9736", + "href": "BuildFromProject.Inheritdoc.Issue9736.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue9736.html" + }, + { + "name": "Inheritdoc.Issue9736.JsonApiOptions", + "href": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html" + }, { "name": "Issue8725", "href": "BuildFromProject.Issue8725.html", @@ -174,6 +184,11 @@ "href": "BuildFromProject.IInheritdoc.html", "topicHref": "BuildFromProject.IInheritdoc.html" }, + { + "name": "Inheritdoc.Issue9736.IJsonApiOptions", + "href": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html" + }, { "name": "Enums" }, diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/pdf/toc.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/pdf/toc.html.view.verified.json index e4fa2a6576d..43a1cf74854 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/pdf/toc.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/pdf/toc.html.view.verified.json @@ -380,6 +380,39 @@ "items": [], "leaf": true }, + { + "name": "Inheritdoc.Issue9736", + "href": "../api/BuildFromProject.Inheritdoc.Issue9736.html", + "topicHref": "../api/BuildFromProject.Inheritdoc.Issue9736.html", + "topicUid": "BuildFromProject.Inheritdoc.Issue9736", + "type": "Class", + "tocHref": null, + "level": 4, + "items": [], + "leaf": true + }, + { + "name": "Inheritdoc.Issue9736.IJsonApiOptions", + "href": "../api/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "topicHref": "../api/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "topicUid": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions", + "type": "Interface", + "tocHref": null, + "level": 4, + "items": [], + "leaf": true + }, + { + "name": "Inheritdoc.Issue9736.JsonApiOptions", + "href": "../api/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "topicHref": "../api/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "topicUid": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions", + "type": "Class", + "tocHref": null, + "level": 4, + "items": [], + "leaf": true + }, { "name": "Issue8725", "href": "../api/BuildFromProject.Issue8725.html", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/pdf/toc.json.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/pdf/toc.json.view.verified.json index 4c6851c08ef..c1a21731f2e 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/pdf/toc.json.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/pdf/toc.json.view.verified.json @@ -1,3 +1,3 @@ { - "content": "{\"order\":200,\"items\":[{\"name\":\"Articles\",\"includedFrom\":\"~/articles/toc.yml\",\"items\":[{\"name\":\"Getting Started with docfx\",\"href\":\"../articles/docfx_getting_started.html\",\"topicHref\":\"../articles/docfx_getting_started.html\"},{\"name\":\"Engineering Docs\",\"items\":[{\"name\":\"Section 1\"},{\"name\":\"Engineering Guidelines\",\"href\":\"../articles/engineering_guidelines.html\",\"topicHref\":\"../articles/engineering_guidelines.html\"},{\"name\":\"C# Coding Standards\",\"href\":\"../articles/csharp_coding_standards.html\",\"topicHref\":\"../articles/csharp_coding_standards.html\"}],\"expanded\":true},{\"name\":\"Markdown\",\"href\":\"../articles/markdown.html\",\"topicHref\":\"../articles/markdown.html\"},{\"name\":\"Microsoft Docs\",\"href\":\"https://docs.microsoft.com/en-us/\",\"topicHref\":\"https://docs.microsoft.com/en-us/\"}]},{\"name\":\"API Documentation\",\"includedFrom\":\"~/obj/api/toc.yml\",\"items\":[{\"name\":\"BuildFromAssembly\",\"href\":\"../api/BuildFromAssembly.html\",\"topicHref\":\"../api/BuildFromAssembly.html\",\"topicUid\":\"BuildFromAssembly\",\"type\":\"Namespace\",\"items\":[{\"name\":\"Class1\",\"href\":\"../api/BuildFromAssembly.Class1.html\",\"topicHref\":\"../api/BuildFromAssembly.Class1.html\",\"topicUid\":\"BuildFromAssembly.Class1\",\"type\":\"Class\"},{\"name\":\"Issue5432\",\"href\":\"../api/BuildFromAssembly.Issue5432.html\",\"topicHref\":\"../api/BuildFromAssembly.Issue5432.html\",\"topicUid\":\"BuildFromAssembly.Issue5432\",\"type\":\"Struct\"}]},{\"name\":\"BuildFromCSharpSourceCode\",\"href\":\"../api/BuildFromCSharpSourceCode.html\",\"topicHref\":\"../api/BuildFromCSharpSourceCode.html\",\"topicUid\":\"BuildFromCSharpSourceCode\",\"type\":\"Namespace\",\"items\":[{\"name\":\"CSharp\",\"href\":\"../api/BuildFromCSharpSourceCode.CSharp.html\",\"topicHref\":\"../api/BuildFromCSharpSourceCode.CSharp.html\",\"topicUid\":\"BuildFromCSharpSourceCode.CSharp\",\"type\":\"Class\"}]},{\"name\":\"BuildFromProject\",\"href\":\"../api/BuildFromProject.html\",\"topicHref\":\"../api/BuildFromProject.html\",\"topicUid\":\"BuildFromProject\",\"type\":\"Namespace\",\"items\":[{\"name\":\"Issue8540\",\"href\":\"../api/BuildFromProject.Issue8540.html\",\"topicHref\":\"../api/BuildFromProject.Issue8540.html\",\"topicUid\":\"BuildFromProject.Issue8540\",\"type\":\"Namespace\",\"items\":[{\"name\":\"A\",\"href\":\"../api/BuildFromProject.Issue8540.A.html\",\"topicHref\":\"../api/BuildFromProject.Issue8540.A.html\",\"topicUid\":\"BuildFromProject.Issue8540.A\",\"type\":\"Namespace\",\"items\":[{\"name\":\"A\",\"href\":\"../api/BuildFromProject.Issue8540.A.A.html\",\"topicHref\":\"../api/BuildFromProject.Issue8540.A.A.html\",\"topicUid\":\"BuildFromProject.Issue8540.A.A\",\"type\":\"Class\"}]},{\"name\":\"B\",\"href\":\"../api/BuildFromProject.Issue8540.B.html\",\"topicHref\":\"../api/BuildFromProject.Issue8540.B.html\",\"topicUid\":\"BuildFromProject.Issue8540.B\",\"type\":\"Namespace\",\"items\":[{\"name\":\"B\",\"href\":\"../api/BuildFromProject.Issue8540.B.B.html\",\"topicHref\":\"../api/BuildFromProject.Issue8540.B.B.html\",\"topicUid\":\"BuildFromProject.Issue8540.B.B\",\"type\":\"Class\"}]}]},{\"name\":\"Class1\",\"href\":\"../api/BuildFromProject.Class1.html\",\"topicHref\":\"../api/BuildFromProject.Class1.html\",\"topicUid\":\"BuildFromProject.Class1\",\"type\":\"Class\"},{\"name\":\"Class1.IIssue8948\",\"href\":\"../api/BuildFromProject.Class1.IIssue8948.html\",\"topicHref\":\"../api/BuildFromProject.Class1.IIssue8948.html\",\"topicUid\":\"BuildFromProject.Class1.IIssue8948\",\"type\":\"Interface\"},{\"name\":\"Class1.Issue8665\",\"href\":\"../api/BuildFromProject.Class1.Issue8665.html\",\"topicHref\":\"../api/BuildFromProject.Class1.Issue8665.html\",\"topicUid\":\"BuildFromProject.Class1.Issue8665\",\"type\":\"Class\"},{\"name\":\"Class1.Issue8696Attribute\",\"href\":\"../api/BuildFromProject.Class1.Issue8696Attribute.html\",\"topicHref\":\"../api/BuildFromProject.Class1.Issue8696Attribute.html\",\"topicUid\":\"BuildFromProject.Class1.Issue8696Attribute\",\"type\":\"Class\"},{\"name\":\"Class1.Issue8948\",\"href\":\"../api/BuildFromProject.Class1.Issue8948.html\",\"topicHref\":\"../api/BuildFromProject.Class1.Issue8948.html\",\"topicUid\":\"BuildFromProject.Class1.Issue8948\",\"type\":\"Class\"},{\"name\":\"Class1.Issue9260\",\"href\":\"../api/BuildFromProject.Class1.Issue9260.html\",\"topicHref\":\"../api/BuildFromProject.Class1.Issue9260.html\",\"topicUid\":\"BuildFromProject.Class1.Issue9260\",\"type\":\"Enum\"},{\"name\":\"Class1.Test\",\"href\":\"../api/BuildFromProject.Class1.Test-1.html\",\"topicHref\":\"../api/BuildFromProject.Class1.Test-1.html\",\"topicUid\":\"BuildFromProject.Class1.Test`1\",\"type\":\"Class\"},{\"name\":\"Dog\",\"href\":\"../api/BuildFromProject.Dog.html\",\"topicHref\":\"../api/BuildFromProject.Dog.html\",\"topicUid\":\"BuildFromProject.Dog\",\"type\":\"Class\"},{\"name\":\"IInheritdoc\",\"href\":\"../api/BuildFromProject.IInheritdoc.html\",\"topicHref\":\"../api/BuildFromProject.IInheritdoc.html\",\"topicUid\":\"BuildFromProject.IInheritdoc\",\"type\":\"Interface\"},{\"name\":\"Inheritdoc\",\"href\":\"../api/BuildFromProject.Inheritdoc.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.html\",\"topicUid\":\"BuildFromProject.Inheritdoc\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue6366\",\"href\":\"../api/BuildFromProject.Inheritdoc.Issue6366.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.Issue6366.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue6366\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue6366.Class1\",\"href\":\"../api/BuildFromProject.Inheritdoc.Issue6366.Class1-1.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.Issue6366.Class1-1.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue6366.Class1`1\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue6366.Class2\",\"href\":\"../api/BuildFromProject.Inheritdoc.Issue6366.Class2.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.Issue6366.Class2.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue6366.Class2\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue7035\",\"href\":\"../api/BuildFromProject.Inheritdoc.Issue7035.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.Issue7035.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue7035\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue7484\",\"href\":\"../api/BuildFromProject.Inheritdoc.Issue7484.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.Issue7484.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue7484\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue8101\",\"href\":\"../api/BuildFromProject.Inheritdoc.Issue8101.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.Issue8101.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue8101\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue8129\",\"href\":\"../api/BuildFromProject.Inheritdoc.Issue8129.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.Issue8129.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue8129\",\"type\":\"Struct\"},{\"name\":\"Issue8725\",\"href\":\"../api/BuildFromProject.Issue8725.html\",\"topicHref\":\"../api/BuildFromProject.Issue8725.html\",\"topicUid\":\"BuildFromProject.Issue8725\",\"type\":\"Class\"}]},{\"name\":\"BuildFromVBSourceCode\",\"href\":\"../api/BuildFromVBSourceCode.html\",\"topicHref\":\"../api/BuildFromVBSourceCode.html\",\"topicUid\":\"BuildFromVBSourceCode\",\"type\":\"Namespace\",\"items\":[{\"name\":\"BaseClass1\",\"href\":\"../api/BuildFromVBSourceCode.BaseClass1.html\",\"topicHref\":\"../api/BuildFromVBSourceCode.BaseClass1.html\",\"topicUid\":\"BuildFromVBSourceCode.BaseClass1\",\"type\":\"Class\"},{\"name\":\"Class1\",\"href\":\"../api/BuildFromVBSourceCode.Class1.html\",\"topicHref\":\"../api/BuildFromVBSourceCode.Class1.html\",\"topicUid\":\"BuildFromVBSourceCode.Class1\",\"type\":\"Class\"}]},{\"name\":\"CatLibrary\",\"href\":\"../api/CatLibrary.html\",\"topicHref\":\"../api/CatLibrary.html\",\"topicUid\":\"CatLibrary\",\"type\":\"Namespace\",\"items\":[{\"name\":\"Core\",\"href\":\"../api/CatLibrary.Core.html\",\"topicHref\":\"../api/CatLibrary.Core.html\",\"topicUid\":\"CatLibrary.Core\",\"type\":\"Namespace\",\"items\":[{\"name\":\"ContainersRefType\",\"href\":\"../api/CatLibrary.Core.ContainersRefType.html\",\"topicHref\":\"../api/CatLibrary.Core.ContainersRefType.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType\",\"type\":\"Struct\"},{\"name\":\"ContainersRefType.ColorType\",\"href\":\"../api/CatLibrary.Core.ContainersRefType.ColorType.html\",\"topicHref\":\"../api/CatLibrary.Core.ContainersRefType.ColorType.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ColorType\",\"type\":\"Enum\"},{\"name\":\"ContainersRefType.ContainersRefTypeChild\",\"href\":\"../api/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\",\"topicHref\":\"../api/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild\",\"type\":\"Class\"},{\"name\":\"ContainersRefType.ContainersRefTypeChildInterface\",\"href\":\"../api/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\",\"topicHref\":\"../api/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface\",\"type\":\"Interface\"},{\"name\":\"ContainersRefType.ContainersRefTypeDelegate\",\"href\":\"../api/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\",\"topicHref\":\"../api/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate\",\"type\":\"Delegate\"},{\"name\":\"ExplicitLayoutClass\",\"href\":\"../api/CatLibrary.Core.ExplicitLayoutClass.html\",\"topicHref\":\"../api/CatLibrary.Core.ExplicitLayoutClass.html\",\"topicUid\":\"CatLibrary.Core.ExplicitLayoutClass\",\"type\":\"Class\"},{\"name\":\"Issue231\",\"href\":\"../api/CatLibrary.Core.Issue231.html\",\"topicHref\":\"../api/CatLibrary.Core.Issue231.html\",\"topicUid\":\"CatLibrary.Core.Issue231\",\"type\":\"Class\"}]},{\"name\":\"CatException\",\"href\":\"../api/CatLibrary.CatException-1.html\",\"topicHref\":\"../api/CatLibrary.CatException-1.html\",\"topicUid\":\"CatLibrary.CatException`1\",\"type\":\"Class\"},{\"name\":\"Cat\",\"href\":\"../api/CatLibrary.Cat-2.html\",\"topicHref\":\"../api/CatLibrary.Cat-2.html\",\"topicUid\":\"CatLibrary.Cat`2\",\"type\":\"Class\"},{\"name\":\"Complex\",\"href\":\"../api/CatLibrary.Complex-2.html\",\"topicHref\":\"../api/CatLibrary.Complex-2.html\",\"topicUid\":\"CatLibrary.Complex`2\",\"type\":\"Class\"},{\"name\":\"FakeDelegate\",\"href\":\"../api/CatLibrary.FakeDelegate-1.html\",\"topicHref\":\"../api/CatLibrary.FakeDelegate-1.html\",\"topicUid\":\"CatLibrary.FakeDelegate`1\",\"type\":\"Delegate\"},{\"name\":\"IAnimal\",\"href\":\"../api/CatLibrary.IAnimal.html\",\"topicHref\":\"../api/CatLibrary.IAnimal.html\",\"topicUid\":\"CatLibrary.IAnimal\",\"type\":\"Interface\"},{\"name\":\"ICat\",\"href\":\"../api/CatLibrary.ICat.html\",\"topicHref\":\"../api/CatLibrary.ICat.html\",\"topicUid\":\"CatLibrary.ICat\",\"type\":\"Interface\"},{\"name\":\"ICatExtension\",\"href\":\"../api/CatLibrary.ICatExtension.html\",\"topicHref\":\"../api/CatLibrary.ICatExtension.html\",\"topicUid\":\"CatLibrary.ICatExtension\",\"type\":\"Class\"},{\"name\":\"MRefDelegate\",\"href\":\"../api/CatLibrary.MRefDelegate-3.html\",\"topicHref\":\"../api/CatLibrary.MRefDelegate-3.html\",\"topicUid\":\"CatLibrary.MRefDelegate`3\",\"type\":\"Delegate\"},{\"name\":\"MRefNormalDelegate\",\"href\":\"../api/CatLibrary.MRefNormalDelegate.html\",\"topicHref\":\"../api/CatLibrary.MRefNormalDelegate.html\",\"topicUid\":\"CatLibrary.MRefNormalDelegate\",\"type\":\"Delegate\"},{\"name\":\"Tom\",\"href\":\"../api/CatLibrary.Tom.html\",\"topicHref\":\"../api/CatLibrary.Tom.html\",\"topicUid\":\"CatLibrary.Tom\",\"type\":\"Class\"},{\"name\":\"TomFromBaseClass\",\"href\":\"../api/CatLibrary.TomFromBaseClass.html\",\"topicHref\":\"../api/CatLibrary.TomFromBaseClass.html\",\"topicUid\":\"CatLibrary.TomFromBaseClass\",\"type\":\"Class\"}]},{\"name\":\"MRef.Demo.Enumeration\",\"href\":\"../api/MRef.Demo.Enumeration.html\",\"topicHref\":\"../api/MRef.Demo.Enumeration.html\",\"topicUid\":\"MRef.Demo.Enumeration\",\"type\":\"Namespace\",\"items\":[{\"name\":\"ColorType\",\"href\":\"../api/MRef.Demo.Enumeration.ColorType.html\",\"topicHref\":\"../api/MRef.Demo.Enumeration.ColorType.html\",\"topicUid\":\"MRef.Demo.Enumeration.ColorType\",\"type\":\"Enum\"}]}]},{\"name\":\"REST API\",\"includedFrom\":\"~/restapi/toc.md\",\"items\":[{\"name\":\"Pet Store API\",\"href\":\"../restapi/petstore.html\",\"topicHref\":\"../restapi/petstore.html\"},{\"name\":\"Contacts API\",\"href\":\"../restapi/contacts.html\",\"topicHref\":\"../restapi/contacts.html\"}]}],\"pdf\":true,\"pdfTocPage\":true}" + "content": "{\"order\":200,\"items\":[{\"name\":\"Articles\",\"includedFrom\":\"~/articles/toc.yml\",\"items\":[{\"name\":\"Getting Started with docfx\",\"href\":\"../articles/docfx_getting_started.html\",\"topicHref\":\"../articles/docfx_getting_started.html\"},{\"name\":\"Engineering Docs\",\"items\":[{\"name\":\"Section 1\"},{\"name\":\"Engineering Guidelines\",\"href\":\"../articles/engineering_guidelines.html\",\"topicHref\":\"../articles/engineering_guidelines.html\"},{\"name\":\"C# Coding Standards\",\"href\":\"../articles/csharp_coding_standards.html\",\"topicHref\":\"../articles/csharp_coding_standards.html\"}],\"expanded\":true},{\"name\":\"Markdown\",\"href\":\"../articles/markdown.html\",\"topicHref\":\"../articles/markdown.html\"},{\"name\":\"Microsoft Docs\",\"href\":\"https://docs.microsoft.com/en-us/\",\"topicHref\":\"https://docs.microsoft.com/en-us/\"}]},{\"name\":\"API Documentation\",\"includedFrom\":\"~/obj/api/toc.yml\",\"items\":[{\"name\":\"BuildFromAssembly\",\"href\":\"../api/BuildFromAssembly.html\",\"topicHref\":\"../api/BuildFromAssembly.html\",\"topicUid\":\"BuildFromAssembly\",\"type\":\"Namespace\",\"items\":[{\"name\":\"Class1\",\"href\":\"../api/BuildFromAssembly.Class1.html\",\"topicHref\":\"../api/BuildFromAssembly.Class1.html\",\"topicUid\":\"BuildFromAssembly.Class1\",\"type\":\"Class\"},{\"name\":\"Issue5432\",\"href\":\"../api/BuildFromAssembly.Issue5432.html\",\"topicHref\":\"../api/BuildFromAssembly.Issue5432.html\",\"topicUid\":\"BuildFromAssembly.Issue5432\",\"type\":\"Struct\"}]},{\"name\":\"BuildFromCSharpSourceCode\",\"href\":\"../api/BuildFromCSharpSourceCode.html\",\"topicHref\":\"../api/BuildFromCSharpSourceCode.html\",\"topicUid\":\"BuildFromCSharpSourceCode\",\"type\":\"Namespace\",\"items\":[{\"name\":\"CSharp\",\"href\":\"../api/BuildFromCSharpSourceCode.CSharp.html\",\"topicHref\":\"../api/BuildFromCSharpSourceCode.CSharp.html\",\"topicUid\":\"BuildFromCSharpSourceCode.CSharp\",\"type\":\"Class\"}]},{\"name\":\"BuildFromProject\",\"href\":\"../api/BuildFromProject.html\",\"topicHref\":\"../api/BuildFromProject.html\",\"topicUid\":\"BuildFromProject\",\"type\":\"Namespace\",\"items\":[{\"name\":\"Issue8540\",\"href\":\"../api/BuildFromProject.Issue8540.html\",\"topicHref\":\"../api/BuildFromProject.Issue8540.html\",\"topicUid\":\"BuildFromProject.Issue8540\",\"type\":\"Namespace\",\"items\":[{\"name\":\"A\",\"href\":\"../api/BuildFromProject.Issue8540.A.html\",\"topicHref\":\"../api/BuildFromProject.Issue8540.A.html\",\"topicUid\":\"BuildFromProject.Issue8540.A\",\"type\":\"Namespace\",\"items\":[{\"name\":\"A\",\"href\":\"../api/BuildFromProject.Issue8540.A.A.html\",\"topicHref\":\"../api/BuildFromProject.Issue8540.A.A.html\",\"topicUid\":\"BuildFromProject.Issue8540.A.A\",\"type\":\"Class\"}]},{\"name\":\"B\",\"href\":\"../api/BuildFromProject.Issue8540.B.html\",\"topicHref\":\"../api/BuildFromProject.Issue8540.B.html\",\"topicUid\":\"BuildFromProject.Issue8540.B\",\"type\":\"Namespace\",\"items\":[{\"name\":\"B\",\"href\":\"../api/BuildFromProject.Issue8540.B.B.html\",\"topicHref\":\"../api/BuildFromProject.Issue8540.B.B.html\",\"topicUid\":\"BuildFromProject.Issue8540.B.B\",\"type\":\"Class\"}]}]},{\"name\":\"Class1\",\"href\":\"../api/BuildFromProject.Class1.html\",\"topicHref\":\"../api/BuildFromProject.Class1.html\",\"topicUid\":\"BuildFromProject.Class1\",\"type\":\"Class\"},{\"name\":\"Class1.IIssue8948\",\"href\":\"../api/BuildFromProject.Class1.IIssue8948.html\",\"topicHref\":\"../api/BuildFromProject.Class1.IIssue8948.html\",\"topicUid\":\"BuildFromProject.Class1.IIssue8948\",\"type\":\"Interface\"},{\"name\":\"Class1.Issue8665\",\"href\":\"../api/BuildFromProject.Class1.Issue8665.html\",\"topicHref\":\"../api/BuildFromProject.Class1.Issue8665.html\",\"topicUid\":\"BuildFromProject.Class1.Issue8665\",\"type\":\"Class\"},{\"name\":\"Class1.Issue8696Attribute\",\"href\":\"../api/BuildFromProject.Class1.Issue8696Attribute.html\",\"topicHref\":\"../api/BuildFromProject.Class1.Issue8696Attribute.html\",\"topicUid\":\"BuildFromProject.Class1.Issue8696Attribute\",\"type\":\"Class\"},{\"name\":\"Class1.Issue8948\",\"href\":\"../api/BuildFromProject.Class1.Issue8948.html\",\"topicHref\":\"../api/BuildFromProject.Class1.Issue8948.html\",\"topicUid\":\"BuildFromProject.Class1.Issue8948\",\"type\":\"Class\"},{\"name\":\"Class1.Issue9260\",\"href\":\"../api/BuildFromProject.Class1.Issue9260.html\",\"topicHref\":\"../api/BuildFromProject.Class1.Issue9260.html\",\"topicUid\":\"BuildFromProject.Class1.Issue9260\",\"type\":\"Enum\"},{\"name\":\"Class1.Test\",\"href\":\"../api/BuildFromProject.Class1.Test-1.html\",\"topicHref\":\"../api/BuildFromProject.Class1.Test-1.html\",\"topicUid\":\"BuildFromProject.Class1.Test`1\",\"type\":\"Class\"},{\"name\":\"Dog\",\"href\":\"../api/BuildFromProject.Dog.html\",\"topicHref\":\"../api/BuildFromProject.Dog.html\",\"topicUid\":\"BuildFromProject.Dog\",\"type\":\"Class\"},{\"name\":\"IInheritdoc\",\"href\":\"../api/BuildFromProject.IInheritdoc.html\",\"topicHref\":\"../api/BuildFromProject.IInheritdoc.html\",\"topicUid\":\"BuildFromProject.IInheritdoc\",\"type\":\"Interface\"},{\"name\":\"Inheritdoc\",\"href\":\"../api/BuildFromProject.Inheritdoc.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.html\",\"topicUid\":\"BuildFromProject.Inheritdoc\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue6366\",\"href\":\"../api/BuildFromProject.Inheritdoc.Issue6366.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.Issue6366.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue6366\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue6366.Class1\",\"href\":\"../api/BuildFromProject.Inheritdoc.Issue6366.Class1-1.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.Issue6366.Class1-1.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue6366.Class1`1\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue6366.Class2\",\"href\":\"../api/BuildFromProject.Inheritdoc.Issue6366.Class2.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.Issue6366.Class2.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue6366.Class2\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue7035\",\"href\":\"../api/BuildFromProject.Inheritdoc.Issue7035.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.Issue7035.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue7035\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue7484\",\"href\":\"../api/BuildFromProject.Inheritdoc.Issue7484.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.Issue7484.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue7484\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue8101\",\"href\":\"../api/BuildFromProject.Inheritdoc.Issue8101.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.Issue8101.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue8101\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue8129\",\"href\":\"../api/BuildFromProject.Inheritdoc.Issue8129.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.Issue8129.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue8129\",\"type\":\"Struct\"},{\"name\":\"Inheritdoc.Issue9736\",\"href\":\"../api/BuildFromProject.Inheritdoc.Issue9736.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.Issue9736.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue9736\",\"type\":\"Class\"},{\"name\":\"Inheritdoc.Issue9736.IJsonApiOptions\",\"href\":\"../api/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions\",\"type\":\"Interface\"},{\"name\":\"Inheritdoc.Issue9736.JsonApiOptions\",\"href\":\"../api/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html\",\"topicHref\":\"../api/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html\",\"topicUid\":\"BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions\",\"type\":\"Class\"},{\"name\":\"Issue8725\",\"href\":\"../api/BuildFromProject.Issue8725.html\",\"topicHref\":\"../api/BuildFromProject.Issue8725.html\",\"topicUid\":\"BuildFromProject.Issue8725\",\"type\":\"Class\"}]},{\"name\":\"BuildFromVBSourceCode\",\"href\":\"../api/BuildFromVBSourceCode.html\",\"topicHref\":\"../api/BuildFromVBSourceCode.html\",\"topicUid\":\"BuildFromVBSourceCode\",\"type\":\"Namespace\",\"items\":[{\"name\":\"BaseClass1\",\"href\":\"../api/BuildFromVBSourceCode.BaseClass1.html\",\"topicHref\":\"../api/BuildFromVBSourceCode.BaseClass1.html\",\"topicUid\":\"BuildFromVBSourceCode.BaseClass1\",\"type\":\"Class\"},{\"name\":\"Class1\",\"href\":\"../api/BuildFromVBSourceCode.Class1.html\",\"topicHref\":\"../api/BuildFromVBSourceCode.Class1.html\",\"topicUid\":\"BuildFromVBSourceCode.Class1\",\"type\":\"Class\"}]},{\"name\":\"CatLibrary\",\"href\":\"../api/CatLibrary.html\",\"topicHref\":\"../api/CatLibrary.html\",\"topicUid\":\"CatLibrary\",\"type\":\"Namespace\",\"items\":[{\"name\":\"Core\",\"href\":\"../api/CatLibrary.Core.html\",\"topicHref\":\"../api/CatLibrary.Core.html\",\"topicUid\":\"CatLibrary.Core\",\"type\":\"Namespace\",\"items\":[{\"name\":\"ContainersRefType\",\"href\":\"../api/CatLibrary.Core.ContainersRefType.html\",\"topicHref\":\"../api/CatLibrary.Core.ContainersRefType.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType\",\"type\":\"Struct\"},{\"name\":\"ContainersRefType.ColorType\",\"href\":\"../api/CatLibrary.Core.ContainersRefType.ColorType.html\",\"topicHref\":\"../api/CatLibrary.Core.ContainersRefType.ColorType.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ColorType\",\"type\":\"Enum\"},{\"name\":\"ContainersRefType.ContainersRefTypeChild\",\"href\":\"../api/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\",\"topicHref\":\"../api/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild\",\"type\":\"Class\"},{\"name\":\"ContainersRefType.ContainersRefTypeChildInterface\",\"href\":\"../api/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\",\"topicHref\":\"../api/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface\",\"type\":\"Interface\"},{\"name\":\"ContainersRefType.ContainersRefTypeDelegate\",\"href\":\"../api/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\",\"topicHref\":\"../api/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate\",\"type\":\"Delegate\"},{\"name\":\"ExplicitLayoutClass\",\"href\":\"../api/CatLibrary.Core.ExplicitLayoutClass.html\",\"topicHref\":\"../api/CatLibrary.Core.ExplicitLayoutClass.html\",\"topicUid\":\"CatLibrary.Core.ExplicitLayoutClass\",\"type\":\"Class\"},{\"name\":\"Issue231\",\"href\":\"../api/CatLibrary.Core.Issue231.html\",\"topicHref\":\"../api/CatLibrary.Core.Issue231.html\",\"topicUid\":\"CatLibrary.Core.Issue231\",\"type\":\"Class\"}]},{\"name\":\"CatException\",\"href\":\"../api/CatLibrary.CatException-1.html\",\"topicHref\":\"../api/CatLibrary.CatException-1.html\",\"topicUid\":\"CatLibrary.CatException`1\",\"type\":\"Class\"},{\"name\":\"Cat\",\"href\":\"../api/CatLibrary.Cat-2.html\",\"topicHref\":\"../api/CatLibrary.Cat-2.html\",\"topicUid\":\"CatLibrary.Cat`2\",\"type\":\"Class\"},{\"name\":\"Complex\",\"href\":\"../api/CatLibrary.Complex-2.html\",\"topicHref\":\"../api/CatLibrary.Complex-2.html\",\"topicUid\":\"CatLibrary.Complex`2\",\"type\":\"Class\"},{\"name\":\"FakeDelegate\",\"href\":\"../api/CatLibrary.FakeDelegate-1.html\",\"topicHref\":\"../api/CatLibrary.FakeDelegate-1.html\",\"topicUid\":\"CatLibrary.FakeDelegate`1\",\"type\":\"Delegate\"},{\"name\":\"IAnimal\",\"href\":\"../api/CatLibrary.IAnimal.html\",\"topicHref\":\"../api/CatLibrary.IAnimal.html\",\"topicUid\":\"CatLibrary.IAnimal\",\"type\":\"Interface\"},{\"name\":\"ICat\",\"href\":\"../api/CatLibrary.ICat.html\",\"topicHref\":\"../api/CatLibrary.ICat.html\",\"topicUid\":\"CatLibrary.ICat\",\"type\":\"Interface\"},{\"name\":\"ICatExtension\",\"href\":\"../api/CatLibrary.ICatExtension.html\",\"topicHref\":\"../api/CatLibrary.ICatExtension.html\",\"topicUid\":\"CatLibrary.ICatExtension\",\"type\":\"Class\"},{\"name\":\"MRefDelegate\",\"href\":\"../api/CatLibrary.MRefDelegate-3.html\",\"topicHref\":\"../api/CatLibrary.MRefDelegate-3.html\",\"topicUid\":\"CatLibrary.MRefDelegate`3\",\"type\":\"Delegate\"},{\"name\":\"MRefNormalDelegate\",\"href\":\"../api/CatLibrary.MRefNormalDelegate.html\",\"topicHref\":\"../api/CatLibrary.MRefNormalDelegate.html\",\"topicUid\":\"CatLibrary.MRefNormalDelegate\",\"type\":\"Delegate\"},{\"name\":\"Tom\",\"href\":\"../api/CatLibrary.Tom.html\",\"topicHref\":\"../api/CatLibrary.Tom.html\",\"topicUid\":\"CatLibrary.Tom\",\"type\":\"Class\"},{\"name\":\"TomFromBaseClass\",\"href\":\"../api/CatLibrary.TomFromBaseClass.html\",\"topicHref\":\"../api/CatLibrary.TomFromBaseClass.html\",\"topicUid\":\"CatLibrary.TomFromBaseClass\",\"type\":\"Class\"}]},{\"name\":\"MRef.Demo.Enumeration\",\"href\":\"../api/MRef.Demo.Enumeration.html\",\"topicHref\":\"../api/MRef.Demo.Enumeration.html\",\"topicUid\":\"MRef.Demo.Enumeration\",\"type\":\"Namespace\",\"items\":[{\"name\":\"ColorType\",\"href\":\"../api/MRef.Demo.Enumeration.ColorType.html\",\"topicHref\":\"../api/MRef.Demo.Enumeration.ColorType.html\",\"topicUid\":\"MRef.Demo.Enumeration.ColorType\",\"type\":\"Enum\"}]}]},{\"name\":\"REST API\",\"includedFrom\":\"~/restapi/toc.md\",\"items\":[{\"name\":\"Pet Store API\",\"href\":\"../restapi/petstore.html\",\"topicHref\":\"../restapi/petstore.html\"},{\"name\":\"Contacts API\",\"href\":\"../restapi/contacts.html\",\"topicHref\":\"../restapi/contacts.html\"}]}],\"pdf\":true,\"pdfTocPage\":true}" } \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/pdf/toc.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/pdf/toc.verified.json index 868eceba39b..d371d7bc14d 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/pdf/toc.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/pdf/toc.verified.json @@ -251,6 +251,27 @@ "topicUid": "BuildFromProject.Inheritdoc.Issue8129", "type": "Struct" }, + { + "name": "Inheritdoc.Issue9736", + "href": "../api/BuildFromProject.Inheritdoc.Issue9736.html", + "topicHref": "../api/BuildFromProject.Inheritdoc.Issue9736.html", + "topicUid": "BuildFromProject.Inheritdoc.Issue9736", + "type": "Class" + }, + { + "name": "Inheritdoc.Issue9736.IJsonApiOptions", + "href": "../api/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "topicHref": "../api/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html", + "topicUid": "BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions", + "type": "Interface" + }, + { + "name": "Inheritdoc.Issue9736.JsonApiOptions", + "href": "../api/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "topicHref": "../api/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html", + "topicUid": "BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions", + "type": "Class" + }, { "name": "Issue8725", "href": "../api/BuildFromProject.Issue8725.html", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/restapi/toc.pdf.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/restapi/toc.pdf.verified.json index a86660efee8..0fba6d54726 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/restapi/toc.pdf.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/restapi/toc.pdf.verified.json @@ -3,7 +3,7 @@ "Pages": [ { "Number": 1, - "Text": "Table of Contents\nPet Store API 2\nContacts API 17", + "Text": "Table of ContentsPet Store API2Contacts API17", "Links": [ { "Goto": { @@ -27,7 +27,7 @@ }, { "Number": 2, - "Text": "2 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nSwagger Petstore\nDescribe APIs in Pet Store\npet\nDescription for pet tag\nAddPet\nAdd a new pet to the store\nRequest\nParameters\nName Type Default Notes\n*body Pet Pet object that needs to be added to the store\nResponses\nStatus Code Type Description Samples\n405 Invalid input\nNOTE: Add pet only when you needs.\nUpdatePet\nUpdate an existing pet\nRequest\nParameters\nPOST /pet\nPUT /pet", + "Text": "2 / 27| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5Swagger PetstoreDescribe APIs in Pet StorepetDescription for pet tagAddPetAdd a new pet to the storeRequestParametersNameTypeDefaultNotes*bodyPetPet object that needs to be added to the storeResponsesStatus CodeTypeDescriptionSamples405Invalid inputNOTE: Add pet only when you needs.UpdatePetUpdate an existing petRequestParametersPOST /petPUT /pet", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_addPet.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FaddPet%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -78,7 +78,7 @@ }, { "Number": 3, - "Text": "3 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nName Type Default Notes\n*body Pet Pet object that needs to be added to the store\nResponses\nStatus Code Type Description Samples\n400 Invalid ID supplied\n404 Pet not found\n405 Validation exception\nFindPetsByStatus\nFinds Pets by status\nMultiple status values can be provided with comma separated strings\nRequest\nParameters\nName Type Default Notes\n*status Status values that need to be considered for filter\nResponses\nStatus Code Type Description Samples\n200 Pet[] successful operation\n400 Invalid status value\nFindPetsByTags\nGET /pet/findByStatus?status", + "Text": "3 / 27| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5NameTypeDefaultNotes*bodyPetPet object that needs to be added to the storeResponsesStatus CodeTypeDescriptionSamples400Invalid ID supplied404Pet not found405Validation exceptionFindPetsByStatusFinds Pets by statusMultiple status values can be provided with comma separated stringsRequestParametersNameTypeDefaultNotes*statusStatus values that need to be considered for filterResponsesStatus CodeTypeDescriptionSamples200Pet[]successful operation400Invalid status valueFindPetsByTagsGET /pet/findByStatus?status", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_findPetsByStatus.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FfindPetsByStatus%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -138,7 +138,7 @@ }, { "Number": 4, - "Text": "4 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\nFinds Pets by tags\nMuliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for\ntesting.\nRequest\nParameters\nName Type Default Notes\n*tags Tags to filter by\nResponses\nStatus Code Type Description Samples\n200 Pet[] successful operation\n400 Invalid tag value\nDeletePet\nDeletes a pet\nRequest\nParameters\nName Type Default Notes\napi_key\n*petId Pet id to delete\nResponses\nGET /pet/findByTags?tags\nDELETE /pet/{petId}", + "Text": "4 / 27| Improve this Doc\uF1C5View Source\uF1C5Finds Pets by tagsMuliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 fortesting.RequestParametersNameTypeDefaultNotes*tagsTags to filter byResponsesStatus CodeTypeDescriptionSamples200Pet[]successful operation400Invalid tag valueDeletePetDeletes a petRequestParametersNameTypeDefaultNotesapi_key*petIdPet id to deleteResponsesGET /pet/findByTags?tagsDELETE /pet/{petId}", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_deletePet.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FdeletePet%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -171,7 +171,7 @@ }, { "Number": 5, - "Text": "5 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nStatus Code Type Description Samples\n400 Invalid ID supplied\n404 Pet not found\nGetPetById\nFind pet by ID\nReturns a single pet\nRequest\nParameters\nName Type Default Notes\n*petId ID of pet to return\nResponses\nStatus Code Type Description Samples\n200 Pet successful operation\n400 Invalid ID supplied\n404 Pet not found\nUpdatePetWithForm\nUpdates a pet in the store with form data\nRequest\nGET /pet/{petId}\nPOST /pet/{petId}", + "Text": "5 / 27| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5Status CodeTypeDescriptionSamples400Invalid ID supplied404Pet not foundGetPetByIdFind pet by IDReturns a single petRequestParametersNameTypeDefaultNotes*petIdID of pet to returnResponsesStatus CodeTypeDescriptionSamples200Petsuccessful operation400Invalid ID supplied404Pet not foundUpdatePetWithFormUpdates a pet in the store with form dataRequestGET /pet/{petId}POST /pet/{petId}", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_getPetById.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FgetPetById%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -222,7 +222,7 @@ }, { "Number": 6, - "Text": "6 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\nParameters\nName Type Default Notes\n*petId ID of pet that needs to be updated\nname Updated name of the pet\nstatus Updated status of the pet\nResponses\nStatus Code Type Description Samples\n405 Invalid input\nUploadFile\nuploads an image\nRequest\nParameters\nName Type Default Notes\n*petId ID of pet to update\nadditionalMetadata Additional data to pass to server\nfile file to upload\nResponses\nStatus Code Type Description Samples\n200 ApiResponse successful operation\nPOST /pet/{petId}/uploadImage", + "Text": "6 / 27| Improve this Doc\uF1C5View Source\uF1C5ParametersNameTypeDefaultNotes*petIdID of pet that needs to be updatednameUpdated name of the petstatusUpdated status of the petResponsesStatus CodeTypeDescriptionSamples405Invalid inputUploadFileuploads an imageRequestParametersNameTypeDefaultNotes*petIdID of pet to updateadditionalMetadataAdditional data to pass to serverfilefile to uploadResponsesStatus CodeTypeDescriptionSamples200ApiResponsesuccessful operationPOST /pet/{petId}/uploadImage", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_uploadFile.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FuploadFile%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -264,7 +264,7 @@ }, { "Number": 7, - "Text": "7 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nstore\nAccess to Petstore orders\nAdditional description for store tag\nAddPet\nAdd a new pet to the store\nRequest\nParameters\nName Type Default Notes\n*body Pet Pet object that needs to be added to the store\nResponses\nStatus Code Type Description Samples\n405 Invalid input\nNOTE: Add pet only when you needs.\nGetInventory\nReturns pet inventories by status\nReturns a map of status codes to quantities\nRequest\nResponses\nPOST /pet\nGET /store/inventory", + "Text": "7 / 27| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5storeAccess to Petstore ordersAdditional description for store tagAddPetAdd a new pet to the storeRequestParametersNameTypeDefaultNotes*bodyPetPet object that needs to be added to the storeResponsesStatus CodeTypeDescriptionSamples405Invalid inputNOTE: Add pet only when you needs.GetInventoryReturns pet inventories by statusReturns a map of status codes to quantitiesRequestResponsesPOST /petGET /store/inventory", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_addPet.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FaddPet%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -315,7 +315,7 @@ }, { "Number": 8, - "Text": "8 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nStatus Code Type Description Samples\n200 object successful operation\nPlaceOrder\nPlace an order for a pet\nRequest\nParameters\nName Type Default Notes\n*body Order order placed for purchasing the pet\nResponses\nStatus Code Type Description Samples\n200 Order successful operation\n400 Invalid Order\nDeleteOrder\nDelete purchase order by ID\nFor valid response try integer IDs with positive integer value. Negative or non-integer\nvalues will generate API errors\nRequest\nParameters\nPOST /store/order\nDELETE /store/order/{orderId}", + "Text": "8 / 27| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5Status CodeTypeDescriptionSamples200objectsuccessful operationPlaceOrderPlace an order for a petRequestParametersNameTypeDefaultNotes*bodyOrderorder placed for purchasing the petResponsesStatus CodeTypeDescriptionSamples200Ordersuccessful operation400Invalid OrderDeleteOrderDelete purchase order by IDFor valid response try integer IDs with positive integer value. Negative or non-integervalues will generate API errorsRequestParametersPOST /store/orderDELETE /store/order/{orderId}", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_placeOrder.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FplaceOrder%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -375,7 +375,7 @@ }, { "Number": 9, - "Text": "9 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\nName Type Default Notes\n*orderId ID of the order that needs to be deleted\nResponses\nStatus Code Type Description Samples\n400 Invalid ID supplied\n404 Order not found\nGetOrderById\nFind purchase order by ID\nFor valid response try integer IDs with value >= 1 and <= 10. Other values will generated\nexceptions\nRequest\nParameters\nName Type Default Notes\n*orderId ID of pet that needs to be fetched\nResponses\nStatus Code Type Description Samples\n200 Order successful operation\n400 Invalid ID supplied\n404 Order not found\nGET /store/order/{orderId}", + "Text": "9 / 27| Improve this Doc\uF1C5View Source\uF1C5NameTypeDefaultNotes*orderIdID of the order that needs to be deletedResponsesStatus CodeTypeDescriptionSamples400Invalid ID supplied404Order not foundGetOrderByIdFind purchase order by IDFor valid response try integer IDs with value >= 1 and <= 10. Other values will generatedexceptionsRequestParametersNameTypeDefaultNotes*orderIdID of pet that needs to be fetchedResponsesStatus CodeTypeDescriptionSamples200Ordersuccessful operation400Invalid ID supplied404Order not foundGET /store/order/{orderId}", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_getOrderById.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FgetOrderById%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -408,7 +408,7 @@ }, { "Number": 10, - "Text": "10 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nuser\nOperations about user\nCreateUser\nCreate user\nThis can only be done by the logged in user.\nRequest\nParameters\nName Type Default Notes\n*body User Created user object\nResponses\nStatus Code Type Description Samples\ndefault successful operation\nCreateUsersWithArrayInput\nCreates list of users with given input array\nRequest\nParameters\nName Type Default Notes\n*body User[] List of user object\nResponses\nPOST /user\nPOST /user/createWithArray", + "Text": "10 / 27| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5userOperations about userCreateUserCreate userThis can only be done by the logged in user.RequestParametersNameTypeDefaultNotes*bodyUserCreated user objectResponsesStatus CodeTypeDescriptionSamplesdefaultsuccessful operationCreateUsersWithArrayInputCreates list of users with given input arrayRequestParametersNameTypeDefaultNotes*bodyUser[]List of user objectResponsesPOST /userPOST /user/createWithArray", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_createUser.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FcreateUser%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -468,7 +468,7 @@ }, { "Number": 11, - "Text": "11 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nStatus Code Type Description Samples\ndefault successful operation\nCreateUsersWithListInput\nCreates list of users with given input array\nRequest\nParameters\nName Type Default Notes\n*body User[] List of user object\nResponses\nStatus Code Type Description Samples\ndefault successful operation\nLoginUser\nLogs user into the system\nRequest\nParameters\nName Type Default Notes\n*username The user name for login\n*password The password for login in clear text\nPOST /user/createWithList\nGET /user/login?username&password", + "Text": "11 / 27| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5Status CodeTypeDescriptionSamplesdefaultsuccessful operationCreateUsersWithListInputCreates list of users with given input arrayRequestParametersNameTypeDefaultNotes*bodyUser[]List of user objectResponsesStatus CodeTypeDescriptionSamplesdefaultsuccessful operationLoginUserLogs user into the systemRequestParametersNameTypeDefaultNotes*usernameThe user name for login*passwordThe password for login in clear textPOST /user/createWithListGET /user/login?username&password", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_createUsersWithListInput.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FcreateUsersWithListInput%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -519,7 +519,7 @@ }, { "Number": 12, - "Text": "12 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nResponses\nStatus Code Type Description Samples\n200 string successful operation\n400 Invalid username/password supplied\nLogoutUser\nLogs out current logged in user session\nRequest\nResponses\nStatus Code Type Description Samples\ndefault successful operation\nDeleteUser\nDelete user\nThis can only be done by the logged in user.\nRequest\nParameters\nName Type Default Notes\n*username The name that needs to be deleted\nResponses\nGET /user/logout\nDELETE /user/{username}", + "Text": "12 / 27| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5ResponsesStatus CodeTypeDescriptionSamples200stringsuccessful operation400Invalid username/password suppliedLogoutUserLogs out current logged in user sessionRequestResponsesStatus CodeTypeDescriptionSamplesdefaultsuccessful operationDeleteUserDelete userThis can only be done by the logged in user.RequestParametersNameTypeDefaultNotes*usernameThe name that needs to be deletedResponsesGET /user/logoutDELETE /user/{username}", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_logoutUser.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FlogoutUser%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -561,7 +561,7 @@ }, { "Number": 13, - "Text": "13 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nStatus Code Type Description Samples\n400 Invalid username supplied\n404 User not found\nGetUserByName\nGet user by user name\nRequest\nParameters\nName Type Default Notes\n*username The name that needs to be fetched. Use user1 for testing.\nResponses\nStatus Code Type Description Samples\n200 User successful operation\n400 Invalid username supplied\n404 User not found\nOther APIs\nUpdateUser\nUpdated user\nThis can only be done by the logged in user.\nRequest\nGET /user/{username}", + "Text": "13 / 27| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5Status CodeTypeDescriptionSamples400Invalid username supplied404User not foundGetUserByNameGet user by user nameRequestParametersNameTypeDefaultNotes*usernameThe name that needs to be fetched. Use user1 for testing.ResponsesStatus CodeTypeDescriptionSamples200Usersuccessful operation400Invalid username supplied404User not foundOther APIsUpdateUserUpdated userThis can only be done by the logged in user.RequestGET /user/{username}", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_getUserByName.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FgetUserByName%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -612,7 +612,7 @@ }, { "Number": 14, - "Text": "14 / 27\nParameters\nName Type Default Notes\n*username name that need to be updated\n*body User Updated user object\nResponses\nStatus Code Type Description Samples\n400 Invalid user supplied\n404 User not found\nDefinitions\nPet\nName Type Notes\ncategory Category[]\nid integer (int64)\nname string\nphotoUrls array\nstatus string pet status in the store\ntags Tag[]\nCategory\nPUT /user/{username}", + "Text": "14 / 27ParametersNameTypeDefaultNotes*usernamename that need to be updated*bodyUserUpdated user objectResponsesStatus CodeTypeDescriptionSamples400Invalid user supplied404User not foundDefinitionsPetNameTypeNotescategoryCategory[]idinteger (int64)namestringphotoUrlsarraystatusstringpet status in the storetagsTag[]CategoryPUT /user/{username}", "Links": [ { "Goto": { @@ -645,12 +645,12 @@ }, { "Number": 15, - "Text": "15 / 27\nName Type Notes\nid integer (int64)\nname string\nTag\nName Type Notes\nid integer (int64)\nname string\nApiResponse\nName Type Notes\ncode integer (int32)\nmessage string\ntype string\nOrder\nName Type Notes\ncomplete boolean\nid integer (int64)\npetId integer (int64)\nquantity integer (int32)\nshipDate string (date-time)\nstatus string Order Status\nUser", + "Text": "15 / 27NameTypeNotesidinteger (int64)namestringTagNameTypeNotesidinteger (int64)namestringApiResponseNameTypeNotescodeinteger (int32)messagestringtypestringOrderNameTypeNotescompletebooleanidinteger (int64)petIdinteger (int64)quantityinteger (int32)shipDatestring (date-time)statusstringOrder StatusUser", "Links": [] }, { "Number": 16, - "Text": "16 / 27\nName Type Notes\nemail string\nfirstName string\nid integer (int64)\nlastName string\npassword string\nphone string\nuserStatus integer (int32) User Status\nusername string\nSee Alsos\nSee other REST APIs:\nContacts API", + "Text": "16 / 27NameTypeNotesemailstringfirstNamestringidinteger (int64)lastNamestringpasswordstringphonestringuserStatusinteger (int32)User StatususernamestringSee AlsosSee other REST APIs:Contacts API", "Links": [ { "Goto": { @@ -665,7 +665,7 @@ }, { "Number": 17, - "Text": "17 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nContacts\nGet Contacts\nYou can get a collection of contacts from your tenant.\nRequired scope: Contacts.Read or Contacts.Write\nRequest\nParameters\nName Type Default Notes\n*api-\nversion\n1.6 The version of the Graph API to target. Beginning with\nversion 1.5, the api-version string is represented in\nmajor.minor format. Prior releases were represented as date\nstrings: '2013-11-08' and '2013-04-05'. Required.\nResponses\nStatus\nCode Type Description Samples\n200 OK.\nIndicates\nsuccess. The\nresults are\nreturned in\nthe\nresponse\nbody.\nMime type: application/json\nGet Contact By Id\nGet a contact by using the object ID.\nRequired scope: Contacts.Read or Contacts.Write\nGET /contacts?api-version\n{ \n\"odata.metadata\":\n\"https://graph.windows.net/myorganization/$metadata#dir\n\"value\": [\n{ \n\"odata.type\": \"Microsoft.DirectoryServices.Contac\n\"objectType\": \"Contact\",\n\"objectId\": \"31944231-fd52-4a7f-b32e-7902a01fddf9\n\"deletionTimestamp\": null,", + "Text": "17 / 27| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5ContactsGet ContactsYou can get a collection of contacts from your tenant.Required scope: Contacts.Read or Contacts.WriteRequestParametersNameTypeDefaultNotes*api-version1.6The version of the Graph API to target. Beginning withversion 1.5, the api-version string is represented inmajor.minor format. Prior releases were represented as datestrings: '2013-11-08' and '2013-04-05'. Required.ResponsesStatusCodeTypeDescriptionSamples200OK.Indicatessuccess. Theresults arereturned intheresponsebody.Mime type: application/jsonGet Contact By IdGet a contact by using the object ID.Required scope: Contacts.Read or Contacts.WriteGET /contacts?api-version{ \"odata.metadata\": \"https://graph.windows.net/myorganization/$metadata#dir \"value\": [ { \"odata.type\": \"Microsoft.DirectoryServices.Contac \"objectType\": \"Contact\", \"objectId\": \"31944231-fd52-4a7f-b32e-7902a01fddf9 \"deletionTimestamp\": null,", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=graph_windows_net_myorganization_Contacts_1_6_get_contacts.md&value=---%0Auid%3A%20graph.windows.net%2Fmyorganization%2FContacts%2F1.6%2Fget%20contacts%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -707,7 +707,7 @@ }, { "Number": 18, - "Text": "18 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\nRequest\nParameters\nName Type Default Notes\n*object_id 31944231-fd52-\n4a7f-b32e-\n7902a01fddf9\nThe object ID (GUID) of the target contact.\n*api-\nversion\n1.6 Specifies the version of the Graph API to target.\nBeginning with version 1.5, the api-version string\nis represented in major.minor format. Prior\nreleases were represented as date strings:\n'2013-11-08' and '2013-04-05'. Required.\nResponses\nStatus\nCode Type Description Samples\n200 OK.\nIndicates\nsuccess. The\ncontact is\nreturned in\nthe\nresponse\nbody.\nMime type: application/json\nUpdate Contact\nChange a contact's properties.\nRequired scope: Contacts.Write\nRequest\nGET /contacts/{object_id}?api-version\n{ \n\"odata.metadata\":\n\"https://graph.windows.net/graphdir1.onmicrosoft.com/$m\n\"odata.type\": \"Microsoft.DirectoryServices.Contact\",\n\"objectType\": \"Contact\",\n\"objectId\": \"31944231-fd52-4a7f-b32e-7902a01fddf9\",\n\"deletionTimestamp\": null,\n\"city\": null,\n\"companyName\": null,", + "Text": "18 / 27| Improve this Doc\uF1C5View Source\uF1C5RequestParametersNameTypeDefaultNotes*object_id31944231-fd52-4a7f-b32e-7902a01fddf9The object ID (GUID) of the target contact.*api-version1.6Specifies the version of the Graph API to target.Beginning with version 1.5, the api-version stringis represented in major.minor format. Priorreleases were represented as date strings:'2013-11-08' and '2013-04-05'. Required.ResponsesStatusCodeTypeDescriptionSamples200OK.Indicatessuccess. Thecontact isreturned intheresponsebody.Mime type: application/jsonUpdate ContactChange a contact's properties.Required scope: Contacts.WriteRequestGET /contacts/{object_id}?api-version{ \"odata.metadata\": \"https://graph.windows.net/graphdir1.onmicrosoft.com/$m \"odata.type\": \"Microsoft.DirectoryServices.Contact\", \"objectType\": \"Contact\", \"objectId\": \"31944231-fd52-4a7f-b32e-7902a01fddf9\", \"deletionTimestamp\": null, \"city\": null, \"companyName\": null,", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=graph_windows_net_myorganization_Contacts_1_6_update_contact.md&value=---%0Auid%3A%20graph.windows.net%2Fmyorganization%2FContacts%2F1.6%2Fupdate%20contact%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -731,7 +731,7 @@ }, { "Number": 19, - "Text": "19 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\nParameters\nName Type Default Notes\n*object_id 7163f3b8-70c9-\n43d2-b9e1-\n4467ddaf087a\nThe object ID (GUID) of the target contact.\n*api-\nversion\n1.6 The version of the Graph API to target.\nBeginning with version 1.5, the api-version\nstring is represented in major.minor format.\nPrior releases were represented as date\nstrings: '2013-11-08' and '2013-04-05'.\nRequired.\nbodyparam contact this is request body, not real parameter\nResponses\nStatus\nCode Type Description Samples\n204 No Content. Indicates success. No response body is\nreturned.\nDelete Contact\nDelete a contact.\nRequired scope: Contacts.Write\nRequest\nParameters\nPATCH /contacts/{object_id}?api-version\nDELETE /contacts/{object_id}[?api-version]", + "Text": "19 / 27| Improve this Doc\uF1C5View Source\uF1C5ParametersNameTypeDefaultNotes*object_id7163f3b8-70c9-43d2-b9e1-4467ddaf087aThe object ID (GUID) of the target contact.*api-version1.6The version of the Graph API to target.Beginning with version 1.5, the api-versionstring is represented in major.minor format.Prior releases were represented as datestrings: '2013-11-08' and '2013-04-05'.Required.bodyparamcontactthis is request body, not real parameterResponsesStatusCodeTypeDescriptionSamples204No Content. Indicates success. No response body isreturned.Delete ContactDelete a contact.Required scope: Contacts.WriteRequestParametersPATCH /contacts/{object_id}?api-versionDELETE /contacts/{object_id}[?api-version]", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=graph_windows_net_myorganization_Contacts_1_6_delete_contact.md&value=---%0Auid%3A%20graph.windows.net%2Fmyorganization%2FContacts%2F1.6%2Fdelete%20contact%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -764,7 +764,7 @@ }, { "Number": 20, - "Text": "20 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\nName Type Default Notes\n*object_id 7163f3b8-70c9-\n43d2-b9e1-\n4467ddaf087a\nThe object ID (GUID) of the target contact.\napi-\nversion\n1.6 Specifies the version of the Graph API to target.\nBeginning with version 1.5, the api-version\nstring is represented in major.minor format. Prior\nreleases were represented as date strings:\n'2013-11-08' and '2013-04-05'. Required.\nResponses\nStatus Code Type Description Samples\n204 No Content. Indicates success.\nGet Contact Manager Link\nGet a link to the contact's manager.\nRequired scope: Contacts.Read or Contacts.Write\nRequest\nParameters\nName Type Default Notes\n*object_id 31944231-fd52-\n4a7f-b32e-\n7902a01fddf9\nThe object ID (GUID) of the target contact.\n*api-\nversion\n1.6 The version of the Graph API to target.\nBeginning with version 1.5, the api-version string\nis represented in major.minor format. Prior\nreleases were represented as date strings:\n'2013-11-08' and '2013-04-05'. Required.\nGET /contacts/{object_id}/$links/manager?api-version", + "Text": "20 / 27| Improve this Doc\uF1C5View Source\uF1C5NameTypeDefaultNotes*object_id7163f3b8-70c9-43d2-b9e1-4467ddaf087aThe object ID (GUID) of the target contact.api-version1.6Specifies the version of the Graph API to target.Beginning with version 1.5, the api-versionstring is represented in major.minor format. Priorreleases were represented as date strings:'2013-11-08' and '2013-04-05'. Required.ResponsesStatus CodeTypeDescriptionSamples204No Content. Indicates success.Get Contact Manager LinkGet a link to the contact's manager.Required scope: Contacts.Read or Contacts.WriteRequestParametersNameTypeDefaultNotes*object_id31944231-fd52-4a7f-b32e-7902a01fddf9The object ID (GUID) of the target contact.*api-version1.6The version of the Graph API to target.Beginning with version 1.5, the api-version stringis represented in major.minor format. Priorreleases were represented as date strings:'2013-11-08' and '2013-04-05'. Required.GET /contacts/{object_id}/$links/manager?api-version", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=graph_windows_net_myorganization_Contacts_1_6_get_contact_manager_link.md&value=---%0Auid%3A%20graph.windows.net%2Fmyorganization%2FContacts%2F1.6%2Fget%20contact%20manager%20link%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -788,7 +788,7 @@ }, { "Number": 21, - "Text": "21 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\nResponses\nStatus\nCode Type Description Samples\n200 OK.\nIndicates\nsuccess. A\nlink to the\ncontact's\nmanager is\nreturned.\nMime type: application/json\n404 Not Found.\nThe\nrequested\nresource\nwas not\nfound. This\ncan occur if\nthe manager\nproperty is\nnot currently\nset for the\nspecified\ncontact. It\ncan also\nhave other\ncauses, for\nexample, a\nbad domain.\nA code and\nassociated\nmessage is\nreturned\nwith the\nerror.\nMime type: application/json\nUpdate Contact Manager\n{ \n\"odata.metadata\":\n\"https://graph.windows.net/myorganization/$metadata#dir\n\"url\": \"https://graph.windows.net/myorganization/dire\n4c4a-93b2-03f065fabd93/Microsoft.WindowsAzure.ActiveDir\n}\n{ \n\"odata.error\": {\n\"code\": \"Request_ResourceNotFound\",\n\"message\": {\n\"lang\": \"en\",\n\"value\": \"Resource not found for the segment 'man\n} \n}\n}", + "Text": "21 / 27| Improve this Doc\uF1C5View Source\uF1C5ResponsesStatusCodeTypeDescriptionSamples200OK.Indicatessuccess. Alink to thecontact'smanager isreturned.Mime type: application/json404Not Found.Therequestedresourcewas notfound. Thiscan occur ifthe managerproperty isnot currentlyset for thespecifiedcontact. Itcan alsohave othercauses, forexample, abad domain.A code andassociatedmessage isreturnedwith theerror.Mime type: application/jsonUpdate Contact Manager{ \"odata.metadata\": \"https://graph.windows.net/myorganization/$metadata#dir \"url\": \"https://graph.windows.net/myorganization/dire4c4a-93b2-03f065fabd93/Microsoft.WindowsAzure.ActiveDir}{ \"odata.error\": { \"code\": \"Request_ResourceNotFound\", \"message\": { \"lang\": \"en\", \"value\": \"Resource not found for the segment 'man } }}", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=graph_windows_net_myorganization_Contacts_1_6_update_contact_manager.md&value=---%0Auid%3A%20graph.windows.net%2Fmyorganization%2FContacts%2F1.6%2Fupdate%20contact%20manager%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -812,7 +812,7 @@ }, { "Number": 22, - "Text": "22 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\nUpdate the contact's manager\nRequired scope: Contacts.Write\nRequest\nParameters\nName Type Default Notes\n*object_id 31944231-fd52-\n4a7f-b32e-\n7902a01fddf9\nThe object ID (GUID) of the target contact.\n*api-version 1.6 The version of the Graph API to target.\nBeginning with version 1.5, the api-version\nstring is represented in major.minor format.\nPrior releases were represented as date\nstrings: '2013-11-08' and '2013-04-05'.\nRequired.\n*bodyparam The request body contains a single property\nthat specifies the URL of the user or contact to\nadd as manager.\nResponses\nStatus\nCode Type Description Samples\n204 No Content. Indicates success. No response body is\nreturned.\nDelete Contact Manager By Id\nDelete the contact's manager.\nRequired scope: Contacts.Write\nRequest\nPUT /contacts/{object_id}/$links/manager?api-version", + "Text": "22 / 27| Improve this Doc\uF1C5View Source\uF1C5Update the contact's managerRequired scope: Contacts.WriteRequestParametersNameTypeDefaultNotes*object_id31944231-fd52-4a7f-b32e-7902a01fddf9The object ID (GUID) of the target contact.*api-version1.6The version of the Graph API to target.Beginning with version 1.5, the api-versionstring is represented in major.minor format.Prior releases were represented as datestrings: '2013-11-08' and '2013-04-05'.Required.*bodyparamThe request body contains a single propertythat specifies the URL of the user or contact toadd as manager.ResponsesStatusCodeTypeDescriptionSamples204No Content. Indicates success. No response body isreturned.Delete Contact Manager By IdDelete the contact's manager.Required scope: Contacts.WriteRequestPUT /contacts/{object_id}/$links/manager?api-version", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=graph_windows_net_myorganization_Contacts_1_6_delete_contact_manager_by_id.md&value=---%0Auid%3A%20graph.windows.net%2Fmyorganization%2FContacts%2F1.6%2Fdelete%20contact%20manager%20by%20id%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -836,7 +836,7 @@ }, { "Number": 23, - "Text": "23 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\nParameters\nName Type Default Notes\n*object_id 31944231-fd52-\n4a7f-b32e-\n7902a01fddf9\nThe object ID (GUID) of the target contact.\n*api-\nversion\n1.6 The version of the Graph API to target.\nBeginning with version 1.5, the api-version string\nis represented in major.minor format. Prior\nreleases were represented as date strings:\n'2013-11-08' and '2013-04-05'. Required.\nResponses\nStatus\nCode Type Description Samples\n204 No Content. Indicates success. N response body is\nreturned.\nGet Contact Direct Reports Links\nGet a links to the contact's direct reports.\nRequired scope: Contacts.Read or Contacts.Write\nRequest\nParameters\nName Type Default Notes\n*object_id 31944231-fd52-\n4a7f-b32e-\n7902a01fddf9\nThe object ID (GUID) of the target contact.\nDELETE /contacts/{object_id}/$links/manager?api-version\nGET /contacts/{object_id}/$links/directReports?api-version", + "Text": "23 / 27| Improve this Doc\uF1C5View Source\uF1C5ParametersNameTypeDefaultNotes*object_id31944231-fd52-4a7f-b32e-7902a01fddf9The object ID (GUID) of the target contact.*api-version1.6The version of the Graph API to target.Beginning with version 1.5, the api-version stringis represented in major.minor format. Priorreleases were represented as date strings:'2013-11-08' and '2013-04-05'. Required.ResponsesStatusCodeTypeDescriptionSamples204No Content. Indicates success. N response body isreturned.Get Contact Direct Reports LinksGet a links to the contact's direct reports.Required scope: Contacts.Read or Contacts.WriteRequestParametersNameTypeDefaultNotes*object_id31944231-fd52-4a7f-b32e-7902a01fddf9The object ID (GUID) of the target contact.DELETE /contacts/{object_id}/$links/manager?api-versionGET /contacts/{object_id}/$links/directReports?api-version", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=graph_windows_net_myorganization_Contacts_1_6_get_contact_direct_reports_links.md&value=---%0Auid%3A%20graph.windows.net%2Fmyorganization%2FContacts%2F1.6%2Fget%20contact%20direct%20reports%20links%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -860,7 +860,7 @@ }, { "Number": 24, - "Text": "24 / 27\n| Improve this Doc\uF1C5View Source\uF1C5\nName Type Default Notes\n*api-\nversion\n1.6 The version of the Graph API to target.\nBeginning with version 1.5, the api-version string\nis represented in major.minor format. Prior\nreleases were represented as date strings:\n'2013-11-08' and '2013-04-05'. Required.\nResponses\nStatus\nCode Type Description Samples\n200 OK.\nIndicates\nsuccess.\nOne or more\ndirect\nreports are\nreturned.\nMime type: application/json\nGet Contact MemberOf Links\nGet a links to the contact's direct group and directory role memberships.\nRequired scope: Contacts.Read or Contacts.Write\nRequest\nParameters\nName Type Default Notes\n*object_id 31944231-fd52-\n4a7f-b32e-\n7902a01fddf9\nThe object ID (GUID) of the target contact.\n{ \n\"odata.metadata\":\n\"https://graph.windows.net/myorganization/$metadata#dir\n\"value\": [\n{ \n\"url\": \"https://graph.windows.net/myorganization/\n4e26-b24f-c830606ef41c/Microsoft.DirectoryServices.Cont\n} \n]\nGET /contacts/{object_id}/$links/memberOf?api-version", + "Text": "24 / 27| Improve this Doc\uF1C5View Source\uF1C5NameTypeDefaultNotes*api-version1.6The version of the Graph API to target.Beginning with version 1.5, the api-version stringis represented in major.minor format. Priorreleases were represented as date strings:'2013-11-08' and '2013-04-05'. Required.ResponsesStatusCodeTypeDescriptionSamples200OK.Indicatessuccess.One or moredirectreports arereturned.Mime type: application/jsonGet Contact MemberOf LinksGet a links to the contact's direct group and directory role memberships.Required scope: Contacts.Read or Contacts.WriteRequestParametersNameTypeDefaultNotes*object_id31944231-fd52-4a7f-b32e-7902a01fddf9The object ID (GUID) of the target contact.{ \"odata.metadata\": \"https://graph.windows.net/myorganization/$metadata#dir \"value\": [ { \"url\": \"https://graph.windows.net/myorganization/4e26-b24f-c830606ef41c/Microsoft.DirectoryServices.Cont } ]GET /contacts/{object_id}/$links/memberOf?api-version", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=graph_windows_net_myorganization_Contacts_1_6_get_contact_memberOf_links.md&value=---%0Auid%3A%20graph.windows.net%2Fmyorganization%2FContacts%2F1.6%2Fget%20contact%20memberOf%20links%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -884,12 +884,12 @@ }, { "Number": 25, - "Text": "25 / 27\nName Type Default Notes\n*api-\nversion\n1.6 The version of the Graph API to target.\nBeginning with version 1.5, the api-version string\nis represented in major.minor format. Prior\nreleases were represented as date strings:\n'2013-11-08' and '2013-04-05'. Required.\nResponses\nStatus\nCode Type Description Samples\n200 OK.\nIndicates\nsuccess.\nOne or more\ngroups\nand/or\ndirectory\nroles are\nreturned.\nMime type: application/json\nDefinitions\nContact\nName Type Notes\nobjectType string\nobjectId string\ndeletionTimestamp string (date-time)\ncity string\ncountry string\ndepartment string\n{ \n\"odata.metadata\":\n\"https://graph.windows.net/myorganization/$metadata#dir\n\"value\": [\n{ \n\"url\": \"https://graph.windows.net/myorganization/\nb942-47c9-a10e-a4bee353ce60/Microsoft.DirectoryServices\n} \n]", + "Text": "25 / 27NameTypeDefaultNotes*api-version1.6The version of the Graph API to target.Beginning with version 1.5, the api-version stringis represented in major.minor format. Priorreleases were represented as date strings:'2013-11-08' and '2013-04-05'. Required.ResponsesStatusCodeTypeDescriptionSamples200OK.Indicatessuccess.One or moregroupsand/ordirectoryroles arereturned.Mime type: application/jsonDefinitionsContactNameTypeNotesobjectTypestringobjectIdstringdeletionTimestampstring (date-time)citystringcountrystringdepartmentstring{ \"odata.metadata\": \"https://graph.windows.net/myorganization/$metadata#dir \"value\": [ { \"url\": \"https://graph.windows.net/myorganization/b942-47c9-a10e-a4bee353ce60/Microsoft.DirectoryServices } ]", "Links": [] }, { "Number": 26, - "Text": "26 / 27\nName Type Notes\ndirSyncEnabled boolean\ndisplayName string\nfacsimileTelephoneNumber string\ngivenName string\njobTitle string\nlastDirSyncTime string (date-time)\nmail string\nmailNickname string\nmobile string\nphysicalDeliveryOfficeName string\npostalCode string\nprovisioningErrors ProvisioningError[]\nproxyAddresses array\nsipProxyAddress string\nstate string\nstreetAddress string\nsurname string\ntelephoneNumber string\nthumbnailPhoto string\nProvisioningError\nName Type Notes\nerrorDetail string", + "Text": "26 / 27NameTypeNotesdirSyncEnabledbooleandisplayNamestringfacsimileTelephoneNumberstringgivenNamestringjobTitlestringlastDirSyncTimestring (date-time)mailstringmailNicknamestringmobilestringphysicalDeliveryOfficeNamestringpostalCodestringprovisioningErrorsProvisioningError[]proxyAddressesarraysipProxyAddressstringstatestringstreetAddressstringsurnamestringtelephoneNumberstringthumbnailPhotostringProvisioningErrorNameTypeNoteserrorDetailstring", "Links": [ { "Goto": { @@ -913,7 +913,7 @@ }, { "Number": 27, - "Text": "27 / 27\nName Type Notes\nresolved boolean\nserviceInstance string\ntimestamp string (date-time)", + "Text": "27 / 27NameTypeNotesresolvedbooleanserviceInstancestringtimestampstring (date-time)", "Links": [] } ], diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/toc.pdf.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/toc.pdf.verified.json index e871f260716..5bcf9db7018 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/toc.pdf.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/toc.pdf.verified.json @@ -3,7 +3,7 @@ "Pages": [ { "Number": 1, - "Text": "Table of Contents\nHome 2\nArticles 3\nAPI Documentation\n.NET API 5\n.NET API (markdown) 6\n.NET API (apipage) 7\nREST API 8", + "Text": "Table of ContentsHome2Articles3API Documentation.NET API5.NET API (markdown)6.NET API (apipage)7REST API8", "Links": [ { "Goto": { @@ -63,7 +63,7 @@ }, { "Number": 2, - "Text": "2 / 22\ndocfx-seed\nDescription\nThis is a sample docfx documentation project. It contains .NET source code and markdown\nfiles. docfx.json is the configuration file for running docfx. docfx will generate a static\nwebsite as similar to http://docascode.github.io/docfx-seed.\nHow to run\nUnder Windows\nDownload and unzip docfx.zip to run docfx.exe directly!\nRun docfx under current repo! Website will be generated under _site folder.\nRun any web hosting tool to host _site folder, e.g. docfx serve _site.\nCross platform and use dnx\nAs a prerequisite, you will need to install DNVM and DNX. ###Quick Start\ndnvm upgrade to get the latest dnvm.\nAdd feed https://www.myget.org/F/aspnetrelease/api/v2/ to Nuget.config\nFor Windows, the nuget config file is %AppData%\\NuGet\\NuGet.config.\nFor Linux/OSX, the nuget config file is ~/.config/NuGet/NuGet.config.\ndnu commands install docfx to install docfx as a command\nRun docfx under current repo! Website will be generated under _site folder.\nRun any web hosting tool to host _site folder, e.g. docfx serve _site.\nFurther information about docfx\ndocfx is a tool to generate documentation towards .NET source code and markdown files.\nPlease refer to docfx to get start. The docfx website itself is generated by docfx!", + "Text": "2 / 22docfx-seedDescriptionThis is a sample docfx documentation project. It contains .NET source code and markdownfiles. docfx.json is the configuration file for running docfx. docfx will generate a staticwebsite as similar to http://docascode.github.io/docfx-seed.How to runUnder WindowsDownload and unzip docfx.zip to run docfx.exe directly!Run docfx under current repo! Website will be generated under _site folder.Run any web hosting tool to host _site folder, e.g. docfx serve _site.Cross platform and use dnxAs a prerequisite, you will need to install DNVM and DNX. ###Quick Startdnvm upgrade to get the latest dnvm.Add feed https://www.myget.org/F/aspnetrelease/api/v2/ to Nuget.configFor Windows, the nuget config file is %AppData%\\NuGet\\NuGet.config.For Linux/OSX, the nuget config file is ~/.config/NuGet/NuGet.config.dnu commands install docfx to install docfx as a commandRun docfx under current repo! Website will be generated under _site folder.Run any web hosting tool to host _site folder, e.g. docfx serve _site.Further information about docfxdocfx is a tool to generate documentation towards .NET source code and markdown files.Please refer to docfx to get start. The docfx website itself is generated by docfx!", "Links": [ { "Uri": "http://docascode.github.io/docfx-seed/index.html" @@ -88,7 +88,7 @@ { "Number": 3, "NumberOfImages": 1, - "Text": "3 / 22\nGetting Started with docfx\nGetting Started\nThis is a seed.", + "Text": "3 / 22Getting Started with docfxGetting StartedThis is a seed.", "Links": [ { "Uri": "" @@ -100,12 +100,12 @@ }, { "Number": 4, - "Text": "4 / 22\ndocfx is an API documentation generator for .NET, currently support C# and VB. It has the\nability to extract triple slash comments out from your source code. What's more, it has\nsyntax to link additional files to API to add additional remarks. docfx will scan your source\ncode and your additional conceptual files and generate a complete HTML documentation\nwebsite for you. docfx provides the flexibility for you to customize the website through\ntemplates. We currently have several embedded templates, including websites containing\npure static html pages and also website managed by AngularJS.\nClick \"View Source\" for an API to route to the source code in GitHub (your API must be\npushed to GitHub)\ndocfx provide DNX version for cross platform use.\ndocfx can be used within Visual Studio seamlessly. NOTE offical docfx.msbuild nuget\npackage is now in pre-release version. You can also build your own with source code\nand use it locally.\nWe support Docfx Flavored Markdown(DFM) for writing conceptual files. DFM is\n100% compatible with Github Flavored Markdown(GFM) and add several new features\nincluding file inclusion, cross reference, and yaml header.", + "Text": "4 / 22docfx is an API documentation generator for .NET, currently support C# and VB. It has theability to extract triple slash comments out from your source code. What's more, it hassyntax to link additional files to API to add additional remarks. docfx will scan your sourcecode and your additional conceptual files and generate a complete HTML documentationwebsite for you. docfx provides the flexibility for you to customize the website throughtemplates. We currently have several embedded templates, including websites containingpure static html pages and also website managed by AngularJS.Click \"View Source\" for an API to route to the source code in GitHub (your API must bepushed to GitHub)docfx provide DNX version for cross platform use.docfx can be used within Visual Studio seamlessly. NOTE offical docfx.msbuild nugetpackage is now in pre-release version. You can also build your own with source codeand use it locally.We support Docfx Flavored Markdown(DFM) for writing conceptual files. DFM is100% compatible with Github Flavored Markdown(GFM) and add several new featuresincluding file inclusion, cross reference, and yaml header.", "Links": [] }, { "Number": 5, - "Text": "5 / 22\nClasses\nClass1\nThis is a test class.\nStructs\nIssue5432\nNamespace BuildFromAssembly", + "Text": "5 / 22ClassesClass1This is a test class.StructsIssue5432Namespace BuildFromAssembly", "Links": [ { "Uri": "" @@ -117,7 +117,7 @@ }, { "Number": 6, - "Text": "6 / 22\nNamespace BuildFromAssembly\nClasses\nClass1\nThis is a test class.\nStructs\nIssue5432", + "Text": "6 / 22Namespace BuildFromAssemblyClassesClass1This is a test class.StructsIssue5432", "Links": [ { "Uri": "" @@ -129,7 +129,7 @@ }, { "Number": 7, - "Text": "7 / 22\nClasses\nClass1\nThis is a test class.\nStructs\nIssue5432\nNamespace BuildFromAssembly", + "Text": "7 / 22ClassesClass1This is a test class.StructsIssue5432Namespace BuildFromAssembly", "Links": [ { "Uri": "" @@ -141,7 +141,7 @@ }, { "Number": 8, - "Text": "8 / 22\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nSwagger Petstore\nDescribe APIs in Pet Store\npet\nDescription for pet tag\nAddPet\nAdd a new pet to the store\nRequest\nParameters\nName Type Default Notes\n*body Pet Pet object that needs to be added to the store\nResponses\nStatus Code Type Description Samples\n405 Invalid input\nNOTE: Add pet only when you needs.\nUpdatePet\nUpdate an existing pet\nRequest\nParameters\nPOST /pet\nPUT /pet", + "Text": "8 / 22| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5Swagger PetstoreDescribe APIs in Pet StorepetDescription for pet tagAddPetAdd a new pet to the storeRequestParametersNameTypeDefaultNotes*bodyPetPet object that needs to be added to the storeResponsesStatus CodeTypeDescriptionSamples405Invalid inputNOTE: Add pet only when you needs.UpdatePetUpdate an existing petRequestParametersPOST /petPUT /pet", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_addPet.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FaddPet%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -192,7 +192,7 @@ }, { "Number": 9, - "Text": "9 / 22\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nName Type Default Notes\n*body Pet Pet object that needs to be added to the store\nResponses\nStatus Code Type Description Samples\n400 Invalid ID supplied\n404 Pet not found\n405 Validation exception\nFindPetsByStatus\nFinds Pets by status\nMultiple status values can be provided with comma separated strings\nRequest\nParameters\nName Type Default Notes\n*status Status values that need to be considered for filter\nResponses\nStatus Code Type Description Samples\n200 Pet[] successful operation\n400 Invalid status value\nFindPetsByTags\nGET /pet/findByStatus?status", + "Text": "9 / 22| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5NameTypeDefaultNotes*bodyPetPet object that needs to be added to the storeResponsesStatus CodeTypeDescriptionSamples400Invalid ID supplied404Pet not found405Validation exceptionFindPetsByStatusFinds Pets by statusMultiple status values can be provided with comma separated stringsRequestParametersNameTypeDefaultNotes*statusStatus values that need to be considered for filterResponsesStatus CodeTypeDescriptionSamples200Pet[]successful operation400Invalid status valueFindPetsByTagsGET /pet/findByStatus?status", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_findPetsByStatus.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FfindPetsByStatus%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -252,7 +252,7 @@ }, { "Number": 10, - "Text": "10 / 22\n| Improve this Doc\uF1C5View Source\uF1C5\nFinds Pets by tags\nMuliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for\ntesting.\nRequest\nParameters\nName Type Default Notes\n*tags Tags to filter by\nResponses\nStatus Code Type Description Samples\n200 Pet[] successful operation\n400 Invalid tag value\nDeletePet\nDeletes a pet\nRequest\nParameters\nName Type Default Notes\napi_key\n*petId Pet id to delete\nResponses\nGET /pet/findByTags?tags\nDELETE /pet/{petId}", + "Text": "10 / 22| Improve this Doc\uF1C5View Source\uF1C5Finds Pets by tagsMuliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 fortesting.RequestParametersNameTypeDefaultNotes*tagsTags to filter byResponsesStatus CodeTypeDescriptionSamples200Pet[]successful operation400Invalid tag valueDeletePetDeletes a petRequestParametersNameTypeDefaultNotesapi_key*petIdPet id to deleteResponsesGET /pet/findByTags?tagsDELETE /pet/{petId}", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_deletePet.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FdeletePet%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -285,7 +285,7 @@ }, { "Number": 11, - "Text": "11 / 22\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nStatus Code Type Description Samples\n400 Invalid ID supplied\n404 Pet not found\nGetPetById\nFind pet by ID\nReturns a single pet\nRequest\nParameters\nName Type Default Notes\n*petId ID of pet to return\nResponses\nStatus Code Type Description Samples\n200 Pet successful operation\n400 Invalid ID supplied\n404 Pet not found\nUpdatePetWithForm\nUpdates a pet in the store with form data\nRequest\nGET /pet/{petId}\nPOST /pet/{petId}", + "Text": "11 / 22| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5Status CodeTypeDescriptionSamples400Invalid ID supplied404Pet not foundGetPetByIdFind pet by IDReturns a single petRequestParametersNameTypeDefaultNotes*petIdID of pet to returnResponsesStatus CodeTypeDescriptionSamples200Petsuccessful operation400Invalid ID supplied404Pet not foundUpdatePetWithFormUpdates a pet in the store with form dataRequestGET /pet/{petId}POST /pet/{petId}", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_getPetById.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FgetPetById%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -336,7 +336,7 @@ }, { "Number": 12, - "Text": "12 / 22\n| Improve this Doc\uF1C5View Source\uF1C5\nParameters\nName Type Default Notes\n*petId ID of pet that needs to be updated\nname Updated name of the pet\nstatus Updated status of the pet\nResponses\nStatus Code Type Description Samples\n405 Invalid input\nUploadFile\nuploads an image\nRequest\nParameters\nName Type Default Notes\n*petId ID of pet to update\nadditionalMetadata Additional data to pass to server\nfile file to upload\nResponses\nStatus Code Type Description Samples\n200 ApiResponse successful operation\nPOST /pet/{petId}/uploadImage", + "Text": "12 / 22| Improve this Doc\uF1C5View Source\uF1C5ParametersNameTypeDefaultNotes*petIdID of pet that needs to be updatednameUpdated name of the petstatusUpdated status of the petResponsesStatus CodeTypeDescriptionSamples405Invalid inputUploadFileuploads an imageRequestParametersNameTypeDefaultNotes*petIdID of pet to updateadditionalMetadataAdditional data to pass to serverfilefile to uploadResponsesStatus CodeTypeDescriptionSamples200ApiResponsesuccessful operationPOST /pet/{petId}/uploadImage", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_uploadFile.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FuploadFile%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -378,7 +378,7 @@ }, { "Number": 13, - "Text": "13 / 22\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nstore\nAccess to Petstore orders\nAdditional description for store tag\nAddPet\nAdd a new pet to the store\nRequest\nParameters\nName Type Default Notes\n*body Pet Pet object that needs to be added to the store\nResponses\nStatus Code Type Description Samples\n405 Invalid input\nNOTE: Add pet only when you needs.\nGetInventory\nReturns pet inventories by status\nReturns a map of status codes to quantities\nRequest\nResponses\nPOST /pet\nGET /store/inventory", + "Text": "13 / 22| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5storeAccess to Petstore ordersAdditional description for store tagAddPetAdd a new pet to the storeRequestParametersNameTypeDefaultNotes*bodyPetPet object that needs to be added to the storeResponsesStatus CodeTypeDescriptionSamples405Invalid inputNOTE: Add pet only when you needs.GetInventoryReturns pet inventories by statusReturns a map of status codes to quantitiesRequestResponsesPOST /petGET /store/inventory", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_addPet.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FaddPet%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -429,7 +429,7 @@ }, { "Number": 14, - "Text": "14 / 22\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nStatus Code Type Description Samples\n200 object successful operation\nPlaceOrder\nPlace an order for a pet\nRequest\nParameters\nName Type Default Notes\n*body Order order placed for purchasing the pet\nResponses\nStatus Code Type Description Samples\n200 Order successful operation\n400 Invalid Order\nDeleteOrder\nDelete purchase order by ID\nFor valid response try integer IDs with positive integer value. Negative or non-integer\nvalues will generate API errors\nRequest\nParameters\nPOST /store/order\nDELETE /store/order/{orderId}", + "Text": "14 / 22| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5Status CodeTypeDescriptionSamples200objectsuccessful operationPlaceOrderPlace an order for a petRequestParametersNameTypeDefaultNotes*bodyOrderorder placed for purchasing the petResponsesStatus CodeTypeDescriptionSamples200Ordersuccessful operation400Invalid OrderDeleteOrderDelete purchase order by IDFor valid response try integer IDs with positive integer value. Negative or non-integervalues will generate API errorsRequestParametersPOST /store/orderDELETE /store/order/{orderId}", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_placeOrder.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FplaceOrder%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -489,7 +489,7 @@ }, { "Number": 15, - "Text": "15 / 22\n| Improve this Doc\uF1C5View Source\uF1C5\nName Type Default Notes\n*orderId ID of the order that needs to be deleted\nResponses\nStatus Code Type Description Samples\n400 Invalid ID supplied\n404 Order not found\nGetOrderById\nFind purchase order by ID\nFor valid response try integer IDs with value >= 1 and <= 10. Other values will generated\nexceptions\nRequest\nParameters\nName Type Default Notes\n*orderId ID of pet that needs to be fetched\nResponses\nStatus Code Type Description Samples\n200 Order successful operation\n400 Invalid ID supplied\n404 Order not found\nGET /store/order/{orderId}", + "Text": "15 / 22| Improve this Doc\uF1C5View Source\uF1C5NameTypeDefaultNotes*orderIdID of the order that needs to be deletedResponsesStatus CodeTypeDescriptionSamples400Invalid ID supplied404Order not foundGetOrderByIdFind purchase order by IDFor valid response try integer IDs with value >= 1 and <= 10. Other values will generatedexceptionsRequestParametersNameTypeDefaultNotes*orderIdID of pet that needs to be fetchedResponsesStatus CodeTypeDescriptionSamples200Ordersuccessful operation400Invalid ID supplied404Order not foundGET /store/order/{orderId}", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_getOrderById.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FgetOrderById%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -522,7 +522,7 @@ }, { "Number": 16, - "Text": "16 / 22\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nuser\nOperations about user\nCreateUser\nCreate user\nThis can only be done by the logged in user.\nRequest\nParameters\nName Type Default Notes\n*body User Created user object\nResponses\nStatus Code Type Description Samples\ndefault successful operation\nCreateUsersWithArrayInput\nCreates list of users with given input array\nRequest\nParameters\nName Type Default Notes\n*body User[] List of user object\nResponses\nPOST /user\nPOST /user/createWithArray", + "Text": "16 / 22| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5userOperations about userCreateUserCreate userThis can only be done by the logged in user.RequestParametersNameTypeDefaultNotes*bodyUserCreated user objectResponsesStatus CodeTypeDescriptionSamplesdefaultsuccessful operationCreateUsersWithArrayInputCreates list of users with given input arrayRequestParametersNameTypeDefaultNotes*bodyUser[]List of user objectResponsesPOST /userPOST /user/createWithArray", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_createUser.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FcreateUser%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -582,7 +582,7 @@ }, { "Number": 17, - "Text": "17 / 22\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nStatus Code Type Description Samples\ndefault successful operation\nCreateUsersWithListInput\nCreates list of users with given input array\nRequest\nParameters\nName Type Default Notes\n*body User[] List of user object\nResponses\nStatus Code Type Description Samples\ndefault successful operation\nLoginUser\nLogs user into the system\nRequest\nParameters\nName Type Default Notes\n*username The user name for login\n*password The password for login in clear text\nPOST /user/createWithList\nGET /user/login?username&password", + "Text": "17 / 22| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5Status CodeTypeDescriptionSamplesdefaultsuccessful operationCreateUsersWithListInputCreates list of users with given input arrayRequestParametersNameTypeDefaultNotes*bodyUser[]List of user objectResponsesStatus CodeTypeDescriptionSamplesdefaultsuccessful operationLoginUserLogs user into the systemRequestParametersNameTypeDefaultNotes*usernameThe user name for login*passwordThe password for login in clear textPOST /user/createWithListGET /user/login?username&password", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_createUsersWithListInput.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FcreateUsersWithListInput%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -633,7 +633,7 @@ }, { "Number": 18, - "Text": "18 / 22\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nResponses\nStatus Code Type Description Samples\n200 string successful operation\n400 Invalid username/password supplied\nLogoutUser\nLogs out current logged in user session\nRequest\nResponses\nStatus Code Type Description Samples\ndefault successful operation\nDeleteUser\nDelete user\nThis can only be done by the logged in user.\nRequest\nParameters\nName Type Default Notes\n*username The name that needs to be deleted\nResponses\nGET /user/logout\nDELETE /user/{username}", + "Text": "18 / 22| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5ResponsesStatus CodeTypeDescriptionSamples200stringsuccessful operation400Invalid username/password suppliedLogoutUserLogs out current logged in user sessionRequestResponsesStatus CodeTypeDescriptionSamplesdefaultsuccessful operationDeleteUserDelete userThis can only be done by the logged in user.RequestParametersNameTypeDefaultNotes*usernameThe name that needs to be deletedResponsesGET /user/logoutDELETE /user/{username}", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_logoutUser.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FlogoutUser%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -675,7 +675,7 @@ }, { "Number": 19, - "Text": "19 / 22\n| Improve this Doc\uF1C5View Source\uF1C5\n| Improve this Doc\uF1C5View Source\uF1C5\nStatus Code Type Description Samples\n400 Invalid username supplied\n404 User not found\nGetUserByName\nGet user by user name\nRequest\nParameters\nName Type Default Notes\n*username The name that needs to be fetched. Use user1 for testing.\nResponses\nStatus Code Type Description Samples\n200 User successful operation\n400 Invalid username supplied\n404 User not found\nOther APIs\nUpdateUser\nUpdated user\nThis can only be done by the logged in user.\nRequest\nGET /user/{username}", + "Text": "19 / 22| Improve this Doc\uF1C5View Source\uF1C5| Improve this Doc\uF1C5View Source\uF1C5Status CodeTypeDescriptionSamples400Invalid username supplied404User not foundGetUserByNameGet user by user nameRequestParametersNameTypeDefaultNotes*usernameThe name that needs to be fetched. Use user1 for testing.ResponsesStatus CodeTypeDescriptionSamples200Usersuccessful operation400Invalid username supplied404User not foundOther APIsUpdateUserUpdated userThis can only be done by the logged in user.RequestGET /user/{username}", "Links": [ { "Uri": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=petstore_swagger_io_v2_Swagger_Petstore_1_0_0_getUserByName.md&value=---%0Auid%3A%20petstore.swagger.io%2Fv2%2FSwagger%20Petstore%2F1.0.0%2FgetUserByName%0Asummary%3A%20%27*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax%27%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" @@ -726,7 +726,7 @@ }, { "Number": 20, - "Text": "20 / 22\nParameters\nName Type Default Notes\n*username name that need to be updated\n*body User Updated user object\nResponses\nStatus Code Type Description Samples\n400 Invalid user supplied\n404 User not found\nDefinitions\nPet\nName Type Notes\ncategory Category[]\nid integer (int64)\nname string\nphotoUrls array\nstatus string pet status in the store\ntags Tag[]\nCategory\nPUT /user/{username}", + "Text": "20 / 22ParametersNameTypeDefaultNotes*usernamename that need to be updated*bodyUserUpdated user objectResponsesStatus CodeTypeDescriptionSamples400Invalid user supplied404User not foundDefinitionsPetNameTypeNotescategoryCategory[]idinteger (int64)namestringphotoUrlsarraystatusstringpet status in the storetagsTag[]CategoryPUT /user/{username}", "Links": [ { "Goto": { @@ -759,12 +759,12 @@ }, { "Number": 21, - "Text": "21 / 22\nName Type Notes\nid integer (int64)\nname string\nTag\nName Type Notes\nid integer (int64)\nname string\nApiResponse\nName Type Notes\ncode integer (int32)\nmessage string\ntype string\nOrder\nName Type Notes\ncomplete boolean\nid integer (int64)\npetId integer (int64)\nquantity integer (int32)\nshipDate string (date-time)\nstatus string Order Status\nUser", + "Text": "21 / 22NameTypeNotesidinteger (int64)namestringTagNameTypeNotesidinteger (int64)namestringApiResponseNameTypeNotescodeinteger (int32)messagestringtypestringOrderNameTypeNotescompletebooleanidinteger (int64)petIdinteger (int64)quantityinteger (int32)shipDatestring (date-time)statusstringOrder StatusUser", "Links": [] }, { "Number": 22, - "Text": "22 / 22\nName Type Notes\nemail string\nfirstName string\nid integer (int64)\nlastName string\npassword string\nphone string\nuserStatus integer (int32) User Status\nusername string\nSee Alsos\nSee other REST APIs:\nContacts API", + "Text": "22 / 22NameTypeNotesemailstringfirstNamestringidinteger (int64)lastNamestringpasswordstringphonestringuserStatusinteger (int32)User StatususernamestringSee AlsosSee other REST APIs:Contacts API", "Links": [ { "Uri": "" diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/xrefmap.verified.yml b/test/docfx.Snapshot.Tests/SamplesTest.Seed/xrefmap.verified.yml index 6a321df6afb..40113c0832b 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/xrefmap.verified.yml +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/xrefmap.verified.yml @@ -752,6 +752,50 @@ references: fullName.vb: BuildFromProject.Inheritdoc.Issue8129.New nameWithType: Inheritdoc.Issue8129.Issue8129 nameWithType.vb: Inheritdoc.Issue8129.New +- uid: BuildFromProject.Inheritdoc.Issue9736 + name: Inheritdoc.Issue9736 + href: api/BuildFromProject.Inheritdoc.Issue9736.html + commentId: T:BuildFromProject.Inheritdoc.Issue9736 + fullName: BuildFromProject.Inheritdoc.Issue9736 + nameWithType: Inheritdoc.Issue9736 +- uid: BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions + name: Inheritdoc.Issue9736.IJsonApiOptions + href: api/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html + commentId: T:BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions + fullName: BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions + nameWithType: Inheritdoc.Issue9736.IJsonApiOptions +- uid: BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks + name: UseRelativeLinks + href: api/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html#BuildFromProject_Inheritdoc_Issue9736_IJsonApiOptions_UseRelativeLinks + commentId: P:BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks + fullName: BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks + nameWithType: Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks +- uid: BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks* + name: UseRelativeLinks + href: api/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.html#BuildFromProject_Inheritdoc_Issue9736_IJsonApiOptions_UseRelativeLinks_ + commentId: Overload:BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks + isSpec: "True" + fullName: BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks + nameWithType: Inheritdoc.Issue9736.IJsonApiOptions.UseRelativeLinks +- uid: BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions + name: Inheritdoc.Issue9736.JsonApiOptions + href: api/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html + commentId: T:BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions + fullName: BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions + nameWithType: Inheritdoc.Issue9736.JsonApiOptions +- uid: BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks + name: UseRelativeLinks + href: api/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html#BuildFromProject_Inheritdoc_Issue9736_JsonApiOptions_UseRelativeLinks + commentId: P:BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks + fullName: BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks + nameWithType: Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks +- uid: BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks* + name: UseRelativeLinks + href: api/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.html#BuildFromProject_Inheritdoc_Issue9736_JsonApiOptions_UseRelativeLinks_ + commentId: Overload:BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks + isSpec: "True" + fullName: BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks + nameWithType: Inheritdoc.Issue9736.JsonApiOptions.UseRelativeLinks - uid: BuildFromProject.Issue8540 name: BuildFromProject.Issue8540 href: api/BuildFromProject.Issue8540.html diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.verified.md new file mode 100644 index 00000000000..77e0eb7cee2 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.verified.md @@ -0,0 +1,40 @@ +# Interface Inheritdoc.Issue9736.IJsonApiOptions + +Namespace: [BuildFromProject](BuildFromProject.md) +Assembly: BuildFromProject.dll + +```csharp +public interface Inheritdoc.Issue9736.IJsonApiOptions +``` + +## Properties + +### UseRelativeLinks + +Whether to use relative links for all resources. false by default. + +```csharp +bool UseRelativeLinks { get; } +``` + +#### Property Value + + [bool](https://learn.microsoft.com/dotnet/api/system.boolean) + +#### Examples + +
options.UseRelativeLinks = true;
+ +
{
+  "type": "articles",
+  "id": "4309",
+  "relationships": {
+     "author": {
+       "links": {
+         "self": "/api/shopping/articles/4309/relationships/author",
+         "related": "/api/shopping/articles/4309/author"
+       }
+     }
+  }
+}
+ diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.verified.md new file mode 100644 index 00000000000..f0b10502450 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.verified.md @@ -0,0 +1,58 @@ +# Class Inheritdoc.Issue9736.JsonApiOptions + +Namespace: [BuildFromProject](BuildFromProject.md) +Assembly: BuildFromProject.dll + +```csharp +public sealed class Inheritdoc.Issue9736.JsonApiOptions : Inheritdoc.Issue9736.IJsonApiOptions +``` + +#### Inheritance + +[object](https://learn.microsoft.com/dotnet/api/system.object) ← +[Inheritdoc.Issue9736.JsonApiOptions](BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.md) + +#### Implements + +[Inheritdoc.Issue9736.IJsonApiOptions](BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.md) + +#### Inherited Members + +[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)), +[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)), +[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode), +[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype), +[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals), +[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring) + +## Properties + +### UseRelativeLinks + +Whether to use relative links for all resources. false by default. + +```csharp +public bool UseRelativeLinks { get; set; } +``` + +#### Property Value + + [bool](https://learn.microsoft.com/dotnet/api/system.boolean) + +#### Examples + +
options.UseRelativeLinks = true;
+ +
{
+  "type": "articles",
+  "id": "4309",
+  "relationships": {
+     "author": {
+       "links": {
+         "self": "/api/shopping/articles/4309/relationships/author",
+         "related": "/api/shopping/articles/4309/author"
+       }
+     }
+  }
+}
+ diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue9736.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue9736.verified.md new file mode 100644 index 00000000000..7703123f788 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue9736.verified.md @@ -0,0 +1,24 @@ +# Class Inheritdoc.Issue9736 + +Namespace: [BuildFromProject](BuildFromProject.md) +Assembly: BuildFromProject.dll + +```csharp +public class Inheritdoc.Issue9736 +``` + +#### Inheritance + +[object](https://learn.microsoft.com/dotnet/api/system.object) ← +[Inheritdoc.Issue9736](BuildFromProject.Inheritdoc.Issue9736.md) + +#### Inherited Members + +[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)), +[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)), +[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode), +[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype), +[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone), +[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals), +[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring) + diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.verified.md index f0cc6b6b107..f3d3eb04194 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.verified.md @@ -38,6 +38,10 @@ A nice class [Class1.Issue8948](BuildFromProject.Class1.Issue8948.md) + [Inheritdoc.Issue9736](BuildFromProject.Inheritdoc.Issue9736.md) + + [Inheritdoc.Issue9736.JsonApiOptions](BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.md) + [Class1.Test](BuildFromProject.Class1.Test\-1.md) ### Structs @@ -50,6 +54,8 @@ A nice class [Class1.IIssue8948](BuildFromProject.Class1.IIssue8948.md) + [Inheritdoc.Issue9736.IJsonApiOptions](BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.md) + ### Enums [Class1.Issue9260](BuildFromProject.Class1.Issue9260.md) diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Cat-2.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Cat-2.verified.md index b5866d04bd1..e4d4b1532ae 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Cat-2.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Cat-2.verified.md @@ -53,6 +53,7 @@ This type is a struct type, class type can't be used for this parameter. ## Examples

Here's example of how to create an instance of this class. As T is limited with class and K is limited with struct.

+ 
var a = new Cat(object, int)();
 int catNumber = new int();
 unsafe
diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.ICatExtension.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.ICatExtension.verified.md
index 7eb86dae15f..f0ba1fb6128 100644
--- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.ICatExtension.verified.md
+++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.ICatExtension.verified.md
@@ -4,7 +4,8 @@ Namespace: [CatLibrary](CatLibrary.md)
 Assembly: CatLibrary.dll  
 
 It's the class that contains ICat interface's extension method.
-
This class must be public and static.
Also it shouldn't be a geneic class

+
This class must be public and static.

+
Also it shouldn't be a geneic class

 
 ```csharp
 public static class ICatExtension
diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.verified.md
index 068fafeeb11..9701b5ef723 100644
--- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.verified.md
+++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.verified.md
@@ -21,7 +21,8 @@
  [ICatExtension](CatLibrary.ICatExtension.md)
 
 It's the class that contains ICat interface's extension method.
-
This class must be public and static.
Also it shouldn't be a geneic class

+
This class must be public and static.

+
Also it shouldn't be a geneic class

 
  [Tom](CatLibrary.Tom.md)
 
diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/toc.verified.yml b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/toc.verified.yml
index e9662078cc9..d9e92874513 100644
--- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/toc.verified.yml
+++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/toc.verified.yml
@@ -59,6 +59,10 @@
     href: BuildFromProject.Inheritdoc.Issue7484.md
   - name: Inheritdoc.Issue8101
     href: BuildFromProject.Inheritdoc.Issue8101.md
+  - name: Inheritdoc.Issue9736
+    href: BuildFromProject.Inheritdoc.Issue9736.md
+  - name: Inheritdoc.Issue9736.JsonApiOptions
+    href: BuildFromProject.Inheritdoc.Issue9736.JsonApiOptions.md
   - name: Issue8725
     href: BuildFromProject.Issue8725.md
   - name: Structs
@@ -69,6 +73,8 @@
     href: BuildFromProject.Class1.IIssue8948.md
   - name: IInheritdoc
     href: BuildFromProject.IInheritdoc.md
+  - name: Inheritdoc.Issue9736.IJsonApiOptions
+    href: BuildFromProject.Inheritdoc.Issue9736.IJsonApiOptions.md
   - name: Enums
   - name: Class1.Issue9260
     href: BuildFromProject.Class1.Issue9260.md