From c6f6dc14e73d6ca7fd474fe3d41477f0a06da7ff Mon Sep 17 00:00:00 2001 From: Yufei Huang Date: Fri, 20 Oct 2023 13:46:29 +0800 Subject: [PATCH] feat: basic API page output for .NET (#9309) --- .editorconfig | 1 + Directory.Build.props | 2 +- Directory.Packages.props | 2 + samples/seed/docfx.json | 23 + samples/seed/toc.yml | 2 + .../v1.0/ApiPage.d.ts | 49 +- src/Docfx.Build/ApiPage/ApiPage.cs | 162 +++++ .../ApiPage/ApiPageHtmlTemplate.cs | 114 ++++ .../ApiPage/ApiPageMarkdownTemplate.cs | 128 ++++ src/Docfx.Build/ApiPage/ApiPageProcessor.cs | 73 ++ src/Docfx.Build/Docfx.Build.csproj | 2 + src/Docfx.Build/DocumentBuilder.cs | 17 +- src/Docfx.Build/HtmlTemplate.cs | 50 ++ src/Docfx.Build/OneOfJsonConverterFactory.cs | 80 +++ src/Docfx.Dotnet/Docfx.Dotnet.csproj | 16 +- src/Docfx.Dotnet/DotnetApiCatalog.Page.cs | 254 ++++--- src/Docfx.Dotnet/DotnetApiCatalog.Toc.cs | 7 +- src/Docfx.Dotnet/DotnetApiCatalog.cs | 30 +- src/Docfx.Dotnet/MetadataJsonConfig.cs | 5 + src/Docfx.Dotnet/PageWriter.cs | 162 ----- src/Docfx.Plugins/IDocumentProcessor.cs | 1 - templates/modern/ApiPage.html.primary.tmpl | 4 + templates/modern/schemas/ApiPage.schema.json | 496 -------------- templates/modern/src/dotnet.scss | 2 +- test/Docfx.Build.Tests/HtmlTemplateTest.cs | 33 + ...romAssembly.Class1.html.view.verified.json | 18 + .../BuildFromAssembly.html.view.verified.json | 18 + ...pSourceCode.CSharp.html.view.verified.json | 18 + ...omCSharpSourceCode.html.view.verified.json | 18 + ....Class1.IIssue8948.html.view.verified.json | 18 + ...t.Class1.Issue8665.html.view.verified.json | 18 + ...Issue8696Attribute.html.view.verified.json | 18 + ...t.Class1.Issue8948.html.view.verified.json | 18 + ...ject.Class1.Test-1.html.view.verified.json | 18 + ...FromProject.Class1.html.view.verified.json | 18 + ...roject.IInheritdoc.html.view.verified.json | 18 + ...Issue6366.Class1-1.html.view.verified.json | 18 + ...c.Issue6366.Class2.html.view.verified.json | 18 + ...heritdoc.Issue6366.html.view.verified.json | 18 + ...heritdoc.Issue7035.html.view.verified.json | 18 + ...heritdoc.Issue7484.html.view.verified.json | 18 + ...heritdoc.Issue8101.html.view.verified.json | 18 + ...heritdoc.Issue8129.html.view.verified.json | 18 + ...Project.Inheritdoc.html.view.verified.json | 18 + ...ject.Issue8540.A.A.html.view.verified.json | 18 + ...roject.Issue8540.A.html.view.verified.json | 18 + ...ject.Issue8540.B.B.html.view.verified.json | 18 + ...roject.Issue8540.B.html.view.verified.json | 18 + ...mProject.Issue8540.html.view.verified.json | 18 + .../BuildFromProject.html.view.verified.json | 18 + ...rceCode.BaseClass1.html.view.verified.json | 18 + ...BSourceCode.Class1.html.view.verified.json | 18 + ...ldFromVBSourceCode.html.view.verified.json | 18 + .../CatLibrary.Cat-2.html.view.verified.json | 18 + ...ary.CatException-1.html.view.verified.json | 18 + ...tLibrary.Complex-2.html.view.verified.json | 18 + ...sRefType.ColorType.html.view.verified.json | 18 + ...ainersRefTypeChild.html.view.verified.json | 18 + ...TypeChildInterface.html.view.verified.json | 18 + ...ersRefTypeDelegate.html.view.verified.json | 18 + ....ContainersRefType.html.view.verified.json | 18 + ...xplicitLayoutClass.html.view.verified.json | 18 + ...rary.Core.Issue231.html.view.verified.json | 18 + .../CatLibrary.Core.html.view.verified.json | 18 + ...ary.FakeDelegate-1.html.view.verified.json | 18 + ...CatLibrary.IAnimal.html.view.verified.json | 18 + .../CatLibrary.ICat.html.view.verified.json | 18 + ...rary.ICatExtension.html.view.verified.json | 18 + ...ary.MRefDelegate-3.html.view.verified.json | 18 + ...MRefNormalDelegate.html.view.verified.json | 18 + .../CatLibrary.Tom.html.view.verified.json | 18 + ...y.TomFromBaseClass.html.view.verified.json | 18 + .../CatLibrary.html.view.verified.json | 18 + ...meration.ColorType.html.view.verified.json | 18 + ...f.Demo.Enumeration.html.view.verified.json | 18 + .../apipage/MRef.Demo.html.view.verified.json | 18 + .../apipage/MRef.html.view.verified.json | 18 + .../apipage/toc.html.view.verified.json | 627 ++++++++++++++++++ .../apipage/toc.json.view.verified.json | 3 + .../apipage/toc.verified.json | 339 ++++++++++ .../SamplesTest.Seed/index.verified.json | 262 +++++++- ...romAssembly.Class1.html.view.verified.json | 6 +- .../BuildFromAssembly.html.view.verified.json | 4 +- ...pSourceCode.CSharp.html.view.verified.json | 6 +- ...omCSharpSourceCode.html.view.verified.json | 4 +- ....Class1.IIssue8948.html.view.verified.json | 6 +- ...t.Class1.Issue8665.html.view.verified.json | 6 +- ...Issue8696Attribute.html.view.verified.json | 6 +- ...t.Class1.Issue8948.html.view.verified.json | 6 +- ...ject.Class1.Test-1.html.view.verified.json | 6 +- ...FromProject.Class1.html.view.verified.json | 6 +- ...roject.IInheritdoc.html.view.verified.json | 6 +- ...Issue6366.Class1-1.html.view.verified.json | 6 +- ...c.Issue6366.Class2.html.view.verified.json | 6 +- ...heritdoc.Issue6366.html.view.verified.json | 6 +- ...heritdoc.Issue7035.html.view.verified.json | 6 +- ...heritdoc.Issue7484.html.view.verified.json | 6 +- ...heritdoc.Issue8101.html.view.verified.json | 6 +- ...heritdoc.Issue8129.html.view.verified.json | 6 +- ...Project.Inheritdoc.html.view.verified.json | 6 +- ...ject.Issue8540.A.A.html.view.verified.json | 6 +- ...roject.Issue8540.A.html.view.verified.json | 4 +- ...ject.Issue8540.B.B.html.view.verified.json | 6 +- ...roject.Issue8540.B.html.view.verified.json | 4 +- ...mProject.Issue8540.html.view.verified.json | 4 +- .../BuildFromProject.html.view.verified.json | 4 +- ...rceCode.BaseClass1.html.view.verified.json | 6 +- ...BSourceCode.Class1.html.view.verified.json | 6 +- ...ldFromVBSourceCode.html.view.verified.json | 4 +- .../CatLibrary.Cat-2.html.view.verified.json | 6 +- ...ary.CatException-1.html.view.verified.json | 6 +- ...tLibrary.Complex-2.html.view.verified.json | 6 +- ...sRefType.ColorType.html.view.verified.json | 4 +- ...ainersRefTypeChild.html.view.verified.json | 6 +- ...TypeChildInterface.html.view.verified.json | 4 +- ...ersRefTypeDelegate.html.view.verified.json | 4 +- ....ContainersRefType.html.view.verified.json | 6 +- ...xplicitLayoutClass.html.view.verified.json | 6 +- ...rary.Core.Issue231.html.view.verified.json | 6 +- .../CatLibrary.Core.html.view.verified.json | 4 +- ...ary.FakeDelegate-1.html.view.verified.json | 4 +- ...CatLibrary.IAnimal.html.view.verified.json | 6 +- .../CatLibrary.ICat.html.view.verified.json | 6 +- ...rary.ICatExtension.html.view.verified.json | 6 +- ...ary.MRefDelegate-3.html.view.verified.json | 4 +- ...MRefNormalDelegate.html.view.verified.json | 4 +- .../md/CatLibrary.Tom.html.view.verified.json | 6 +- ...y.TomFromBaseClass.html.view.verified.json | 6 +- .../md/CatLibrary.html.view.verified.json | 4 +- ...meration.ColorType.html.view.verified.json | 4 +- ...f.Demo.Enumeration.html.view.verified.json | 4 +- .../md/MRef.Demo.html.view.verified.json | 4 +- .../md/MRef.html.view.verified.json | 4 +- .../toc.html.view.verified.json | 9 + .../toc.json.view.verified.json | 2 +- .../SamplesTest.Seed/toc.verified.json | 6 + .../api-CatLibrary.html-term-cat.verified.png | 4 +- .../api-CatLibrary.html-term-cat.verified.png | 4 +- .../api-CatLibrary.html-term-cat.verified.png | 4 +- .../api-CatLibrary.html-term-cat.verified.png | 4 +- ...BuildFromProject.Class1.html.verified.html | 2 +- ...-CatLibrary.Cat-2.html-q-cat.verified.html | 2 +- ...api-CatLibrary.html-term-cat.verified.html | 19 +- .../html/api-CatLibrary.html.verified.html | 2 +- ...csharp_coding_standards.html.verified.html | 2 +- ...pescript-markdown-extensions.verified.html | 2 +- .../html/index.html.verified.html | 7 +- .../html/restapi-petstore.html.verified.html | 2 +- .../BuildFromAssembly.Class1.verified.md | 12 +- .../BuildFromAssembly.verified.md | 4 +- ...ildFromCSharpSourceCode.CSharp.verified.md | 10 +- .../BuildFromCSharpSourceCode.verified.md | 4 +- ...dFromProject.Class1.IIssue8948.verified.md | 6 +- ...ldFromProject.Class1.Issue8665.verified.md | 28 +- ...ject.Class1.Issue8696Attribute.verified.md | 10 +- ...ldFromProject.Class1.Issue8948.verified.md | 12 +- ...BuildFromProject.Class1.Test-1.verified.md | 8 +- .../BuildFromProject.Class1.verified.md | 36 +- .../BuildFromProject.IInheritdoc.verified.md | 6 +- ....Inheritdoc.Issue6366.Class1-1.verified.md | 12 +- ...ct.Inheritdoc.Issue6366.Class2.verified.md | 12 +- ...omProject.Inheritdoc.Issue6366.verified.md | 8 +- ...omProject.Inheritdoc.Issue7035.verified.md | 12 +- ...omProject.Inheritdoc.Issue7484.verified.md | 18 +- ...omProject.Inheritdoc.Issue8101.verified.md | 16 +- ...omProject.Inheritdoc.Issue8129.verified.md | 8 +- .../BuildFromProject.Inheritdoc.verified.md | 16 +- ...BuildFromProject.Issue8540.A.A.verified.md | 8 +- .../BuildFromProject.Issue8540.A.verified.md | 4 +- ...BuildFromProject.Issue8540.B.B.verified.md | 8 +- .../BuildFromProject.Issue8540.B.verified.md | 4 +- .../BuildFromProject.Issue8540.verified.md | 6 +- .../BuildFromProject.verified.md | 34 +- ...ildFromVBSourceCode.BaseClass1.verified.md | 14 +- .../BuildFromVBSourceCode.Class1.verified.md | 24 +- .../BuildFromVBSourceCode.verified.md | 6 +- .../CatLibrary.Cat-2.verified.md | 66 +- .../CatLibrary.CatException-1.verified.md | 10 +- .../CatLibrary.Complex-2.verified.md | 8 +- ...re.ContainersRefType.ColorType.verified.md | 4 +- ...RefType.ContainersRefTypeChild.verified.md | 8 +- ...ontainersRefTypeChildInterface.verified.md | 4 +- ...Type.ContainersRefTypeDelegate.verified.md | 4 +- ...Library.Core.ContainersRefType.verified.md | 24 +- ...brary.Core.ExplicitLayoutClass.verified.md | 8 +- .../CatLibrary.Core.Issue231.verified.md | 12 +- .../CatLibrary.Core.verified.md | 18 +- .../CatLibrary.FakeDelegate-1.verified.md | 6 +- .../CatLibrary.IAnimal.verified.md | 18 +- .../CatLibrary.ICat.verified.md | 12 +- .../CatLibrary.ICatExtension.verified.md | 12 +- .../CatLibrary.MRefDelegate-3.verified.md | 4 +- .../CatLibrary.MRefNormalDelegate.verified.md | 4 +- .../CatLibrary.Tom.verified.md | 20 +- .../CatLibrary.TomFromBaseClass.verified.md | 10 +- .../CatLibrary.verified.md | 26 +- ...Ref.Demo.Enumeration.ColorType.verified.md | 4 +- .../MRef.Demo.Enumeration.verified.md | 4 +- .../MRef.Demo.verified.md | 4 +- .../SamplesTest.SeedMarkdown/MRef.verified.md | 4 +- test/docfx.Snapshot.Tests/SamplesTest.cs | 2 +- 201 files changed, 3599 insertions(+), 1270 deletions(-) rename templates/modern/schemas/ApiPage.schema.d.ts => schemas/v1.0/ApiPage.d.ts (70%) create mode 100644 src/Docfx.Build/ApiPage/ApiPage.cs create mode 100644 src/Docfx.Build/ApiPage/ApiPageHtmlTemplate.cs create mode 100644 src/Docfx.Build/ApiPage/ApiPageMarkdownTemplate.cs create mode 100644 src/Docfx.Build/ApiPage/ApiPageProcessor.cs create mode 100644 src/Docfx.Build/HtmlTemplate.cs create mode 100644 src/Docfx.Build/OneOfJsonConverterFactory.cs delete mode 100644 src/Docfx.Dotnet/PageWriter.cs create mode 100644 templates/modern/ApiPage.html.primary.tmpl delete mode 100644 templates/modern/schemas/ApiPage.schema.json create mode 100644 test/Docfx.Build.Tests/HtmlTemplateTest.cs create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromAssembly.Class1.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromAssembly.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromCSharpSourceCode.CSharp.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromCSharpSourceCode.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Class1.IIssue8948.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Class1.Issue8665.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Class1.Issue8696Attribute.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Class1.Issue8948.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Class1.Test-1.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Class1.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.IInheritdoc.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue6366.Class1-1.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue6366.Class2.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue6366.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue7035.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue7484.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue8101.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue8129.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Issue8540.A.A.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Issue8540.A.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Issue8540.B.B.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Issue8540.B.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Issue8540.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromVBSourceCode.BaseClass1.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromVBSourceCode.Class1.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromVBSourceCode.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Cat-2.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.CatException-1.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Complex-2.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.ContainersRefType.ColorType.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.ContainersRefType.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.ExplicitLayoutClass.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.Issue231.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.FakeDelegate-1.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.IAnimal.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.ICat.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.ICatExtension.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.MRefDelegate-3.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.MRefNormalDelegate.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Tom.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.TomFromBaseClass.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/MRef.Demo.Enumeration.ColorType.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/MRef.Demo.Enumeration.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/MRef.Demo.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/MRef.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.html.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.json.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.verified.json diff --git a/.editorconfig b/.editorconfig index bd4f777157d..592aef7b7b1 100644 --- a/.editorconfig +++ b/.editorconfig @@ -162,6 +162,7 @@ dotnet_diagnostic.IDE0110.severity = suggestion # IDE0110: Remove unnecessary di dotnet_diagnostic.IDE0240.severity = suggestion # IDE0240: Nullable directive is redundant dotnet_diagnostic.IDE0241.severity = suggestion # IDE0241: Nullable directive is unnecessary +dotnet_diagnostic.CS8509.severity = suggestion # The switch expression does not handle all possible values of its input type csharp_style_unused_value_expression_statement_preference = discard_variable:suggestion # IDE0058: Remove unnecessary expression value csharp_style_unused_value_assignment_preference = discard_variable:suggestion # IDE0059: Remove unnecessary value assignment diff --git a/Directory.Build.props b/Directory.Build.props index e5001fcf1e1..37385bad721 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -3,7 +3,7 @@ true net6.0;net7.0 $(TargetFrameworks);net8.0 - Latest + Preview enable true true diff --git a/Directory.Packages.props b/Directory.Packages.props index bd42d6848f1..630374ac7ab 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -27,6 +27,8 @@ + + diff --git a/samples/seed/docfx.json b/samples/seed/docfx.json index afb96b3110e..b9d872038d8 100644 --- a/samples/seed/docfx.json +++ b/samples/seed/docfx.json @@ -40,12 +40,35 @@ "enumSortOrder": "declaringOrder", "outputFormat": "markdown", "output": "obj/md" + }, + { + "src": [ + { + "files": [ + "assembly/bin/**/*.dll", + "project/**/*.csproj", + "solution/**/*.sln", + "csharp/**/*.cs", + "vb/**/*.vb" + ], + "exclude": [ + "project/Project.Core/**" + ], + "src": "dotnet" + } + ], + "namespaceLayout": "nested", + "enumSortOrder": "declaringOrder", + "outputFormat": "apiPage", + "output": "obj/apipage" } ], "build": { "content": [ { "files": [ "**/*.yml" ], "src": "obj/api", "dest": "api" }, + { "files": [ "**/*.yml" ], "src": "obj/apipage", "dest": "apipage" }, { "files": [ "**" ], "src": "obj/md", "dest": "md" }, + { "files": [ "**" ], "src": "obj/apipage", "dest": "apipage" }, { "files": [ "articles/**/*.{md,yml}", "*.md", "toc.yml", "restapi/**", "md/**", "md2/**" ] } ], "resource": [ diff --git a/samples/seed/toc.yml b/samples/seed/toc.yml index aee99d4ceeb..fa7f1f3b056 100644 --- a/samples/seed/toc.yml +++ b/samples/seed/toc.yml @@ -8,5 +8,7 @@ href: obj/api/ - name: .NET API (markdown) href: obj/md/ + - name: .NET API (apipage) + href: obj/apipage/ - name: REST API href: restapi/ diff --git a/templates/modern/schemas/ApiPage.schema.d.ts b/schemas/v1.0/ApiPage.d.ts similarity index 70% rename from templates/modern/schemas/ApiPage.schema.d.ts rename to schemas/v1.0/ApiPage.d.ts index f45b391b06a..0d26c1c8800 100644 --- a/templates/modern/schemas/ApiPage.schema.d.ts +++ b/schemas/v1.0/ApiPage.d.ts @@ -1,17 +1,12 @@ // Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. -/** - * This file is used to generate the API page JSON schema. To generate the schema: - * 1. run `npx typescript-json-schema ApiPage.schema.d.ts ApiPage --required --strictNullChecks --out ApiPage.schema.json` - * 2. manually mark properties as markdown - */ - /** Define the markdown content type */ type markdown = string; /** Represents an inline composed of text or links */ -type Inline = string | (string | { text: string; url?: string })[]; +type Span = string | { text: string; url?: string }; +type Inline = Span | Span[]; /** Represents a markdown block */ type Markdown = { @@ -44,7 +39,7 @@ type Api = ( /** API source URL */ src?: string; - /** Opaque metadata about the API as HTML data-* attributes */ + /** Opaque metadata about the API as HTML data-{key} attributes */ metadata?: { [key: string]: string }; }; @@ -71,31 +66,33 @@ type Code = { /** Code text */ code: string; - /** Code [langauge identifier](https://code.visualstudio.com/docs/languages/identifiers#_known-language-identifiers) */ + /** Code [language identifier](https://code.visualstudio.com/docs/languages/identifiers#_known-language-identifiers) */ languageId?: string; }; -/** Represents a set of parameters */ -type Params = { - parameters: { - /** Parameter name */ - name?: string; +type Param = { + /** Parameter name */ + name?: string; + + /** Parameter type */ + type?: Inline; - /** Parameter type */ - type?: Inline; + /** Parameter default value */ + default?: string; - /** Parameter default value */ - default?: string; + /** Parameter description in markdown format */ + description?: markdown; - /** Parameter description in markdown format */ - description?: markdown; + /** Is this parameter deprecated, or the deprecation reason */ + deprecated?: boolean | string; - /** Is this parameter deprecated, or the deprecation reason */ - deprecated?: boolean | string; + /** Is this parameter optional? */ + optional?: boolean; +} - /** Is this parameter optional? */ - optional?: boolean; - }[]; +/** Represents a set of parameters */ +type Params = { + parameters: Param[]; }; /** Represents block level elements */ @@ -114,7 +111,7 @@ type ApiPage = { /** Page title */ title: string; - /** Opaque metadata about the page as HTML tags */ + /** Opaque metadata about the page as HTML \ tags */ metadata?: { [key: string]: string | string[] }; /** Default code [language identifier](https://code.visualstudio.com/docs/languages/identifiers#_known-language-identifiers) */ diff --git a/src/Docfx.Build/ApiPage/ApiPage.cs b/src/Docfx.Build/ApiPage/ApiPage.cs new file mode 100644 index 00000000000..73c276184f8 --- /dev/null +++ b/src/Docfx.Build/ApiPage/ApiPage.cs @@ -0,0 +1,162 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +#if NET7_0_OR_GREATER + +using System.Text.Json; +using System.Text.Json.Serialization; +using OneOf; + +#nullable enable + +namespace Docfx.Build.ApiPage; + +struct LinkSpan +{ + public required string text { get; init; } + public string? url { get; init; } +} + +[GenerateOneOf] +partial class Span : OneOfBase { } + +[GenerateOneOf] +partial class Inline : OneOfBase { } + +struct Markdown +{ + public required string markdown { get; init; } +} + +struct H1 +{ + public required string h1 { get; init; } + public string? id { get; init; } +} + +struct H2 +{ + public required string h2 { get; init; } + public string? id { get; init; } +} + +struct H3 +{ + public required string h3 { get; init; } + public string? id { get; init; } +} + +struct H4 +{ + public required string h4 { get; init; } + public string? id { get; init; } +} + +struct H5 +{ + public required string h5 { get; init; } + public string? id { get; init; } +} + +struct H6 +{ + public required string h6 { get; init; } + public string? id { get; init; } +} + +[GenerateOneOf] +partial class Heading : OneOfBase { } + +abstract class ApiBase +{ + public string? id { get; init; } + public OneOf? deprecated { get; init; } + public string? src { get; init; } + public Dictionary? metadata { get; init; } +} + +class Api1 : ApiBase +{ + public required string api1 { get; init; } +} + +class Api2 : ApiBase +{ + public required string api2 { get; init; } +} + +class Api3 : ApiBase +{ + public required string api3 { get; init; } +} + +class Api4 : ApiBase +{ + public required string api4 { get; init; } +} + + +[GenerateOneOf] +partial class Api : OneOfBase { } + +record struct Fact(string name, Inline value); + +struct Facts +{ + public required Fact[] facts { get; init; } +} + +struct List +{ + public required Inline[] list { get; init; } +} + +struct Inheritance +{ + public required Inline[] inheritance { get; init; } +} + +struct Code +{ + public required string code { get; init; } + public string? languageId { get; init; } +} + +class Parameter +{ + public string? name { get; init; } + public Inline? type { get; init; } + public string? @default { get; init; } + public string? description { get; init; } + public OneOf? deprecated { get; init; } + public bool? optional { get; init; } +} + +struct Parameters +{ + public required Parameter[] parameters { get; init; } +} + +[GenerateOneOf] +partial class Block : OneOfBase { } + +record ApiPage +{ + public static JsonSerializerOptions JsonSerializerOptions { get; } = new() + { + DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull | JsonIgnoreCondition.WhenWritingDefault, + }; + + static ApiPage() + { + JsonSerializerOptions.Converters.Add(new OneOfJsonConverterFactory()); + } + + public required string title { get; init; } + public required Block[] body { get; init; } + + public string? languageId { get; init; } + public Dictionary>? metadata { get; init; } +} + +#endif diff --git a/src/Docfx.Build/ApiPage/ApiPageHtmlTemplate.cs b/src/Docfx.Build/ApiPage/ApiPageHtmlTemplate.cs new file mode 100644 index 00000000000..c58c4f6614c --- /dev/null +++ b/src/Docfx.Build/ApiPage/ApiPageHtmlTemplate.cs @@ -0,0 +1,114 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +#if NET7_0_OR_GREATER + +using System.Net; +using static Docfx.Build.HtmlTemplate; + +#nullable enable + +namespace Docfx.Build.ApiPage; + +static class ApiPageHtmlTemplate +{ + public static HtmlTemplate Render(ApiPage page, Func markup) + { + return Html($"{page.body.Select(Block)}"); + + HtmlTemplate Block(Block block) => block.Value switch + { + Markdown markdown => Markdown(markdown), + Heading heading => Heading(heading), + Api api => Api(api), + Facts facts => Facts(facts), + List list => List(list), + Inheritance inheritance => Inheritance(inheritance), + Code code => Code(code), + Parameters parameters => Parameters(parameters), + }; + + HtmlTemplate Markdown(Markdown markdown) => UnsafeHtml(markup(markdown.markdown)); + + HtmlTemplate Heading(Heading heading) => heading.Value switch + { + H1 h1 => Html($"

{h1.h1}

"), + H2 h2 => Html($"

{h2.h2}

"), + H3 h3 => Html($"

{h3.h3}

"), + H4 h4 => Html($"

{h4.h4}

"), + H5 h5 => Html($"
{h5.h5}
"), + H6 h6 => Html($"
{h6.h6}
"), + }; + + HtmlTemplate Api(Api api) => api.Value switch + { + Api1 api1 => Html($"

{api1.api1}

"), + Api2 api2 => Html($"

{api2.api2}

"), + Api3 api3 => Html($"

{api3.api3}

"), + Api4 api4 => Html($"

{api4.api4}

"), + }; + + HtmlTemplate Attributes(Dictionary? metadata) => metadata is null + ? default + : UnsafeHtml(string.Join(" ", metadata.Select(m => $"data-{WebUtility.HtmlEncode(m.Key)}='{WebUtility.HtmlEncode(m.Value)}'"))); + + HtmlTemplate Facts(Facts facts) => facts.facts.Length is 0 ? default : Html( + $""" +
+ {facts.facts.Select(fact => Html($"
{fact.name}
{Inline(fact.value)}
"))} +
+ """); + + HtmlTemplate List(List list) => list.list.Length is 0 ? default : Html( + $""" +
+ {list.list.Select(item => Html($"
\n{Inline(item)}\n
\n"))} +
+ """); + + HtmlTemplate Inheritance(Inheritance inheritance) => inheritance.inheritance.Length is 0 ? default : Html( + $""" +
+ {inheritance.inheritance.Select(item => Html($"
\n{Inline(item)}\n
\n"))} +
+ """); + + HtmlTemplate Code(Code code) + { + var lang = code.languageId ?? page.languageId; + var c = string.IsNullOrEmpty(lang) ? null : $"lang-{lang}"; + return Html($"
{code.code}
"); + } + + HtmlTemplate Parameters(Parameters parameters) => parameters.parameters.Length is 0 ? default : Html( + $"
{parameters.parameters.Select(Parameter)}
"); + + HtmlTemplate Parameter(Parameter parameter) => Html( + $""" +
+ {(string.IsNullOrEmpty(parameter.name) ? default + : string.IsNullOrEmpty(parameter.@default) + ? Html($"{parameter.name}") + : Html($"{parameter.name} = {parameter.@default}"))} + {Inline(parameter.type)} +
+
{(string.IsNullOrEmpty(parameter.description) ? default : UnsafeHtml(markup(parameter.description)))}
+ """); + + HtmlTemplate Inline(Inline? inline) => inline?.Value switch + { + null => default, + Span span => Span(span), + Span[] spans => Html($"{spans.Select(Span)}"), + }; + + HtmlTemplate Span(Span span) => span.Value switch + { + string str => Html($"{str}"), + LinkSpan link when string.IsNullOrEmpty(link.url) => Html($"{link.text}"), + LinkSpan link => Html($"{link.text}"), + }; + } +} + +#endif diff --git a/src/Docfx.Build/ApiPage/ApiPageMarkdownTemplate.cs b/src/Docfx.Build/ApiPage/ApiPageMarkdownTemplate.cs new file mode 100644 index 00000000000..4cbd2cf2598 --- /dev/null +++ b/src/Docfx.Build/ApiPage/ApiPageMarkdownTemplate.cs @@ -0,0 +1,128 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +#if NET7_0_OR_GREATER + +using System.Text; + +#nullable enable + +namespace Docfx.Build.ApiPage; + +static class ApiPageMarkdownTemplate +{ + public static string Render(ApiPage page) + { + return string.Concat(page.body.Select(Block)); + + FormattableString? Block(Block block) => block.Value switch + { + Markdown markdown => Markdown(markdown), + Heading heading => Heading(heading), + Api api => Api(api), + Facts facts => Facts(facts), + List list => List(list), + Inheritance inheritance => Inheritance(inheritance), + Code code => Code(code), + Parameters parameters => Parameters(parameters), + }; + + FormattableString? Markdown(Markdown markdown) => $"{markdown.markdown}\n\n"; + + FormattableString? Heading(Heading heading) => heading.Value switch + { + H1 h1 => ToHeading(1, h1.h1, h1.id), + H2 h2 => ToHeading(2, h2.h2, h2.id), + H3 h3 => ToHeading(3, h3.h3, h3.id), + H4 h4 => ToHeading(4, h4.h4, h4.id), + H5 h5 => ToHeading(5, h5.h5, h5.id), + H6 h6 => ToHeading(6, h6.h6, h6.id), + }; + + FormattableString? Api(Api api) => api.Value switch + { + Api1 api1 => ToHeading(1, api1.api1, api1.id), + Api2 api2 => ToHeading(2, api2.api2, api2.id), + Api3 api3 => ToHeading(3, api3.api3, api3.id), + Api4 api4 => ToHeading(4, api4.api4, api4.id), + }; + + FormattableString? ToHeading(int level, string title, string? id = null) => + $"{new string('#', level)}{(string.IsNullOrEmpty(id) ? null : $" ")} {Escape(title)}\n\n"; + + FormattableString? Facts(Facts facts) => + $"{string.Concat(facts.facts.Select(fact => $"{Escape(fact.name)}: {Inline(fact.value)} \n"))}\n"; + + FormattableString? List(List list) => + $"{string.Join(", \n", list.list.Select(Inline))}\n\n"; + + FormattableString? Inheritance(Inheritance inheritance) => + $"{string.Join(" \u2190 \n", inheritance.inheritance.Select(Inline))}\n\n"; + + FormattableString? Code(Code code) => + $""" + ```{code.languageId ?? page.languageId} + {code.code} + ``` + + + """; + + FormattableString? Parameters(Parameters parameters) => + $"{string.Concat(parameters.parameters.Select(Parameter))}"; + + FormattableString? Parameter(Parameter parameter) => + $""" + {(string.IsNullOrEmpty(parameter.name) ? default + : string.IsNullOrEmpty(parameter.@default) + ? $"`{parameter.name}`" + : $"`{parameter.name} = {parameter.@default}`")} {Inline(parameter.type)} + + {(string.IsNullOrEmpty(parameter.description) ? null : $"{parameter.description}\n\n")} + """; + + FormattableString? Inline(Inline? inline) => inline?.Value switch + { + null => default, + Span span => Span(span), + Span[] spans => $"{string.Concat(spans.Select(Span))}", + }; + + FormattableString? Span(Span span) => span.Value switch + { + string str => $"{Escape(str)}", + LinkSpan link when string.IsNullOrEmpty(link.url) => $"{Escape(link.text)}", + LinkSpan link => $"[{Escape(link.text)}]({Escape(link.url!)})", + }; + } + + private static string Escape(string text) + { + const string EscapeChars = "\\`*_{}[]()#+-!>~\"'"; + + var needEscape = false; + foreach (var c in text) + { + if (EscapeChars.Contains(c)) + { + needEscape = true; + break; + } + } + + if (!needEscape) + return text; + + var sb = new StringBuilder(); + foreach (var c in text) + { + if (EscapeChars.Contains(c)) + sb.Append('\\'); + sb.Append(c); + } + + return sb.ToString(); + } +} + +#endif diff --git a/src/Docfx.Build/ApiPage/ApiPageProcessor.cs b/src/Docfx.Build/ApiPage/ApiPageProcessor.cs new file mode 100644 index 00000000000..f2c454b28fc --- /dev/null +++ b/src/Docfx.Build/ApiPage/ApiPageProcessor.cs @@ -0,0 +1,73 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +#if NET7_0_OR_GREATER + +using System.Collections.Immutable; +using System.Text.Json; +using Docfx.Common; +using Docfx.Plugins; +using YamlDotNet.Serialization; + +namespace Docfx.Build.ApiPage; + +class ApiPageDocumentProcessor(IMarkdownService markdownService) : IDocumentProcessor +{ + IEnumerable IDocumentProcessor.BuildSteps => Array.Empty(); + void IDocumentProcessor.UpdateHref(FileModel model, IDocumentBuildContext context) { } + + string IDocumentProcessor.Name => nameof(ApiPageDocumentProcessor); + + public ProcessingPriority GetProcessingPriority(FileAndType file) + { + if (file.Type != DocumentType.Article) + { + return ProcessingPriority.NotSupported; + } + + var extension = Path.GetExtension(file.File); + if (".yml".Equals(extension, StringComparison.OrdinalIgnoreCase) || + ".yaml".Equals(extension, StringComparison.OrdinalIgnoreCase)) + { + return YamlMime.ReadMime(file.File) == "YamlMime:ApiPage" ? ProcessingPriority.High : ProcessingPriority.NotSupported; + } + + return ProcessingPriority.NotSupported; + } + + public FileModel Load(FileAndType file, ImmutableDictionary metadata) + { + var deserializer = new DeserializerBuilder().WithAttemptingUnquotedStringTypeDeserialization().Build(); + var yml = EnvironmentContext.FileAbstractLayer.ReadAllText(file.File); + var json = JsonSerializer.Serialize(deserializer.Deserialize(yml)); + var data = JsonSerializer.Deserialize(json, ApiPage.JsonSerializerOptions); + var content = new Dictionary(metadata.OrderBy(item => item.Key)) + { + ["title"] = data.title, + ["content"] = ApiPageHtmlTemplate.Render(data, Markup).ToString(), + ["yamlmime"] = "ApiPage", + ["_disableNextArticle"] = true, + }; + + var localPathFromRoot = PathUtility.MakeRelativePath(EnvironmentContext.BaseDirectory, EnvironmentContext.FileAbstractLayer.GetPhysicalPath(file.File)); + + return new FileModel(file, content) + { + DocumentType = "ApiPage", + LocalPathFromRoot = localPathFromRoot, + }; + + string Markup(string markdown) => markdownService.Markup(markdown, file.File).Html; + } + + public SaveResult Save(FileModel model) + { + return new SaveResult + { + DocumentType = model.DocumentType, + FileWithoutExtension = Path.ChangeExtension(model.File, null), + }; + } +} + +#endif diff --git a/src/Docfx.Build/Docfx.Build.csproj b/src/Docfx.Build/Docfx.Build.csproj index 5db10b78539..0bc80e8884a 100644 --- a/src/Docfx.Build/Docfx.Build.csproj +++ b/src/Docfx.Build/Docfx.Build.csproj @@ -17,6 +17,8 @@ + + diff --git a/src/Docfx.Build/DocumentBuilder.cs b/src/Docfx.Build/DocumentBuilder.cs index 2b39e7ac7cd..82ca4e4827a 100644 --- a/src/Docfx.Build/DocumentBuilder.cs +++ b/src/Docfx.Build/DocumentBuilder.cs @@ -24,7 +24,6 @@ public class DocumentBuilder : IDisposable private readonly CompositionHost _container; private readonly PostProcessorsManager _postProcessorsManager; - private readonly List _assemblyList; public DocumentBuilder(IEnumerable assemblies, ImmutableArray postProcessorNames) { @@ -35,12 +34,6 @@ public DocumentBuilder(IEnumerable assemblies, ImmutableArray assemblyList.Add(typeof(DocumentBuilder).Assembly); _container = CompositionContainer.GetContainer(assemblyList); _container.SatisfyImports(this); - _assemblyList = assemblyList; - } - Logger.LogInfo($"{Processors.Count()} plug-in(s) loaded."); - foreach (var processor in Processors) - { - Logger.LogVerbose($"\t{processor.Name} with build steps ({string.Join(", ", from bs in processor.BuildSteps orderby bs.BuildOrder select bs.Name)})"); } _postProcessorsManager = new PostProcessorsManager(_container, postProcessorNames); } @@ -64,6 +57,16 @@ public void Build(IList parameters, string outputDirect var markdownService = CreateMarkdigMarkdownService(parameters[0]); +#if NET7_0_OR_GREATER + Processors = Processors.Append(new ApiPage.ApiPageDocumentProcessor(markdownService)); +#endif + + Logger.LogInfo($"{Processors.Count()} plug-in(s) loaded."); + foreach (var processor in Processors) + { + Logger.LogVerbose($"\t{processor.Name} with build steps ({string.Join(", ", from bs in processor.BuildSteps orderby bs.BuildOrder select bs.Name)})"); + } + // Load schema driven processor from template LoadSchemaDrivenDocumentProcessors(parameters[0]); diff --git a/src/Docfx.Build/HtmlTemplate.cs b/src/Docfx.Build/HtmlTemplate.cs new file mode 100644 index 00000000000..19bf3fc051a --- /dev/null +++ b/src/Docfx.Build/HtmlTemplate.cs @@ -0,0 +1,50 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +#nullable enable + +using System.Net; +using System.Text.RegularExpressions; + +namespace Docfx.Build; + +struct HtmlTemplate +{ + private string? _html; + + public override string ToString() => _html ?? ""; + + public static HtmlTemplate UnsafeHtml(string? html) => new() { _html = html }; + + public static HtmlTemplate Html(FormattableString template) + { + var format = Regex.Replace(template.Format, "(\\s+[a-zA-Z0-9_-]+)=([\"']){(\\d)}[\"']", RenderAttribute); + var html = string.Format(format, Array.ConvertAll(template.GetArguments(), Render)); + return new() { _html = html }; + + string? Render(object? value) + { + return value switch + { + null => null, + HtmlTemplate template => template._html, + IEnumerable items => string.Concat(items.Select(i => Render(i))), + _ => WebUtility.HtmlEncode(value.ToString()), + }; + } + + string RenderAttribute(Match m) + { + var i = int.Parse(m.Groups[3].ToString()); + var arg = template.GetArgument(i); + + return arg switch + { + null => "", + bool b => b ? m.Groups[1].ToString() : "", + string str => !string.IsNullOrEmpty(str) ? $"{m.Groups[1]}={m.Groups[2]}{WebUtility.HtmlEncode(str)}{m.Groups[2]}" : "", + _ => $"{m.Groups[1]}={m.Groups[2]}{WebUtility.HtmlEncode(arg.ToString())}{m.Groups[2]}", + }; + } + } +} diff --git a/src/Docfx.Build/OneOfJsonConverterFactory.cs b/src/Docfx.Build/OneOfJsonConverterFactory.cs new file mode 100644 index 00000000000..fea549916e7 --- /dev/null +++ b/src/Docfx.Build/OneOfJsonConverterFactory.cs @@ -0,0 +1,80 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.Reflection; +using System.Text.Json.Serialization; +using System.Text.Json; +using OneOf; + +#nullable enable + +namespace Docfx.Build; + +public class OneOfJsonConverterFactory : JsonConverterFactory +{ + public override bool CanConvert(Type typeToConvert) + { + return typeToConvert.IsAssignableTo(typeof(IOneOf)); + } + + public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializerOptions options) + { + return (JsonConverter)Activator.CreateInstance(typeof(OneOfJsonConverter<>).MakeGenericType(typeToConvert))!; + } + + private class OneOfJsonConverter : JsonConverter where T : IOneOf + { + private static readonly (Type type, MethodInfo cast)[] s_types = GetOneOfTypes(); + + public override T? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + if (reader.TokenType is JsonTokenType.Null) + return default; + + // NOTE: + // This is a pretty slow implementation by attempting to deserialize into every possible union case. + // It also depends on marking discriminator properties as required. + foreach (var (type, cast) in s_types) + { + try + { + Utf8JsonReader readerCopy = reader; + var result = JsonSerializer.Deserialize(ref readerCopy, type, options); + reader.Skip(); + return (T)cast.Invoke(null, new[] { result })!; + } + catch (JsonException) + { + continue; + } + } + + throw new JsonException($"Cannot deserialize into one of the supported types for {typeToConvert}"); + } + + public override void Write(Utf8JsonWriter writer, T value, JsonSerializerOptions options) + { + object obj = value; + while (obj is IOneOf oneof) + obj = oneof.Value; + + JsonSerializer.Serialize(writer, obj, options); + } + + private static (Type type, MethodInfo cast)[] GetOneOfTypes() + { + var casts = typeof(T).GetRuntimeMethods().Where(m => m.IsSpecialName && m.Name == "op_Implicit").ToArray(); + var type = typeof(T); + while (type != null) + { + if (type.IsGenericType && (type.Name.StartsWith("OneOf`") || type.Name.StartsWith("OneOfBase`"))) + { + return type.GetGenericArguments().Select(t => (t, casts.First(c => c.GetParameters()[0].ParameterType == t))).ToArray(); + } + + type = type.BaseType; + } + throw new InvalidOperationException($"{typeof(T)} isn't OneOf or OneOfBase"); + } + } +} diff --git a/src/Docfx.Dotnet/Docfx.Dotnet.csproj b/src/Docfx.Dotnet/Docfx.Dotnet.csproj index 336c6d01dc6..0068b081047 100644 --- a/src/Docfx.Dotnet/Docfx.Dotnet.csproj +++ b/src/Docfx.Dotnet/Docfx.Dotnet.csproj @@ -3,6 +3,12 @@ + + + + + + @@ -10,6 +16,10 @@ + + + + @@ -21,6 +31,8 @@ + + @@ -35,8 +47,4 @@ - - - - diff --git a/src/Docfx.Dotnet/DotnetApiCatalog.Page.cs b/src/Docfx.Dotnet/DotnetApiCatalog.Page.cs index c94b717218c..345403ae698 100644 --- a/src/Docfx.Dotnet/DotnetApiCatalog.Page.cs +++ b/src/Docfx.Dotnet/DotnetApiCatalog.Page.cs @@ -1,8 +1,11 @@ -// Licensed to the .NET Foundation under one or more agreements. +// Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. +#if NET7_0_OR_GREATER + using System.Collections.Concurrent; using System.Text.RegularExpressions; +using Docfx.Build.ApiPage; using Docfx.Common; using Docfx.DataContracts.ManagedReference; using Docfx.Plugins; @@ -15,7 +18,7 @@ namespace Docfx.Dotnet; partial class DotnetApiCatalog { - private static void CreatePages(Func output, List<(IAssemblySymbol symbol, Compilation compilation)> assemblies, ExtractMetadataConfig config, DotnetApiOptions options) + private static void CreatePages(Action output, List<(IAssemblySymbol symbol, Compilation compilation)> assemblies, ExtractMetadataConfig config, DotnetApiOptions options) { Directory.CreateDirectory(config.OutputFolder); @@ -23,6 +26,7 @@ private static void CreatePages(Func output, List<(I var extensionMethods = assemblies.SelectMany(assembly => assembly.symbol.FindExtensionMethods(filter)).ToArray(); var allAssemblies = new HashSet(assemblies.Select(a => a.symbol), SymbolEqualityComparer.Default); var commentCache = new ConcurrentDictionary(SymbolEqualityComparer.Default); + var symbolUrlKind = config.OutputFormat is MetadataOutputFormat.Markdown ? SymbolUrlKind.Markdown : SymbolUrlKind.Html; var toc = CreateToc(assemblies, config, options); var allSymbols = EnumerateToc(toc).SelectMany(node => node.symbols).ToList(); allSymbols.Sort((a, b) => a.symbol.Name.CompareTo(b.symbol.Name)); @@ -33,7 +37,8 @@ private static void CreatePages(Func output, List<(I void SaveTocNode(string id, List<(ISymbol symbol, Compilation compilation)> symbols) { - var writer = output(config.OutputFolder, id); + var title = ""; + var body = new List(); var symbol = symbols[0].symbol; var compilation = symbols[0].compilation; var comment = Comment(symbol, compilation); @@ -88,7 +93,39 @@ _ when SymbolHelper.IsMember(method) => "Method", throw new NotSupportedException($"Unknown symbol type kind {symbols[0].symbol}"); } - writer.End(); + output(config.OutputFolder, id, new ApiPage + { + title = title, + languageId = "csharp", + body = body.ToArray(), + }); + + void Heading(int level, string title, string? id = null) + { + body.Add(level switch + { + 1 => (Heading)new H1 { h1 = title, id = id }, + 2 => (Heading)new H2 { h2 = title, id = id }, + 3 => (Heading)new H3 { h3 = title, id = id }, + 4 => (Heading)new H4 { h4 = title, id = id }, + 5 => (Heading)new H5 { h5 = title, id = id }, + 6 => (Heading)new H6 { h6 = title, id = id }, + }); + } + + void Api(int level, string title, ISymbol symbol) + { + var uid = VisitorHelper.GetId(symbol); + var id = Regex.Replace(uid, @"\W", "_"); + var commentId = VisitorHelper.GetCommentId(symbol); + body.Add(level switch + { + 1 => (Api)new Api1 { api1 = title, id = id, metadata = new() { ["uid"] = uid, ["commentId"] = commentId } }, + 2 => (Api)new Api2 { api2 = title, id = id, metadata = new() { ["uid"] = uid, ["commentId"] = commentId } }, + 3 => (Api)new Api3 { api3 = title, id = id, metadata = new() { ["uid"] = uid, ["commentId"] = commentId } }, + 4 => (Api)new Api4 { api4 = title, id = id, metadata = new() { ["uid"] = uid, ["commentId"] = commentId } }, + }); + } void Namespace() { @@ -98,7 +135,7 @@ from s in allSymbols where s.symbol.Kind is SymbolKind.NamedType && namespaceSymbols.Contains(s.symbol.ContainingNamespace) select (symbol: (INamedTypeSymbol)s.symbol, s.compilation)).ToList(); - writer.Heading(1, $"Namespace {symbol}"); + Api(1, title = $"Namespace {symbol}", symbol); Summary(comment); Namespaces(); @@ -119,7 +156,7 @@ void Namespaces() if (items.Count is 0) return; - writer.Heading(3, "Namespaces"); + Heading(3, "Namespaces"); SummaryList(items); } @@ -129,16 +166,16 @@ void Types(Func predicate, string headingText) if (items.Count == 0) return; - writer.Heading(3, headingText); + Heading(3, headingText); SummaryList(items); } } void Enum(INamedTypeSymbol type) { - writer.Heading(1, $"Enum {SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp)}"); + Api(1, title = $"Enum {SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp)}", symbol); - writer.Facts(Facts().ToArray()); + body.Add(new Facts { facts = Facts().ToArray() }); Summary(comment); Syntax(symbol); @@ -153,9 +190,9 @@ void Enum(INamedTypeSymbol type) void Delegate(INamedTypeSymbol type) { - writer.Heading(1, $"Delegate {SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp)}"); + Api(1, title = $"Delegate {SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp)}", symbol); - writer.Facts(Facts().ToArray()); + body.Add(new Facts { facts = Facts().ToArray() }); Summary(comment); Syntax(symbol); @@ -181,9 +218,9 @@ void ClassLike(INamedTypeSymbol type) _ => throw new InvalidOperationException(), }; - writer.Heading(1, $"{typeHeader} {SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp)}"); + Api(1, title = $"{typeHeader} {SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp)}", symbol); - writer.Facts(Facts().ToArray()); + body.Add(new Facts { facts = Facts().ToArray() }); Summary(comment); Syntax(symbol); @@ -218,7 +255,7 @@ orderby symbol.Name if (items.Count is 0) return; - writer.Heading(2, "Fields"); + Heading(2, "Fields"); if (config.MemberLayout is MemberLayout.SeparatePages) { @@ -242,7 +279,7 @@ orderby symbol.Name if (items.Count is 0) return; - writer.Heading(2, "Properties"); + Heading(2, "Properties"); if (config.MemberLayout is MemberLayout.SeparatePages) { @@ -266,7 +303,7 @@ orderby symbol.Name if (items.Count is 0) return; - writer.Heading(2, headingText); + Heading(2, headingText); if (config.MemberLayout is MemberLayout.SeparatePages) { SummaryList(items); @@ -309,8 +346,9 @@ void Inheritance() return; items.Reverse(); - writer.Heading(6, "Inheritance"); - List(items, ListDelimiter.LeftArrow); + + Heading(4, "Inheritance"); + body.Add(new Inheritance { inheritance = items.Select(i => ShortLink(i, compilation)).ToArray() }); } void Derived() @@ -323,8 +361,8 @@ from s in allSymbols if (items.Count is 0) return; - writer.Heading(6, "Derived"); - List(items); + Heading(4, "Derived"); + body.Add(new List { list = items.Select(i => ShortLink(i, compilation)).ToArray() }); } void Implements() @@ -333,8 +371,8 @@ void Implements() if (items.Count is 0) return; - writer.Heading(6, "Implements"); - List(items); + Heading(4, "Implements"); + body.Add(new List { list = items.Select(i => ShortLink(i, compilation)).ToArray() }); } void InheritedMembers() @@ -343,15 +381,15 @@ void InheritedMembers() if (items.Count is 0) return; - writer.Heading(6, "Inherited Members"); - List(items); + Heading(4, "Inherited Members"); + body.Add(new List { list = items.Select(i => ShortLink(i, compilation)).ToArray() }); } } void MemberHeader(string headingText) { - writer.Heading(1, $"{headingText} {SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp, overload: true)}"); - writer.Facts(Facts().ToArray()); + Api(1, title = $"{headingText} {SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp, overload: true)}", symbol); + body.Add(new Facts { facts = Facts().ToArray() }); } void ExtensionMethods(INamedTypeSymbol type) @@ -366,24 +404,22 @@ void ExtensionMethods(INamedTypeSymbol type) if (items.Count is 0) return; - writer.Heading(6, "Extension Methods"); - List(items); + Heading(4, "Extension Methods"); + body.Add(new List { list = items.Select(i => ShortLink(i, compilation)).ToArray() }); } void SummaryList(IEnumerable<(T, Compilation)> items) where T : ISymbol { - writer.ParameterList(items.Select(i => + body.Add(new Parameters { - var (symbol, compilation) = i; - var comment = Comment(symbol, compilation); - var type = symbol is INamedTypeSymbol ? ShortLink(symbol, compilation) : NameOnlyLink(symbol, compilation); - return new Parameter { type =type, docs = comment?.Summary }; - }).ToArray()); - } - - void List(IEnumerable items, ListDelimiter delimiter = ListDelimiter.Comma) - { - writer.List(delimiter, items.Select(i => ShortLink(i, compilation)).ToArray()); + parameters = items.Select(i => + { + var (symbol, compilation) = i; + var comment = Comment(symbol, compilation); + var type = symbol is INamedTypeSymbol ? ShortLink(symbol, compilation) : NameOnlyLink(symbol, compilation); + return new Parameter { type = type, description = comment?.Summary }; + }).ToArray() + }); } void Parameters(ISymbol symbol, XmlComment? comment, int headingLevel) @@ -392,13 +428,13 @@ void Parameters(ISymbol symbol, XmlComment? comment, int headingLevel) if (!parameters.Any()) return; - writer.Heading(headingLevel, "Parameters"); - writer.ParameterList(parameters.Select(ToParameter).ToArray()); + Heading(headingLevel, "Parameters"); + body.Add(new Parameters { parameters = parameters.Select(ToParameter).ToArray() }); Parameter ToParameter(IParameterSymbol param) { var docs = comment?.Parameters is { } p && p.TryGetValue(param.Name, out var value) ? value : null; - return new() { name = param.Name, type = FullLink(param.Type, compilation), docs = docs }; + return new() { name = param.Name, type = FullLink(param.Type, compilation), description = docs, optional = param.IsOptional ? true : null }; } } @@ -407,8 +443,14 @@ void Returns(IMethodSymbol symbol, XmlComment? comment, int headingLevel) if (symbol.ReturnType is null || symbol.ReturnType.SpecialType is SpecialType.System_Void) return; - writer.Heading(headingLevel, "Returns"); - writer.ParameterList(new Parameter { type = FullLink(symbol.ReturnType, compilation), docs = comment?.Returns }); + Heading(headingLevel, "Returns"); + body.Add(new Parameters + { + parameters = new[] + { + new Parameter() { type = FullLink(symbol.ReturnType, compilation), description = comment?.Returns } + } + }); } void TypeParameters(ISymbol symbol, XmlComment? comment, int headingLevel) @@ -416,20 +458,19 @@ void TypeParameters(ISymbol symbol, XmlComment? comment, int headingLevel) if (symbol.GetTypeParameters() is { } typeParameters && typeParameters.Length is 0) return; - writer.Heading(headingLevel, "Type Parameters"); - writer.ParameterList(typeParameters.Select(ToParameter).ToArray()); + Heading(headingLevel, "Type Parameters"); + body.Add(new Parameters { parameters = typeParameters.Select(ToParameter).ToArray() }); Parameter ToParameter(ITypeParameterSymbol param) { var docs = comment?.TypeParameters is { } p && p.TryGetValue(param.Name, out var value) ? value : null; - return new() { name = param.Name, docs = docs }; + return new() { name = param.Name, description = docs }; } } void Method(IMethodSymbol symbol, Compilation compilation, int headingLevel) { - var fragment = Regex.Replace(VisitorHelper.GetId(symbol), @"\W", "_"); - writer.Heading(headingLevel, SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp), fragment); + Api(headingLevel, SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp), symbol); var comment = Comment(symbol, compilation); Summary(comment); @@ -447,15 +488,20 @@ void Method(IMethodSymbol symbol, Compilation compilation, int headingLevel) void Field(IFieldSymbol symbol, Compilation compilation, int headingLevel) { - var fragment = Regex.Replace(VisitorHelper.GetId(symbol), @"\W", "_"); - writer.Heading(headingLevel, SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp), fragment); + Api(headingLevel, SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp), symbol); var comment = Comment(symbol, compilation); Summary(comment); Syntax(symbol); - writer.Heading(headingLevel + 1, "Field Value"); - writer.ParameterList(new Parameter { type = FullLink(symbol.Type, compilation) }); + Heading(headingLevel + 1, "Field Value"); + body.Add(new Parameters + { + parameters = new[] + { + new Parameter() { type = FullLink(symbol.Type, compilation) } + } + }); Examples(comment, headingLevel + 1); Remarks(comment, headingLevel + 1); @@ -465,15 +511,20 @@ void Field(IFieldSymbol symbol, Compilation compilation, int headingLevel) void Property(IPropertySymbol symbol, Compilation compilation, int headingLevel) { - var fragment = Regex.Replace(VisitorHelper.GetId(symbol), @"\W", "_"); - writer.Heading(headingLevel, SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp), fragment); + Api(headingLevel, SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp), symbol); var comment = Comment(symbol, compilation); Summary(comment); Syntax(symbol); - writer.Heading(headingLevel + 1, "Property Value"); - writer.ParameterList(new Parameter { type = FullLink(symbol.Type, compilation) }); + Heading(headingLevel + 1, "Property Value"); + body.Add(new Parameters + { + parameters = new[] + { + new Parameter() { type = FullLink(symbol.Type, compilation) } + } + }); Examples(comment, headingLevel + 1); Remarks(comment, headingLevel + 1); @@ -483,15 +534,20 @@ void Property(IPropertySymbol symbol, Compilation compilation, int headingLevel) void Event(IEventSymbol symbol, Compilation compilation, int headingLevel) { - var fragment = Regex.Replace(VisitorHelper.GetId(symbol), @"\W", "_"); - writer.Heading(headingLevel, SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp), fragment); + Api(headingLevel, SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp), symbol); var comment = Comment(symbol, compilation); Summary(comment); Syntax(symbol); - writer.Heading(headingLevel + 1, "Event Type"); - writer.ParameterList(new Parameter { type = FullLink(symbol.Type, compilation) }); + Heading(headingLevel + 1, "Event Type"); + body.Add(new Parameters + { + parameters = new[] + { + new Parameter() { type = FullLink(symbol.Type, compilation) } + } + }); Examples(comment, headingLevel + 1); Remarks(comment, headingLevel + 1); @@ -508,13 +564,13 @@ void EnumFields(INamedTypeSymbol type) if (config.EnumSortOrder is EnumSortOrder.Alphabetic) items = items.OrderBy(m => m.Name).ToList(); - writer.Heading(2, "Fields"); - writer.ParameterList(items.Select(ToParameter).ToArray()); + body.Add((Heading)new H2 { h2 = "Fields" }); + body.Add(new Parameters { parameters = items.Select(ToParameter).ToArray() }); Parameter ToParameter(IFieldSymbol item) { var docs = Comment(item, compilation) is { } comment ? comment.Summary : null; - return new() { name = item.Name, defaultValue = $"{item.ConstantValue}", docs = docs }; + return new() { name = item.Name, @default = $"{item.ConstantValue}", description = docs }; } } @@ -524,29 +580,29 @@ IEnumerable Facts() var assemblies = symbols.Select(s => s.symbol.ContainingAssembly.Name).Where(n => n != "?").Distinct().Select(n => $"{n}.dll").ToList(); if (assemblies.Count > 0) - yield return new("Assembly", new[] { new TextSpan(string.Join(", ", assemblies)) }); + yield return new("Assembly", (Span)string.Join(", ", assemblies)); } void Summary(XmlComment? comment) { if (!string.IsNullOrEmpty(comment?.Summary)) - writer.Markdown(comment.Summary); + body.Add(new Markdown { markdown = comment.Summary }); } void Syntax(ISymbol symbol) { var syntax = SymbolFormatter.GetSyntax(symbol, SyntaxLanguage.CSharp, filter); - writer.Declaration(syntax, "csharp"); + body.Add(new Code { code = syntax }); } void Examples(XmlComment? comment, int headingLevel = 2) { if (comment?.Examples?.Count > 0) { - writer.Heading(headingLevel, "Examples"); + Heading(headingLevel, "Examples"); foreach (var example in comment.Examples) - writer.Markdown(example); + body.Add(new Markdown { markdown = example }); } } @@ -554,8 +610,8 @@ void Remarks(XmlComment? comment, int headingLevel = 2) { if (!string.IsNullOrEmpty(comment?.Remarks)) { - writer.Heading(headingLevel, "Remarks"); - writer.Markdown(comment.Remarks); + Heading(headingLevel, "Remarks"); + body.Add(new Markdown { markdown = comment.Remarks }); } } @@ -563,9 +619,15 @@ void Exceptions(XmlComment? comment, int headingLevel = 2) { if (comment?.Exceptions?.Count > 0) { - writer.Heading(headingLevel, "Exceptions"); - writer.ParameterList(comment.Exceptions.Select( - e => new Parameter() { type = Cref(e.CommentId), docs = e.Description }).ToArray()); + Heading(headingLevel, "Exceptions"); + body.Add(new Parameters + { + parameters = comment.Exceptions.Select(e => new Parameter() + { + type = Cref(e.CommentId), + description = e.Description, + }).ToArray() + }); } } @@ -573,42 +635,50 @@ void SeeAlsos(XmlComment? comment, int headingLevel = 2) { if (comment?.SeeAlsos?.Count > 0) { - writer.Heading(headingLevel, "See Also"); - writer.List(ListDelimiter.NewLine, comment.SeeAlsos.Select(s => s.LinkType switch + Heading(headingLevel, "See Also"); + body.Add(new List { - LinkType.CRef => Cref(s.CommentId), - LinkType.HRef => new[] { new TextSpan(s.LinkId, (string?)s.LinkId) }, - _ => throw new NotSupportedException($"{s.LinkType}"), - }).ToArray()); + list = comment.SeeAlsos.Select(s => s.LinkType switch + { + LinkType.CRef => Cref(s.CommentId), + LinkType.HRef => Link(s.LinkId, s.LinkId), + _ => throw new NotSupportedException($"{s.LinkType}"), + }).ToArray() + }); } } - TextSpan[] Cref(string commentId) + Inline Cref(string commentId) { - return DocumentationCommentId.GetFirstSymbolForDeclarationId(commentId, compilation) is { } symbol ? FullLink(symbol, compilation) : Array.Empty(); + return DocumentationCommentId.GetFirstSymbolForDeclarationId(commentId, compilation) is { } symbol ? FullLink(symbol, compilation) : Array.Empty(); } } - TextSpan[] ShortLink(ISymbol symbol, Compilation compilation) + Inline ShortLink(ISymbol symbol, Compilation compilation) { var title = SymbolFormatter.GetNameWithType(symbol, SyntaxLanguage.CSharp); - var url = SymbolUrlResolver.GetSymbolUrl(symbol, compilation, config.MemberLayout, SymbolUrlKind.Markdown, allAssemblies); - return new[] { new TextSpan(title, url) }; + var url = SymbolUrlResolver.GetSymbolUrl(symbol, compilation, config.MemberLayout, symbolUrlKind, allAssemblies); + return Link(title, url); } - TextSpan[] FullLink(ISymbol symbol, Compilation compilation) + Inline FullLink(ISymbol symbol, Compilation compilation) { var parts = SymbolFormatter.GetNameWithTypeParts(symbol, SyntaxLanguage.CSharp); - var linkItems = SymbolFormatter.ToLinkItems(parts, compilation, config.MemberLayout, allAssemblies, overload: false, SymbolUrlKind.Markdown); + var linkItems = SymbolFormatter.ToLinkItems(parts, compilation, config.MemberLayout, allAssemblies, overload: false, symbolUrlKind); - return linkItems.Select(i => new TextSpan(i.DisplayName, (string?)i.Href)).ToArray(); + return linkItems.Select(i => Link(i.DisplayName, i.Href)).ToArray(); } - TextSpan[] NameOnlyLink(ISymbol symbol, Compilation compilation) + Inline NameOnlyLink(ISymbol symbol, Compilation compilation) { var title = SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp); - var url = SymbolUrlResolver.GetSymbolUrl(symbol, compilation, config.MemberLayout, SymbolUrlKind.Markdown, allAssemblies); - return new[] { new TextSpan(title, url) }; + var url = SymbolUrlResolver.GetSymbolUrl(symbol, compilation, config.MemberLayout, symbolUrlKind, allAssemblies); + return Link(title, url); + } + + Span Link(string text, string? url) + { + return string.IsNullOrEmpty(url) ? text : new LinkSpan { text = text, url = url }; } XmlComment? Comment(ISymbol symbol, Compilation compilation) @@ -648,3 +718,5 @@ TextSpan[] NameOnlyLink(ISymbol symbol, Compilation compilation) } } } + +#endif diff --git a/src/Docfx.Dotnet/DotnetApiCatalog.Toc.cs b/src/Docfx.Dotnet/DotnetApiCatalog.Toc.cs index 30114dde945..5e62b2aff3b 100644 --- a/src/Docfx.Dotnet/DotnetApiCatalog.Toc.cs +++ b/src/Docfx.Dotnet/DotnetApiCatalog.Toc.cs @@ -48,6 +48,7 @@ private static List CreateToc(List<(IAssemblySymbol symbol, Compilation var filter = new SymbolFilter(config, options); var tocNodes = new Dictionary(); + var ext = config.OutputFormat is MetadataOutputFormat.Markdown ? ".md" : ".yml"; var toc = assemblies.SelectMany(a => CreateToc(a.symbol.GlobalNamespace, a.compilation)).ToList(); SortToc(toc, root: true); @@ -98,7 +99,7 @@ IEnumerable CreateNamespaceToc(INamespaceSymbol ns) { id = id, name = config.NamespaceLayout is NamespaceLayout.Nested ? symbol.Name : symbol.ToString() ?? "", - href = $"{id}.md", + href = $"{id}{ext}", type = TocNodeType.Namespace, }); } @@ -138,7 +139,7 @@ IEnumerable CreateNamedTypeToc(INamedTypeSymbol type) { id = id, name = SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp), - href = $"{id}.md", + href = $"{id}{ext}", containsLeafNodes = true, type = type.TypeKind switch { @@ -196,7 +197,7 @@ IMethodSymbol method when SymbolHelper.IsOperator(method) => TocNodeType.Operato { id = id, name = SymbolFormatter.GetName(symbol, SyntaxLanguage.CSharp, overload: true), - href = $"{id}.md", + href = $"{id}{ext}", containsLeafNodes = true, type = type, }); diff --git a/src/Docfx.Dotnet/DotnetApiCatalog.cs b/src/Docfx.Dotnet/DotnetApiCatalog.cs index 3d62a9ed24c..85e6cbe04d8 100644 --- a/src/Docfx.Dotnet/DotnetApiCatalog.cs +++ b/src/Docfx.Dotnet/DotnetApiCatalog.cs @@ -1,11 +1,13 @@ // Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. +using System.Text.Json; using Docfx.Common; using Docfx.Exceptions; using Docfx.Plugins; using Microsoft.Build.Locator; using Newtonsoft.Json.Linq; +using YamlDotNet.Serialization; namespace Docfx.Dotnet; @@ -85,8 +87,34 @@ async Task Build(ExtractMetadataConfig config, DotnetApiOptions options) switch (config.OutputFormat) { case MetadataOutputFormat.Markdown: +#if NET7_0_OR_GREATER Logger.LogWarning($"Markdown output format is experimental."); - CreatePages(MarkdownWriter.Create, assemblies, config, options); + CreatePages(WriteMarkdown, assemblies, config, options); + + void WriteMarkdown(string outputFolder, string id, Build.ApiPage.ApiPage apiPage) + { + File.WriteAllText(Path.Combine(outputFolder, $"{id}.md"), Docfx.Build.ApiPage.ApiPageMarkdownTemplate.Render(apiPage)); + } +#else + Logger.LogError($"Markdown output format is only supported for docfx built against .NET 7 or greater."); +#endif + break; + + case MetadataOutputFormat.ApiPage: +#if NET7_0_OR_GREATER + Logger.LogWarning($"ApiPage output format is experimental."); + var serializer = new DeserializerBuilder().WithAttemptingUnquotedStringTypeDeserialization().Build(); + CreatePages(WriteYaml, assemblies, config, options); + + void WriteYaml(string outputFolder, string id, Build.ApiPage.ApiPage apiPage) + { + var json = JsonSerializer.Serialize(apiPage, Docfx.Build.ApiPage.ApiPage.JsonSerializerOptions); + var obj = serializer.Deserialize(json); + YamlUtility.Serialize(Path.Combine(outputFolder, $"{id}.yml"), obj, "YamlMime:ApiPage"); + } +#else + Logger.LogError($"ApiPage output format is only supported for docfx built against .NET 7 or greater."); +#endif break; case MetadataOutputFormat.Mref: diff --git a/src/Docfx.Dotnet/MetadataJsonConfig.cs b/src/Docfx.Dotnet/MetadataJsonConfig.cs index dccc7624d7e..4190a666131 100644 --- a/src/Docfx.Dotnet/MetadataJsonConfig.cs +++ b/src/Docfx.Dotnet/MetadataJsonConfig.cs @@ -67,6 +67,11 @@ internal enum MetadataOutputFormat /// Output as common-mark compliant markdown file /// Markdown, + + /// + /// Output as ApiPage YAML files + /// + ApiPage, } /// diff --git a/src/Docfx.Dotnet/PageWriter.cs b/src/Docfx.Dotnet/PageWriter.cs deleted file mode 100644 index 1fcd0b39376..00000000000 --- a/src/Docfx.Dotnet/PageWriter.cs +++ /dev/null @@ -1,162 +0,0 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. - -#nullable enable - -using System.Text; - -namespace Docfx.Dotnet; - -enum ListDelimiter -{ - Comma, - NewLine, - LeftArrow, -} - -readonly record struct TextSpan(string text, string? href = null); -readonly record struct Fact(string name, TextSpan[] value); - -class Parameter -{ - public string? name { get; init; } - public TextSpan[]? type { get; init; } - public string? defaultValue { get; init; } - public string? docs { get; init; } -} - -abstract class PageWriter -{ - public abstract void Heading(int level, string title, string? id = null); - public abstract void Facts(params Fact[] facts); - public abstract void Markdown(string markdown); - public abstract void ParameterList(params Parameter[] parameters); - public abstract void List(ListDelimiter delimiter, params TextSpan[][] items); - public abstract void Declaration(string syntax, string? language = null); - public abstract void End(); -} - -class MarkdownWriter : PageWriter -{ - private string _path = default!; - private readonly StringBuilder _sb = new(); - - public static MarkdownWriter Create(string outuputFolder, string id) - { - return new() { _path = Path.Combine(outuputFolder, $"{id}.md") }; - } - - public override void End() - { - File.WriteAllText(_path, _sb.ToString()); - } - - public override void Declaration(string syntax, string? language = null) - { - _sb.AppendLine($"```{language}").AppendLine(syntax).AppendLine("```").AppendLine(); - } - - public override void Heading(int level, string title, string? id = null) - { - _sb.Append($"{new string('#', level)} "); - if (!string.IsNullOrEmpty(id)) - _sb.Append($""); - _sb.AppendLine(Escape(title)).AppendLine(); - } - - public override void Facts(params Fact[] facts) - { - for (var i = 0; i < facts.Length; i++) - { - var item = facts[i]; - _sb.Append(Escape(item.name)).Append(": "); - Text(item.value); - _sb.AppendLine(i == facts.Length - 1 ? "" : " "); - } - _sb.AppendLine(); - } - - public override void List(ListDelimiter delimiter, params TextSpan[][] items) - { - for (var i = 0; i < items.Length - 1; i++) - { - Text(items[i]); - _sb.AppendLine(delimiter switch - { - ListDelimiter.LeftArrow => " \u2190 ", - ListDelimiter.Comma => ", ", - ListDelimiter.NewLine => " ", - _ => throw new NotSupportedException($"Unknown delimiter {delimiter}"), - }); - } - - Text(items[^1]); - _sb.AppendLine().AppendLine(); - } - - public override void Markdown(string markdown) - { - _sb.AppendLine(markdown).AppendLine(); - } - - public override void ParameterList(params Parameter[] parameters) - { - foreach (var param in parameters) - { - if (!string.IsNullOrEmpty(param.name)) - { - _sb.Append('`').Append(Escape(param.name)); - if (!string.IsNullOrEmpty(param.defaultValue)) - _sb.Append(" = ").Append(Escape(param.defaultValue)); - _sb.Append("` "); - } - - if (param.type != null) - Text(param.type); - - _sb.AppendLine().AppendLine(); - - if (!string.IsNullOrEmpty(param.docs)) - _sb.AppendLine(param.docs).AppendLine(); - } - } - - private void Text(params TextSpan[] spans) - { - foreach (var span in spans) - { - if (string.IsNullOrEmpty(span.href)) - _sb.Append(Escape(span.text)); - else - _sb.Append($"[{Escape(span.text)}]({Escape(span.href)})"); - } - } - - private string Escape(string text) - { - const string EscapeChars = "\\`*_{}[]()#+-!>~\"'"; - - var needEscape = false; - foreach (var c in text) - { - if (EscapeChars.Contains(c)) - { - needEscape = true; - break; - } - } - - if (!needEscape) - return text; - - var sb = new StringBuilder(); - foreach (var c in text) - { - if (EscapeChars.Contains(c)) - sb.Append('\\'); - sb.Append(c); - } - - return sb.ToString(); - } -} diff --git a/src/Docfx.Plugins/IDocumentProcessor.cs b/src/Docfx.Plugins/IDocumentProcessor.cs index a007979a198..499de5425c1 100644 --- a/src/Docfx.Plugins/IDocumentProcessor.cs +++ b/src/Docfx.Plugins/IDocumentProcessor.cs @@ -12,7 +12,6 @@ public interface IDocumentProcessor ProcessingPriority GetProcessingPriority(FileAndType file); FileModel Load(FileAndType file, ImmutableDictionary metadata); - // TODO: rename SaveResult Save(FileModel model); void UpdateHref(FileModel model, IDocumentBuildContext context); diff --git a/templates/modern/ApiPage.html.primary.tmpl b/templates/modern/ApiPage.html.primary.tmpl new file mode 100644 index 00000000000..f7852b3199e --- /dev/null +++ b/templates/modern/ApiPage.html.primary.tmpl @@ -0,0 +1,4 @@ +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} +{{!master(layout/_master.tmpl)}} + +{{{content}}} diff --git a/templates/modern/schemas/ApiPage.schema.json b/templates/modern/schemas/ApiPage.schema.json deleted file mode 100644 index 14979b69401..00000000000 --- a/templates/modern/schemas/ApiPage.schema.json +++ /dev/null @@ -1,496 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "definitions": { - "Block": { - "anyOf": [ - { - "description": "Represents a markdown block", - "properties": { - "markdown": { - "description": "Markdown content", - "type": "string", - "contentType": "markdown" - } - }, - "required": [ - "markdown" - ], - "type": "object" - }, - { - "properties": { - "h1": { - "type": "string" - }, - "id": { - "type": "string" - } - }, - "required": [ - "h1" - ], - "type": "object" - }, - { - "properties": { - "h2": { - "type": "string" - }, - "id": { - "type": "string" - } - }, - "required": [ - "h2" - ], - "type": "object" - }, - { - "properties": { - "h3": { - "type": "string" - }, - "id": { - "type": "string" - } - }, - "required": [ - "h3" - ], - "type": "object" - }, - { - "properties": { - "h4": { - "type": "string" - }, - "id": { - "type": "string" - } - }, - "required": [ - "h4" - ], - "type": "object" - }, - { - "properties": { - "h5": { - "type": "string" - }, - "id": { - "type": "string" - } - }, - "required": [ - "h5" - ], - "type": "object" - }, - { - "properties": { - "h6": { - "type": "string" - }, - "id": { - "type": "string" - } - }, - "required": [ - "h6" - ], - "type": "object" - }, - { - "allOf": [ - { - "properties": { - "api1": { - "type": "string" - } - }, - "required": [ - "api1" - ], - "type": "object" - }, - { - "properties": { - "deprecated": { - "description": "Is this API deprecated, or the deprecation reason", - "type": [ - "string", - "boolean" - ] - }, - "id": { - "description": "API URL fragment", - "type": "string" - }, - "metadata": { - "additionalProperties": { - "type": "string" - }, - "description": "Opaque metadata about the API as HTML data-* attributes", - "type": "object" - }, - "src": { - "description": "API source URL", - "type": "string" - } - }, - "type": "object" - } - ] - }, - { - "allOf": [ - { - "properties": { - "api2": { - "type": "string" - } - }, - "required": [ - "api2" - ], - "type": "object" - }, - { - "properties": { - "deprecated": { - "description": "Is this API deprecated, or the deprecation reason", - "type": [ - "string", - "boolean" - ] - }, - "id": { - "description": "API URL fragment", - "type": "string" - }, - "metadata": { - "additionalProperties": { - "type": "string" - }, - "description": "Opaque metadata about the API as HTML data-* attributes", - "type": "object" - }, - "src": { - "description": "API source URL", - "type": "string" - } - }, - "type": "object" - } - ] - }, - { - "allOf": [ - { - "properties": { - "api3": { - "type": "string" - } - }, - "required": [ - "api3" - ], - "type": "object" - }, - { - "properties": { - "deprecated": { - "description": "Is this API deprecated, or the deprecation reason", - "type": [ - "string", - "boolean" - ] - }, - "id": { - "description": "API URL fragment", - "type": "string" - }, - "metadata": { - "additionalProperties": { - "type": "string" - }, - "description": "Opaque metadata about the API as HTML data-* attributes", - "type": "object" - }, - "src": { - "description": "API source URL", - "type": "string" - } - }, - "type": "object" - } - ] - }, - { - "allOf": [ - { - "properties": { - "api4": { - "type": "string" - } - }, - "required": [ - "api4" - ], - "type": "object" - }, - { - "properties": { - "deprecated": { - "description": "Is this API deprecated, or the deprecation reason", - "type": [ - "string", - "boolean" - ] - }, - "id": { - "description": "API URL fragment", - "type": "string" - }, - "metadata": { - "additionalProperties": { - "type": "string" - }, - "description": "Opaque metadata about the API as HTML data-* attributes", - "type": "object" - }, - "src": { - "description": "API source URL", - "type": "string" - } - }, - "type": "object" - } - ] - }, - { - "description": "Represents a sheet of facts", - "properties": { - "facts": { - "items": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "$ref": "#/definitions/Inline" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "facts" - ], - "type": "object" - }, - { - "description": "Represents a list of content", - "properties": { - "list": { - "items": { - "$ref": "#/definitions/Inline" - }, - "type": "array" - } - }, - "required": [ - "list" - ], - "type": "object" - }, - { - "description": "Represents a single inheritance chain from base type to derived type", - "properties": { - "inheritance": { - "items": { - "$ref": "#/definitions/Inline" - }, - "type": "array" - } - }, - "required": [ - "inheritance" - ], - "type": "object" - }, - { - "description": "Represents a code block", - "properties": { - "code": { - "description": "Code text", - "type": "string" - }, - "languageId": { - "description": "Code [langauge identifier](https://code.visualstudio.com/docs/languages/identifiers#_known-language-identifiers)", - "type": "string" - } - }, - "required": [ - "code" - ], - "type": "object" - }, - { - "description": "Represents a set of parameters", - "properties": { - "parameters": { - "items": { - "properties": { - "default": { - "description": "Parameter default value", - "type": "string" - }, - "deprecated": { - "description": "Is this parameter deprecated, or the deprecation reason", - "type": [ - "string", - "boolean" - ] - }, - "description": { - "description": "Parameter description in markdown format", - "type": "string", - "contentType": "markdown" - }, - "name": { - "description": "Parameter name", - "type": "string" - }, - "optional": { - "description": "Is this parameter optional?", - "type": "boolean" - }, - "type": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "properties": { - "text": { - "type": "string" - }, - "url": { - "type": "string" - } - }, - "required": [ - "text" - ], - "type": "object" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "Parameter type" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "parameters" - ], - "type": "object" - } - ], - "description": "Represents block level elements" - }, - "Inline": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "properties": { - "text": { - "type": "string" - }, - "url": { - "type": "string" - } - }, - "required": [ - "text" - ], - "type": "object" - }, - { - "type": "string" - } - ] - }, - "type": "array" - }, - { - "type": "string" - } - ], - "description": "Represents an inline composed of text or links" - } - }, - "description": "Represents a general API page", - "properties": { - "body": { - "description": "Page body", - "items": { - "$ref": "#/definitions/Block" - }, - "type": "array" - }, - "languageId": { - "description": "Default code [language identifier](https://code.visualstudio.com/docs/languages/identifiers#_known-language-identifiers)", - "type": "string" - }, - "metadata": { - "additionalProperties": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "string" - } - ] - }, - "description": "Opaque metadata about the page as HTML tags", - "type": "object" - }, - "title": { - "description": "Page title", - "type": "string" - } - }, - "required": [ - "body", - "title" - ], - "type": "object" -} - diff --git a/templates/modern/src/dotnet.scss b/templates/modern/src/dotnet.scss index ca99159f94f..f1edf83653d 100644 --- a/templates/modern/src/dotnet.scss +++ b/templates/modern/src/dotnet.scss @@ -3,7 +3,7 @@ * The .NET Foundation licenses this file to you under the MIT license. */ -body[data-yaml-mime="ManagedReference"] article { +body[data-yaml-mime="ManagedReference"], body[data-yaml-mime="ApiPage"] article { h1[data-uid] { position: relative; padding-right: 1.6rem; diff --git a/test/Docfx.Build.Tests/HtmlTemplateTest.cs b/test/Docfx.Build.Tests/HtmlTemplateTest.cs new file mode 100644 index 00000000000..83b2709b393 --- /dev/null +++ b/test/Docfx.Build.Tests/HtmlTemplateTest.cs @@ -0,0 +1,33 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using Xunit; + +using static Docfx.Build.HtmlTemplate; + +namespace Docfx.Build.Engine.Tests; + +public class HtmlTemplateTest +{ + [Fact] + public void HtmlTemplate_HtmlTest() + { + Assert.Equal("ab", Html($"a{null}b").ToString()); + Assert.Equal("a1b", Html($"a{1}b").ToString()); + Assert.Equal("a<br/>b", Html($"a{"
"}b").ToString()); + Assert.Equal("a
b", Html($"a{UnsafeHtml("
")}b").ToString()); + Assert.Equal("a

2

b", Html($"a{Html($"

{2}

")}b").ToString()); + Assert.Equal("
  • 0
  • 1
", Html($"
    {new[] { 0, 1 }.Select(i => Html($"
  • {i}
    • "))}
").ToString()); + } + + [Fact] + public void HtmlTemplate_HtmlAttributesTest() + { + Assert.Equal("

", Html($"

").ToString()); + Assert.Equal("

", Html($"

").ToString()); + Assert.Equal("

", Html($"

").ToString()); + Assert.Equal("

", Html($"

").ToString()); + Assert.Equal("

", Html($"

").ToString()); + Assert.Equal("

", Html($"

").ToString()); + } +} diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromAssembly.Class1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromAssembly.Class1.html.view.verified.json new file mode 100644 index 00000000000..5f44f311270 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromAssembly.Class1.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class Class1", + "content": "

Class Class1

\r\n
Namespace
BuildFromAssembly
Assembly
BuildFromAssembly.dll
\r\n

This is a test class.

\n
public class Class1

Inheritance

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

Inherited Members

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

Constructors

Class1()

public Class1()

Methods

HelloWorld()

Hello World.

\n
public static void HelloWorld()
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromAssembly.Class1.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromAssembly.Class1.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/BuildFromAssembly.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromAssembly.html.view.verified.json new file mode 100644 index 00000000000..7a81803969f --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromAssembly.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Namespace BuildFromAssembly", + "content": "

Namespace BuildFromAssembly

Classes

\r\n\r\nClass1\r\n
\r\n

This is a test class.

\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromAssembly.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromAssembly.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/BuildFromCSharpSourceCode.CSharp.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromCSharpSourceCode.CSharp.html.view.verified.json new file mode 100644 index 00000000000..44a5e5e10a4 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromCSharpSourceCode.CSharp.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class CSharp", + "content": "

Class CSharp

\r\n
Namespace
BuildFromCSharpSourceCode
\r\n
public class CSharp

Inheritance

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

Inherited Members

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

Methods

Main(string[])

public static void Main(string[] args)

Parameters

\r\nargs\r\nstring[]\r\n
\r\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromCSharpSourceCode.CSharp.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromCSharpSourceCode.CSharp.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/BuildFromCSharpSourceCode.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromCSharpSourceCode.html.view.verified.json new file mode 100644 index 00000000000..38346bdbcfe --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromCSharpSourceCode.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Namespace BuildFromCSharpSourceCode", + "content": "

Namespace BuildFromCSharpSourceCode

Classes

\r\n\r\nCSharp\r\n
\r\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromCSharpSourceCode.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromCSharpSourceCode.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.Class1.IIssue8948.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Class1.IIssue8948.html.view.verified.json new file mode 100644 index 00000000000..f5b4bd9d8ed --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Class1.IIssue8948.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Interface Class1.IIssue8948", + "content": "

Interface Class1.IIssue8948

\r\n
Namespace
BuildFromProject
Assembly
BuildFromProject.dll
\r\n
public interface Class1.IIssue8948

Methods

DoNothing<T>()

Does nothing with generic type T.

\n
void DoNothing<T>()

Type Parameters

\r\nT\r\n\r\n
\r\n

A generic type.

\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.Class1.IIssue8948.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Class1.IIssue8948.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.Class1.Issue8665.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Class1.Issue8665.html.view.verified.json new file mode 100644 index 00000000000..0e03e5e19de --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Class1.Issue8665.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class Class1.Issue8665", + "content": "

Class Class1.Issue8665

\r\n
Namespace
BuildFromProject
Assembly
BuildFromProject.dll
\r\n
public class Class1.Issue8665

Inheritance

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

Inherited Members

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

Constructors

Issue8665()

public Issue8665()

Issue8665(int)

public Issue8665(int foo)

Parameters

\r\nfoo\r\nint\r\n
\r\n

Issue8665(int, char)

public Issue8665(int foo, char bar)

Parameters

\r\nfoo\r\nint\r\n
\r\n
\r\nbar\r\nchar\r\n
\r\n

Issue8665(int, char, string)

public Issue8665(int foo, char bar, string baz)

Parameters

\r\nfoo\r\nint\r\n
\r\n
\r\nbar\r\nchar\r\n
\r\n
\r\nbaz\r\nstring\r\n
\r\n

Properties

Bar

public char Bar { get; }

Property Value

\r\n\r\nchar\r\n
\r\n

Baz

public string Baz { get; }

Property Value

\r\n\r\nstring\r\n
\r\n

Foo

public int Foo { get; }

Property Value

\r\n\r\nint\r\n
\r\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.Class1.Issue8665.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Class1.Issue8665.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.Class1.Issue8696Attribute.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Class1.Issue8696Attribute.html.view.verified.json new file mode 100644 index 00000000000..5a2fe3fd5a9 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Class1.Issue8696Attribute.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class Class1.Issue8696Attribute", + "content": "

Class Class1.Issue8696Attribute

\r\n
Namespace
BuildFromProject
Assembly
BuildFromProject.dll
\r\n
public class Class1.Issue8696Attribute : Attribute

Inheritance

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

Inherited Members

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

Constructors

Issue8696Attribute(string?, int, int, string[]?, bool, Type?)

[Class1.Issue8696("Changes the name of the server in the server list", 0, 0, null, false, null)]\npublic Issue8696Attribute(string? description = null, int boundsMin = 0, int boundsMax = 0, string[]? validGameModes = null, bool hasMultipleSelections = false, Type? enumType = null)

Parameters

\r\ndescription\r\nstring?\r\n
\r\n
\r\nboundsMin\r\nint\r\n
\r\n
\r\nboundsMax\r\nint\r\n
\r\n
\r\nvalidGameModes\r\nstring[]?\r\n
\r\n
\r\nhasMultipleSelections\r\nbool\r\n
\r\n
\r\nenumType\r\nType?\r\n
\r\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.Class1.Issue8696Attribute.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Class1.Issue8696Attribute.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.Class1.Issue8948.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Class1.Issue8948.html.view.verified.json new file mode 100644 index 00000000000..907f2c6fadf --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Class1.Issue8948.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class Class1.Issue8948", + "content": "

Class Class1.Issue8948

\r\n
Namespace
BuildFromProject
Assembly
BuildFromProject.dll
\r\n
public class Class1.Issue8948 : Class1.IIssue8948

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\n\r\n

Methods

DoNothing<T>()

Does nothing with generic type T.

\n
public void DoNothing<T>()

Type Parameters

\r\nT\r\n\r\n
\r\n

A generic type.

\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.Class1.Issue8948.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Class1.Issue8948.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.Class1.Test-1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Class1.Test-1.html.view.verified.json new file mode 100644 index 00000000000..91ab0cf3c7c --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Class1.Test-1.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class Class1.Test", + "content": "

Class Class1.Test<T>

\r\n
Namespace
BuildFromProject
Assembly
BuildFromProject.dll
\r\n
public class Class1.Test<T>

Type Parameters

\r\nT\r\n\r\n
\r\n

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.Class1.Test-1.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Class1.Test-1.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.Class1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Class1.html.view.verified.json new file mode 100644 index 00000000000..a3307173ccf --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Class1.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class Class1", + "content": "

Class Class1

\r\n
Namespace
BuildFromProject
Assembly
BuildFromProject.dll
\r\n
public class Class1 : IClass1

Inheritance

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

Implements

\r\n
\nIClass1\n
\n\r\n

Inherited Members

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

Methods

Issue1651()

Pricing models are used to calculate theoretical option values

\n
  • 1Black Scholes
  • 2Black76
  • 3Black76Fut
  • 4Equity Tree
  • 5Variance Swap
  • 6Dividend Forecast
\n
public void Issue1651()

Issue1887()

IConfiguration related helper and extension routines.

\n
public void Issue1887()

Issue2623()

public void Issue2623()

Examples

MyClass myClass = new MyClass();\n\nvoid Update()\n{\n    myClass.Execute();\n}\n
\n

Remarks

For example:

\n
MyClass myClass = new MyClass();\n\nvoid Update()\n{\n    myClass.Execute();\n}\n
\n

Issue2723()

public void Issue2723()

Remarks

\n
Note
\n

This is a <note>. & " '

\n
\n

Inline <angle brackets>.

\n

link

\n
for (var i = 0; i > 10; i++) // & " '\nvar range = new Range<int> { Min = 0, Max = 10 };\n
\n
var range = new Range<int> { Min = 0, Max = 10 };
\n

Issue4017()

public void Issue4017()

Examples

public void HookMessageDeleted(BaseSocketClient client)\n{\n    client.MessageDeleted += HandleMessageDelete;\n}\n\npublic Task HandleMessageDelete(Cacheable<IMessage, ulong> cachedMessage, ISocketMessageChannel channel)\n{\n    // check if the message exists in cache; if not, we cannot report what was removed\n    if (!cachedMessage.HasValue) return;\n    var message = cachedMessage.Value;\n    Console.WriteLine($\"A message ({message.Id}) from {message.Author} was removed from the channel {channel.Name} ({channel.Id}):\"\n        + Environment.NewLine\n        + message.Content);\n    return Task.CompletedTask;\n}
\n

Remarks

void Update()\n{\n    myClass.Execute();\n}
\n

Issue4392()

public void Issue4392()

Remarks

@"\\\\?\\"

\n

Issue7484()

public void Issue7484()

Remarks

There's really no reason to not believe that this class can test things.

\n
TermDescription
A TermA Description
Bee TermBee Description
\n

Issue8764<T>()

public void Issue8764<T>() where T : unmanaged

Type Parameters

\r\nT\r\n\r\n
\r\n

Issue896()

Test

\n
public void Issue896()

See Also

\r\n
\nClass1.Test<T>\n
\n
\nClass1\n
\n\r\n

Issue9216()

Calculates the determinant of a 3-dimensional matrix:

\n

\\(A = \\begin{vmatrix} a_{11} & a_{12} & a_{13} \\\\ a_{21} & a_{22} & a_{23} \\\\ a_{31} & a_{32} & a_{33} \\end{vmatrix}\\)

\n

Returns the smallest value:

\n

\\(\\left\\{\\begin{matrix}a, a<b \\\\ b, b>a\\\\ \\end{matrix} \\right.\\)

\n
public static double Issue9216()

Returns

\r\n\r\ndouble\r\n
\r\n

XmlCommentIncludeTag()

This method should do something...

\n
public void XmlCommentIncludeTag()

Remarks

This is remarks.

\n", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.Class1.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Class1.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.IInheritdoc.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.IInheritdoc.html.view.verified.json new file mode 100644 index 00000000000..517eb4ea6b3 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.IInheritdoc.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Interface IInheritdoc", + "content": "

Interface IInheritdoc

\r\n
Namespace
BuildFromProject
Assembly
BuildFromProject.dll
\r\n
public interface IInheritdoc

Methods

Issue7629()

This method should do something...

\n
void Issue7629()
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.IInheritdoc.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.IInheritdoc.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.Issue6366.Class1-1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue6366.Class1-1.html.view.verified.json new file mode 100644 index 00000000000..05be8ed9561 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue6366.Class1-1.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class Inheritdoc.Issue6366.Class1", + "content": "

Class Inheritdoc.Issue6366.Class1<T>

\r\n
Namespace
BuildFromProject
Assembly
BuildFromProject.dll
\r\n
public abstract class Inheritdoc.Issue6366.Class1<T>

Type Parameters

\r\nT\r\n\r\n
\r\n

Inheritance

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

Inherited Members

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

Methods

TestMethod1(T, int)

This text inherited.

\n
public abstract T TestMethod1(T parm1, int parm2)

Parameters

\r\nparm1\r\nT\r\n
\r\n

This text NOT inherited.

\n
\r\nparm2\r\nint\r\n
\r\n

This text inherited.

\n

Returns

\r\n\r\nT\r\n
\r\n

This text inherited.

\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.Inheritdoc.Issue6366.Class1-1.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Inheritdoc.Issue6366.Class1-1.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.Issue6366.Class2.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue6366.Class2.html.view.verified.json new file mode 100644 index 00000000000..f426a5c3c56 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue6366.Class2.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class Inheritdoc.Issue6366.Class2", + "content": "

Class Inheritdoc.Issue6366.Class2

\r\n
Namespace
BuildFromProject
Assembly
BuildFromProject.dll
\r\n
public class Inheritdoc.Issue6366.Class2 : Inheritdoc.Issue6366.Class1<bool>

Inheritance

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

Inherited Members

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

Methods

TestMethod1(bool, int)

This text inherited.

\n
public override bool TestMethod1(bool parm1, int parm2)

Parameters

\r\nparm1\r\nbool\r\n
\r\n

This text NOT inherited.

\n
\r\nparm2\r\nint\r\n
\r\n

This text inherited.

\n

Returns

\r\n\r\nbool\r\n
\r\n

This text inherited.

\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.Inheritdoc.Issue6366.Class2.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Inheritdoc.Issue6366.Class2.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.Issue6366.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue6366.html.view.verified.json new file mode 100644 index 00000000000..cc603e9355e --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue6366.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class Inheritdoc.Issue6366", + "content": "

Class Inheritdoc.Issue6366

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

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.Issue6366.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Inheritdoc.Issue6366.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.Issue7035.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue7035.html.view.verified.json new file mode 100644 index 00000000000..eeff4a17ee3 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue7035.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class Inheritdoc.Issue7035", + "content": "

Class Inheritdoc.Issue7035

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

Inheritance

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

Inherited Members

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

Methods

A()

public void A()

B()

public void B()
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.Inheritdoc.Issue7035.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Inheritdoc.Issue7035.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.Issue7484.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue7484.html.view.verified.json new file mode 100644 index 00000000000..9d6c1456186 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue7484.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class Inheritdoc.Issue7484", + "content": "

Class Inheritdoc.Issue7484

\r\n
Namespace
BuildFromProject
Assembly
BuildFromProject.dll
\r\n

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

\n
public class Inheritdoc.Issue7484

Inheritance

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

Inherited Members

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

Remarks

We're going to talk about things now.

\n
\nSimple method to generate docs for.\n
\nA string that could have something.\n
\n

Constructors

Issue7484()

This is a constructor to document.

\n
public Issue7484()

Properties

DoDad

A string that could have something.

\n
public string DoDad { get; }

Property Value

\r\n\r\nstring\r\n
\r\n

Methods

BoolReturningMethod(bool)

Simple method to generate docs for.

\n
public bool BoolReturningMethod(bool source)

Parameters

\r\nsource\r\nbool\r\n
\r\n

A meaningless boolean value, much like most questions in the world.

\n

Returns

\r\n\r\nbool\r\n
\r\n

An exactly equivalently meaningless boolean value, much like most answers in the world.

\n

Remarks

I'd like to take a moment to thank all of those who helped me get to\na place where I can write documentation like this.

\n", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.Inheritdoc.Issue7484.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Inheritdoc.Issue7484.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.Issue8101.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue8101.html.view.verified.json new file mode 100644 index 00000000000..9e23b20a67a --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue8101.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class Inheritdoc.Issue8101", + "content": "

Class Inheritdoc.Issue8101

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

Inheritance

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

Inherited Members

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

Methods

Tween(float, float, float, Action<float>)

Create a new tween.

\n
public static object Tween(float from, float to, float duration, Action<float> onChange)

Parameters

\r\nfrom\r\nfloat\r\n
\r\n

The starting value.

\n
\r\nto\r\nfloat\r\n
\r\n

The end value.

\n
\r\nduration\r\nfloat\r\n
\r\n

Total tween duration in seconds.

\n
\r\nonChange\r\nAction<float>\r\n
\r\n

A callback that will be invoked every time the tween value changes.

\n

Returns

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

The newly created tween instance.

\n

Tween(int, int, float, Action<int>)

Create a new tween.

\n
public static object Tween(int from, int to, float duration, Action<int> onChange)

Parameters

\r\nfrom\r\nint\r\n
\r\n

The starting value.

\n
\r\nto\r\nint\r\n
\r\n

The end value.

\n
\r\nduration\r\nfloat\r\n
\r\n

Total tween duration in seconds.

\n
\r\nonChange\r\nAction<int>\r\n
\r\n

A callback that will be invoked every time the tween value changes.

\n

Returns

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

The newly created tween instance.

\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.Inheritdoc.Issue8101.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Inheritdoc.Issue8101.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.Issue8129.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue8129.html.view.verified.json new file mode 100644 index 00000000000..941b34ff325 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.Issue8129.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Struct Inheritdoc.Issue8129", + "content": "

Struct Inheritdoc.Issue8129

\r\n
Namespace
BuildFromProject
Assembly
BuildFromProject.dll
\r\n
public struct Inheritdoc.Issue8129

Inherited Members

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

Constructors

Issue8129(string)

public Issue8129(string foo)

Parameters

\r\nfoo\r\nstring\r\n
\r\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.Inheritdoc.Issue8129.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Inheritdoc.Issue8129.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.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.html.view.verified.json new file mode 100644 index 00000000000..09f55022120 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Inheritdoc.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class Inheritdoc", + "content": "

Class Inheritdoc

\r\n
Namespace
BuildFromProject
Assembly
BuildFromProject.dll
\r\n
public class Inheritdoc : IInheritdoc, IDisposable

Inheritance

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

Implements

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

Inherited Members

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

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

\n
public void Dispose()

Issue7628()

This method should do something...

\n
public void Issue7628()

Issue7629()

This method should do something...

\n
public void Issue7629()
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.Inheritdoc.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Inheritdoc.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.Issue8540.A.A.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Issue8540.A.A.html.view.verified.json new file mode 100644 index 00000000000..4120d415145 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Issue8540.A.A.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class A", + "content": "

Class A

\r\n
Namespace
BuildFromProject.Issue8540.A
Assembly
BuildFromProject.dll
\r\n
public class A

Inheritance

\r\n
\nobject\n
\n
\nA\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.Issue8540.A.A.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Issue8540.A.A.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.Issue8540.A.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Issue8540.A.html.view.verified.json new file mode 100644 index 00000000000..e61da6231f3 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Issue8540.A.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Namespace BuildFromProject.Issue8540.A", + "content": "

Namespace BuildFromProject.Issue8540.A

Classes

\r\n\r\nA\r\n
\r\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.Issue8540.A.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Issue8540.A.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.Issue8540.B.B.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Issue8540.B.B.html.view.verified.json new file mode 100644 index 00000000000..7a6866f8370 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Issue8540.B.B.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class B", + "content": "

Class B

\r\n
Namespace
BuildFromProject.Issue8540.B
Assembly
BuildFromProject.dll
\r\n
public class B

Inheritance

\r\n
\nobject\n
\n
\nB\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.Issue8540.B.B.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Issue8540.B.B.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.Issue8540.B.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Issue8540.B.html.view.verified.json new file mode 100644 index 00000000000..02bf3fb134c --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Issue8540.B.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Namespace BuildFromProject.Issue8540.B", + "content": "

Namespace BuildFromProject.Issue8540.B

Classes

\r\n\r\nB\r\n
\r\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.Issue8540.B.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Issue8540.B.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.Issue8540.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Issue8540.html.view.verified.json new file mode 100644 index 00000000000..0e205943650 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.Issue8540.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Namespace BuildFromProject.Issue8540", + "content": "

Namespace BuildFromProject.Issue8540

Namespaces

\r\n\r\nBuildFromProject.Issue8540.A\r\n
\r\n
\r\n\r\nBuildFromProject.Issue8540.B\r\n
\r\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.Issue8540.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.Issue8540.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 new file mode 100644 index 00000000000..1fee8dea6ac --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromProject.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Namespace BuildFromProject", + "content": "

Namespace BuildFromProject

Namespaces

\r\n\r\nBuildFromProject.Issue8540\r\n
\r\n

Classes

\r\n\r\nInheritdoc.Issue6366.Class1<T>\r\n
\r\n
\r\n\r\nClass1\r\n
\r\n
\r\n\r\nInheritdoc.Issue6366.Class2\r\n
\r\n
\r\n\r\nInheritdoc\r\n
\r\n
\r\n\r\nInheritdoc.Issue6366\r\n
\r\n
\r\n\r\nInheritdoc.Issue7035\r\n
\r\n
\r\n\r\nInheritdoc.Issue7484\r\n
\r\n

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

\n
\r\n\r\nInheritdoc.Issue8101\r\n
\r\n
\r\n\r\nClass1.Issue8665\r\n
\r\n
\r\n\r\nClass1.Issue8696Attribute\r\n
\r\n
\r\n\r\nClass1.Issue8948\r\n
\r\n
\r\n\r\nClass1.Test<T>\r\n
\r\n

Structs

\r\n\r\nInheritdoc.Issue8129\r\n
\r\n

Interfaces

\r\n\r\nIInheritdoc\r\n
\r\n
\r\n\r\nClass1.IIssue8948\r\n
\r\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromProject.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromProject.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/BuildFromVBSourceCode.BaseClass1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromVBSourceCode.BaseClass1.html.view.verified.json new file mode 100644 index 00000000000..2345f2f7f91 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromVBSourceCode.BaseClass1.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class BaseClass1", + "content": "

Class BaseClass1

\r\n
Namespace
BuildFromVBSourceCode
\r\n

This is the BaseClass

\n
public abstract class BaseClass1

Inheritance

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

Derived

\r\n
\nClass1\n
\n\r\n

Inherited Members

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

Methods

WithDeclarationKeyword(Class1)

public abstract DateTime WithDeclarationKeyword(Class1 keyword)

Parameters

\r\nkeyword\r\nClass1\r\n
\r\n

Returns

\r\n\r\nDateTime\r\n
\r\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromVBSourceCode.BaseClass1.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromVBSourceCode.BaseClass1.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/BuildFromVBSourceCode.Class1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromVBSourceCode.Class1.html.view.verified.json new file mode 100644 index 00000000000..38f5a7b82c8 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromVBSourceCode.Class1.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class Class1", + "content": "

Class Class1

\r\n
Namespace
BuildFromVBSourceCode
\r\n

This is summary from vb class...

\n
public class Class1 : BaseClass1

Inheritance

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

Inherited Members

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

Fields

ValueClass

This is a Value type

\n
public Class1 ValueClass

Field Value

\r\n\r\nClass1\r\n
\r\n

Properties

Keyword

[Obsolete("This member is obsolete.", true)]\npublic Class1 Keyword { get; }

Property Value

\r\n\r\nClass1\r\n
\r\n

Methods

Value(string)

This is a Function

\n
public int Value(string name)

Parameters

\r\nname\r\nstring\r\n
\r\n

Name as the String\nvalue

\n

Returns

\r\n\r\nint\r\n
\r\n

Returns\nAhooo

\n

WithDeclarationKeyword(Class1)

What is Sub?

\n
public override DateTime WithDeclarationKeyword(Class1 keyword)

Parameters

\r\nkeyword\r\nClass1\r\n
\r\n

Returns

\r\n\r\nDateTime\r\n
\r\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromVBSourceCode.Class1.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromVBSourceCode.Class1.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/BuildFromVBSourceCode.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromVBSourceCode.html.view.verified.json new file mode 100644 index 00000000000..aef6b4c49a0 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/BuildFromVBSourceCode.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Namespace BuildFromVBSourceCode", + "content": "

Namespace BuildFromVBSourceCode

Classes

\r\n\r\nBaseClass1\r\n
\r\n

This is the BaseClass

\n
\r\n\r\nClass1\r\n
\r\n

This is summary from vb class...

\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/BuildFromVBSourceCode.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/BuildFromVBSourceCode.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/CatLibrary.Cat-2.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Cat-2.html.view.verified.json new file mode 100644 index 00000000000..3ab942deea0 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Cat-2.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class Cat", + "content": "

Class Cat<T, K>

\r\n
Namespace
CatLibrary
Assembly
CatLibrary.dll
\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
[Serializable]\npublic class Cat<T, K> : ICat, IAnimal where T : class, new() where K : struct

Type Parameters

\r\nT\r\n\r\n
\r\n

This type should be class and can new instance.

\n
\r\nK\r\n\r\n
\r\n

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

\n

Inheritance

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

Implements

\r\n
\nICat\n
\n\n\r\n

Inherited Members

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

Extension Methods

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

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.

\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

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

\n

Constructors

Cat()

Default constructor.

\n
public Cat()

Cat(T)

Constructor with one generic parameter.

\n
public Cat(T ownType)

Parameters

\r\nownType\r\nT\r\n
\r\n

This parameter type defined by class.

\n

Cat(string, out int, string, bool)

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

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

Parameters

\r\nnickName\r\nstring\r\n
\r\n

it's string type.

\n
\r\nage\r\nint\r\n
\r\n

It's an out and ref parameter.

\n
\r\nrealName\r\nstring\r\n
\r\n

It's an out paramter.

\n
\r\nisHealthy\r\nbool\r\n
\r\n

It's an in parameter.

\n

Fields

isHealthy

Field with attribute.

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

Field Value

\r\n\r\nbool\r\n
\r\n

Properties

Age

Hint cat's age.

\n
protected int Age { get; set; }

Property Value

\r\n\r\nint\r\n
\r\n

Name

EII property.

\n
public string Name { get; }

Property Value

\r\n\r\nstring\r\n
\r\n

this[string]

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; }

Property Value

\r\n\r\nint\r\n
\r\n

Methods

CalculateFood(DateTime)

It's a method with complex return type.

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

Parameters

\r\ndate\r\nDateTime\r\n
\r\n

Date time to now.

\n

Returns

\r\n\r\nDictionary<string, List<int>>\r\n
\r\n

It's a relationship map of different kind food.

\n

Equals(object)

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

\n
public override bool Equals(object obj)

Parameters

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

Can pass any class type.

\n

Returns

\r\n\r\nbool\r\n
\r\n

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

\n

GetTailLength(int*, params object[])

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)

Parameters

\r\ncatName\r\nint*\r\n
\r\n

Thie represent for cat name length.

\n
\r\nparameters\r\nobject[]\r\n
\r\n

Optional parameters.

\n

Returns

\r\n\r\nlong\r\n
\r\n

Return cat tail's length.

\n

Jump(T, K, ref bool)

This method have attribute above it.

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

Parameters

\r\nownType\r\nT\r\n
\r\n

Type come from class define.

\n
\r\nanotherOwnType\r\nK\r\n
\r\n

Type come from class define.

\n
\r\ncheat\r\nbool\r\n
\r\n

Hint whether this cat has cheat mode.

\n

Exceptions

\r\n\r\nArgumentException\r\n
\r\n

This is an argument exception

\n

ownEat

Eat event of this cat

\n
public event EventHandler ownEat

Event Type

\r\n\r\nEventHandler\r\n
\r\n

Operators

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

Addition operator of this class.

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

Parameters

\r\nlsr\r\nCat<T, K>\r\n
\r\n

..

\n
\r\nrsr\r\nint\r\n
\r\n

~~

\n

Returns

\r\n\r\nint\r\n
\r\n

Result with int type.

\n

explicit operator Tom(Cat<T, K>)

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)

Parameters

\r\nsrc\r\nCat<T, K>\r\n
\r\n

Instance of this class.

\n

Returns

\r\n\r\nTom\r\n
\r\n

Advanced class type of cat.

\n

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

Similar with operaotr +, refer to that topic.

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

Parameters

\r\nlsr\r\nCat<T, K>\r\n
\r\n
\r\nrsr\r\nint\r\n
\r\n

Returns

\r\n\r\nint\r\n
\r\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/CatLibrary.Cat-2.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.Cat-2.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/CatLibrary.CatException-1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.CatException-1.html.view.verified.json new file mode 100644 index 00000000000..448eccdd0c7 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.CatException-1.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class CatException", + "content": "

Class CatException<T>

\r\n
Namespace
CatLibrary
Assembly
CatLibrary.dll
\r\n
public class CatException<T> : Exception, ISerializable

Type Parameters

\r\nT\r\n\r\n
\r\n

Inheritance

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

Implements

\r\n\n\r\n

Inherited Members

\r\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\r\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/CatLibrary.CatException-1.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.CatException-1.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/CatLibrary.Complex-2.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Complex-2.html.view.verified.json new file mode 100644 index 00000000000..06d098f6099 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Complex-2.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class Complex", + "content": "

Class Complex<T, J>

\r\n
Namespace
CatLibrary
Assembly
CatLibrary.dll
\r\n
public class Complex<T, J>

Type Parameters

\r\nT\r\n\r\n
\r\n
\r\nJ\r\n\r\n
\r\n

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/CatLibrary.Complex-2.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.Complex-2.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/CatLibrary.Core.ContainersRefType.ColorType.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.ContainersRefType.ColorType.html.view.verified.json new file mode 100644 index 00000000000..c20cc3ba841 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.ContainersRefType.ColorType.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Enum ContainersRefType.ColorType", + "content": "

Enum ContainersRefType.ColorType

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

Enumeration ColorType

\n
public enum ContainersRefType.ColorType

Fields

\r\nRed = 0\r\n\r\n
\r\n

red

\n
\r\nBlue = 1\r\n\r\n
\r\n

blue

\n
\r\nYellow = 2\r\n\r\n
\r\n

yellow

\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/CatLibrary.Core.ContainersRefType.ColorType.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.Core.ContainersRefType.ColorType.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/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html.view.verified.json new file mode 100644 index 00000000000..b6c27626f1c --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class ContainersRefType.ContainersRefTypeChild", + "content": "

Class ContainersRefType.ContainersRefTypeChild

\r\n
Namespace
CatLibrary.Core
Assembly
CatLibrary.Core.dll
\r\n
public class ContainersRefType.ContainersRefTypeChild

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/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.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/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html.view.verified.json new file mode 100644 index 00000000000..9eb18350907 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Interface ContainersRefType.ContainersRefTypeChildInterface", + "content": "

Interface ContainersRefType.ContainersRefTypeChildInterface

\r\n
Namespace
CatLibrary.Core
Assembly
CatLibrary.Core.dll
\r\n
public interface ContainersRefType.ContainersRefTypeChildInterface
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.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/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html.view.verified.json new file mode 100644 index 00000000000..976ed15307d --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Delegate ContainersRefType.ContainersRefTypeDelegate", + "content": "

Delegate ContainersRefType.ContainersRefTypeDelegate

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

Delegate ContainersRefTypeDelegate

\n
public delegate void ContainersRefType.ContainersRefTypeDelegate()
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.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/CatLibrary.Core.ContainersRefType.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.ContainersRefType.html.view.verified.json new file mode 100644 index 00000000000..64f9b3ca31a --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.ContainersRefType.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Struct ContainersRefType", + "content": "

Struct ContainersRefType

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

Struct ContainersRefType

\n
public struct ContainersRefType

Inherited Members

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

Extension Methods

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

Fields

ColorCount

ColorCount

\n
public long ColorCount

Field Value

\r\n\r\nlong\r\n
\r\n

Properties

GetColorCount

GetColorCount

\n
public long GetColorCount { get; }

Property Value

\r\n\r\nlong\r\n
\r\n

Methods

ContainersRefTypeNonRefMethod(params object[])

ContainersRefTypeNonRefMethod

\narray\n
public static int ContainersRefTypeNonRefMethod(params object[] parmsArray)

Parameters

\r\nparmsArray\r\nobject[]\r\n
\r\n

Returns

\r\n\r\nint\r\n
\r\n

ContainersRefTypeEventHandler

public event EventHandler ContainersRefTypeEventHandler

Event Type

\r\n\r\nEventHandler\r\n
\r\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/CatLibrary.Core.ContainersRefType.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.Core.ContainersRefType.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/CatLibrary.Core.ExplicitLayoutClass.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.ExplicitLayoutClass.html.view.verified.json new file mode 100644 index 00000000000..6d8663846ed --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.ExplicitLayoutClass.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class ExplicitLayoutClass", + "content": "

Class ExplicitLayoutClass

\r\n
Namespace
CatLibrary.Core
Assembly
CatLibrary.Core.dll
\r\n
public class ExplicitLayoutClass

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/CatLibrary.Core.ExplicitLayoutClass.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.Core.ExplicitLayoutClass.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/CatLibrary.Core.Issue231.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.Issue231.html.view.verified.json new file mode 100644 index 00000000000..50d83b595ff --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.Issue231.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class Issue231", + "content": "

Class Issue231

\r\n
Namespace
CatLibrary.Core
Assembly
CatLibrary.dll, CatLibrary.Core.dll
\r\n
public static class Issue231

Inheritance

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

Inherited Members

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

Methods

Bar(ContainersRefType)

public static void Bar(this ContainersRefType c)

Parameters

\r\nc\r\nContainersRefType\r\n
\r\n

Foo(ContainersRefType)

public static void Foo(this ContainersRefType c)

Parameters

\r\nc\r\nContainersRefType\r\n
\r\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/CatLibrary.Core.Issue231.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.Core.Issue231.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/CatLibrary.Core.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.html.view.verified.json new file mode 100644 index 00000000000..2d6cd689f4c --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Core.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Namespace CatLibrary.Core", + "content": "

Namespace CatLibrary.Core

Classes

\r\n\r\nContainersRefType.ContainersRefTypeChild\r\n
\r\n
\r\n\r\nExplicitLayoutClass\r\n
\r\n
\r\n\r\nIssue231\r\n
\r\n
\r\n\r\nIssue231\r\n
\r\n

Structs

\r\n\r\nContainersRefType\r\n
\r\n

Struct ContainersRefType

\n

Interfaces

\r\n\r\nContainersRefType.ContainersRefTypeChildInterface\r\n
\r\n

Enums

\r\n\r\nContainersRefType.ColorType\r\n
\r\n

Enumeration ColorType

\n

Delegates

\r\n\r\nContainersRefType.ContainersRefTypeDelegate\r\n
\r\n

Delegate ContainersRefTypeDelegate

\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/CatLibrary.Core.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.Core.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/CatLibrary.FakeDelegate-1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.FakeDelegate-1.html.view.verified.json new file mode 100644 index 00000000000..0eb261c1c6a --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.FakeDelegate-1.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Delegate FakeDelegate", + "content": "

Delegate FakeDelegate<T>

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

Fake delegate

\n
public delegate int FakeDelegate<T>(long num, string name, params object[] scores)

Parameters

\r\nnum\r\nlong\r\n
\r\n

Fake para

\n
\r\nname\r\nstring\r\n
\r\n

Fake para

\n
\r\nscores\r\nobject[]\r\n
\r\n

Optional Parameter.

\n

Returns

\r\n\r\nint\r\n
\r\n

Return a fake number to confuse you.

\n

Type Parameters

\r\nT\r\n\r\n
\r\n

Fake para

\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/CatLibrary.FakeDelegate-1.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.FakeDelegate-1.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/CatLibrary.IAnimal.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.IAnimal.html.view.verified.json new file mode 100644 index 00000000000..fd8b545209b --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.IAnimal.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Interface IAnimal", + "content": "

Interface IAnimal

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

This is basic interface of all animal.

\n
public interface IAnimal

Properties

Name

Name of Animal.

\n
string Name { get; }

Property Value

\r\n\r\nstring\r\n
\r\n

this[int]

Return specific number animal's name.

\n
string this[int index] { get; }

Property Value

\r\n\r\nstring\r\n
\r\n

Methods

Eat()

Animal's eat method.

\n
void Eat()

Eat<Tool>(Tool)

Overload method of eat. This define the animal eat by which tool.

\n
void Eat<Tool>(Tool tool) where Tool : class

Parameters

\r\ntool\r\nTool\r\n
\r\n

Tool name.

\n

Type Parameters

\r\nTool\r\n\r\n
\r\n

It's a class type.

\n

Eat(string)

Feed the animal with some food

\n
void Eat(string food)

Parameters

\r\nfood\r\nstring\r\n
\r\n

Food to eat

\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/CatLibrary.IAnimal.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.IAnimal.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/CatLibrary.ICat.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.ICat.html.view.verified.json new file mode 100644 index 00000000000..64be093060d --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.ICat.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Interface ICat", + "content": "

Interface ICat

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

Cat's interface

\n
public interface ICat : IAnimal

Implements

\r\n\n\r\n

Extension Methods

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

eat

eat event of cat. Every cat must implement this event.

\n
event EventHandler eat

Event Type

\r\n\r\nEventHandler\r\n
\r\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/CatLibrary.ICat.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.ICat.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/CatLibrary.ICatExtension.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.ICatExtension.html.view.verified.json new file mode 100644 index 00000000000..1a1856f2eac --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.ICatExtension.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class ICatExtension", + "content": "

Class ICatExtension

\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)

Extension method to let cat play

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

Parameters

\r\nicat\r\nICat\r\n
\r\n

Cat

\n
\r\ntoy\r\nContainersRefType.ColorType\r\n
\r\n

Something to play

\n

Sleep(ICat, long)

Extension method hint that how long the cat can sleep.

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

Parameters

\r\nicat\r\nICat\r\n
\r\n

The type will be extended.

\n
\r\nhours\r\nlong\r\n
\r\n

The length of sleep.

\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/CatLibrary.ICatExtension.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.ICatExtension.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/CatLibrary.MRefDelegate-3.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.MRefDelegate-3.html.view.verified.json new file mode 100644 index 00000000000..ed6a12479b3 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.MRefDelegate-3.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Delegate MRefDelegate", + "content": "

Delegate MRefDelegate<K, T, L>

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

Generic delegate with many constrains.

\n
public delegate void MRefDelegate<K, T, L>(K k, T t, L l) where K : class, IComparable where T : struct where L : Tom, IEnumerable<long>

Parameters

\r\nk\r\nK\r\n
\r\n

Type K.

\n
\r\nt\r\nT\r\n
\r\n

Type T.

\n
\r\nl\r\nL\r\n
\r\n

Type L.

\n

Type Parameters

\r\nK\r\n\r\n
\r\n

Generic K.

\n
\r\nT\r\n\r\n
\r\n

Generic T.

\n
\r\nL\r\n\r\n
\r\n

Generic L.

\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/CatLibrary.MRefDelegate-3.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.MRefDelegate-3.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/CatLibrary.MRefNormalDelegate.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.MRefNormalDelegate.html.view.verified.json new file mode 100644 index 00000000000..f359c8c380c --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.MRefNormalDelegate.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Delegate MRefNormalDelegate", + "content": "

Delegate MRefNormalDelegate

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

Delegate in the namespace

\n
public delegate void MRefNormalDelegate(List<string> pics, out string name)

Parameters

\r\npics\r\nList<string>\r\n
\r\n

a name list of pictures.

\n
\r\nname\r\nstring\r\n
\r\n

give out the needed name.

\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/CatLibrary.MRefNormalDelegate.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.MRefNormalDelegate.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/CatLibrary.Tom.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Tom.html.view.verified.json new file mode 100644 index 00000000000..593a2a0af28 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.Tom.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class Tom", + "content": "

Class Tom

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

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

\n
public class Tom

Inheritance

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

Derived

\r\n\n\r\n

Inherited Members

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

Methods

TomMethod(Complex<TomFromBaseClass, TomFromBaseClass>, Tuple<string, Tom>)

This is a Tom Method with complex type as return

\n
public Complex<string, TomFromBaseClass> TomMethod(Complex<TomFromBaseClass, TomFromBaseClass> a, Tuple<string, Tom> b)

Parameters

\r\na\r\nComplex<TomFromBaseClass, TomFromBaseClass>\r\n
\r\n

A complex input

\n
\r\nb\r\nTuple<string, Tom>\r\n
\r\n

Another complex input

\n

Returns

\r\n\r\nComplex<string, TomFromBaseClass>\r\n
\r\n

Complex

\n

Exceptions

\r\n\r\nNotImplementedException\r\n
\r\n

This is not implemented

\n
\r\n\r\nArgumentException\r\n
\r\n

This is the exception to be thrown when implemented

\n
\r\n\r\nCatException<T>\r\n
\r\n

This is the exception in current documentation

\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/CatLibrary.Tom.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.Tom.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/CatLibrary.TomFromBaseClass.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.TomFromBaseClass.html.view.verified.json new file mode 100644 index 00000000000..3ef1f5f128c --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.TomFromBaseClass.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Class TomFromBaseClass", + "content": "

Class TomFromBaseClass

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

TomFromBaseClass inherits from @

\n
public class TomFromBaseClass : Tom

Inheritance

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

Inherited Members

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

Constructors

TomFromBaseClass(int)

This is a #ctor with parameter

\n
public TomFromBaseClass(int k)

Parameters

\r\nk\r\nint\r\n
\r\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/CatLibrary.TomFromBaseClass.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.TomFromBaseClass.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/CatLibrary.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.html.view.verified.json new file mode 100644 index 00000000000..4a1cd31d8f7 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/CatLibrary.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Namespace CatLibrary", + "content": "

Namespace CatLibrary

Namespaces

\r\n\r\nCatLibrary.Core\r\n
\r\n

Classes

\r\n\r\nCat<T, K>\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\r\nCatException<T>\r\n
\r\n
\r\n\r\nComplex<T, J>\r\n
\r\n
\r\n\r\nICatExtension\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\r\nTom\r\n
\r\n

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

\n
\r\n\r\nTomFromBaseClass\r\n
\r\n

TomFromBaseClass inherits from @

\n

Interfaces

\r\n\r\nIAnimal\r\n
\r\n

This is basic interface of all animal.

\n
\r\n\r\nICat\r\n
\r\n

Cat's interface

\n

Delegates

\r\n\r\nFakeDelegate<T>\r\n
\r\n

Fake delegate

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

Generic delegate with many constrains.

\n
\r\n\r\nMRefNormalDelegate\r\n
\r\n

Delegate in the namespace

\n
", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/CatLibrary.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/CatLibrary.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/MRef.Demo.Enumeration.ColorType.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/MRef.Demo.Enumeration.ColorType.html.view.verified.json new file mode 100644 index 00000000000..6ec80e33a14 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/MRef.Demo.Enumeration.ColorType.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Enum ColorType", + "content": "

Enum ColorType

\r\n
Namespace
MRef.Demo.Enumeration
Assembly
CatLibrary.dll
\r\n

Enumeration ColorType

\n
public enum ColorType

Fields

\r\nRed = 0\r\n\r\n
\r\n

this color is red

\n
\r\nBlue = 1\r\n\r\n
\r\n

blue like river

\n
\r\nYellow = 2\r\n\r\n
\r\n

yellow comes from desert

\n

Remarks

\nRed/Blue/Yellow can become all color you want.\n

\n
    \n

    See Also

    \r\n
    \nobject\n
    \n\r\n
    ", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/MRef.Demo.Enumeration.ColorType.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/MRef.Demo.Enumeration.ColorType.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/MRef.Demo.Enumeration.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/MRef.Demo.Enumeration.html.view.verified.json new file mode 100644 index 00000000000..96eb3c88ffa --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/MRef.Demo.Enumeration.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Namespace MRef.Demo.Enumeration", + "content": "

    Namespace MRef.Demo.Enumeration

    Enums

    \r\n\r\nColorType\r\n
    \r\n

    Enumeration ColorType

    \n
    ", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/MRef.Demo.Enumeration.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/MRef.Demo.Enumeration.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/MRef.Demo.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/MRef.Demo.html.view.verified.json new file mode 100644 index 00000000000..e4761d4a78e --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/MRef.Demo.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Namespace MRef.Demo", + "content": "

    Namespace MRef.Demo

    Namespaces

    \r\n\r\nMRef.Demo.Enumeration\r\n
    \r\n
    ", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/MRef.Demo.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/MRef.Demo.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/MRef.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/MRef.html.view.verified.json new file mode 100644 index 00000000000..a5bc6fc1956 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/MRef.html.view.verified.json @@ -0,0 +1,18 @@ +{ + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "title": "Namespace MRef", + "content": "

    Namespace MRef

    Namespaces

    \r\n\r\nMRef.Demo\r\n
    \r\n
    ", + "yamlmime": "ApiPage", + "_disableNextArticle": true, + "_key": "obj/apipage/MRef.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/MRef.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/toc.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.html.view.verified.json new file mode 100644 index 00000000000..0cecdbb7eb4 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.html.view.verified.json @@ -0,0 +1,627 @@ +{ + "items": [ + { + "name": "BuildFromAssembly", + "href": "BuildFromAssembly.html", + "topicHref": "BuildFromAssembly.html", + "items": [ + { + "name": "Classes", + "topicHref": null, + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Class1", + "href": "BuildFromAssembly.Class1.html", + "topicHref": "BuildFromAssembly.Class1.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + } + ], + "tocHref": null, + "level": 2.0 + }, + { + "name": "BuildFromCSharpSourceCode", + "href": "BuildFromCSharpSourceCode.html", + "topicHref": "BuildFromCSharpSourceCode.html", + "items": [ + { + "name": "Classes", + "topicHref": null, + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "CSharp", + "href": "BuildFromCSharpSourceCode.CSharp.html", + "topicHref": "BuildFromCSharpSourceCode.CSharp.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + } + ], + "tocHref": null, + "level": 2.0 + }, + { + "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", + "topicHref": null, + "tocHref": null, + "level": 5.0, + "items": [], + "leaf": true + }, + { + "name": "A", + "href": "BuildFromProject.Issue8540.A.A.html", + "topicHref": "BuildFromProject.Issue8540.A.A.html", + "tocHref": null, + "level": 5.0, + "items": [], + "leaf": true + } + ], + "tocHref": null, + "level": 4.0 + }, + { + "name": "B", + "href": "BuildFromProject.Issue8540.B.html", + "topicHref": "BuildFromProject.Issue8540.B.html", + "items": [ + { + "name": "Classes", + "topicHref": null, + "tocHref": null, + "level": 5.0, + "items": [], + "leaf": true + }, + { + "name": "B", + "href": "BuildFromProject.Issue8540.B.B.html", + "topicHref": "BuildFromProject.Issue8540.B.B.html", + "tocHref": null, + "level": 5.0, + "items": [], + "leaf": true + } + ], + "tocHref": null, + "level": 4.0 + } + ], + "tocHref": null, + "level": 3.0 + }, + { + "name": "Classes", + "topicHref": null, + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Class1", + "href": "BuildFromProject.Class1.html", + "topicHref": "BuildFromProject.Class1.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Class1.Issue8665", + "href": "BuildFromProject.Class1.Issue8665.html", + "topicHref": "BuildFromProject.Class1.Issue8665.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Class1.Issue8696Attribute", + "href": "BuildFromProject.Class1.Issue8696Attribute.html", + "topicHref": "BuildFromProject.Class1.Issue8696Attribute.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Class1.Issue8948", + "href": "BuildFromProject.Class1.Issue8948.html", + "topicHref": "BuildFromProject.Class1.Issue8948.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Class1.Test", + "href": "BuildFromProject.Class1.Test-1.html", + "topicHref": "BuildFromProject.Class1.Test-1.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Inheritdoc", + "href": "BuildFromProject.Inheritdoc.html", + "topicHref": "BuildFromProject.Inheritdoc.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Inheritdoc.Issue6366", + "href": "BuildFromProject.Inheritdoc.Issue6366.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue6366.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Inheritdoc.Issue6366.Class1", + "href": "BuildFromProject.Inheritdoc.Issue6366.Class1-1.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue6366.Class1-1.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Inheritdoc.Issue6366.Class2", + "href": "BuildFromProject.Inheritdoc.Issue6366.Class2.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue6366.Class2.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Inheritdoc.Issue7035", + "href": "BuildFromProject.Inheritdoc.Issue7035.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue7035.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Inheritdoc.Issue7484", + "href": "BuildFromProject.Inheritdoc.Issue7484.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue7484.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Inheritdoc.Issue8101", + "href": "BuildFromProject.Inheritdoc.Issue8101.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue8101.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Structs", + "topicHref": null, + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Inheritdoc.Issue8129", + "href": "BuildFromProject.Inheritdoc.Issue8129.html", + "topicHref": "BuildFromProject.Inheritdoc.Issue8129.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Interfaces", + "topicHref": null, + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Class1.IIssue8948", + "href": "BuildFromProject.Class1.IIssue8948.html", + "topicHref": "BuildFromProject.Class1.IIssue8948.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "IInheritdoc", + "href": "BuildFromProject.IInheritdoc.html", + "topicHref": "BuildFromProject.IInheritdoc.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + } + ], + "tocHref": null, + "level": 2.0 + }, + { + "name": "BuildFromVBSourceCode", + "href": "BuildFromVBSourceCode.html", + "topicHref": "BuildFromVBSourceCode.html", + "items": [ + { + "name": "Classes", + "topicHref": null, + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "BaseClass1", + "href": "BuildFromVBSourceCode.BaseClass1.html", + "topicHref": "BuildFromVBSourceCode.BaseClass1.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Class1", + "href": "BuildFromVBSourceCode.Class1.html", + "topicHref": "BuildFromVBSourceCode.Class1.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + } + ], + "tocHref": null, + "level": 2.0 + }, + { + "name": "CatLibrary", + "href": "CatLibrary.html", + "topicHref": "CatLibrary.html", + "items": [ + { + "name": "Core", + "href": "CatLibrary.Core.html", + "topicHref": "CatLibrary.Core.html", + "items": [ + { + "name": "Classes", + "topicHref": null, + "tocHref": null, + "level": 4.0, + "items": [], + "leaf": true + }, + { + "name": "ContainersRefType.ContainersRefTypeChild", + "href": "CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html", + "topicHref": "CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html", + "tocHref": null, + "level": 4.0, + "items": [], + "leaf": true + }, + { + "name": "ExplicitLayoutClass", + "href": "CatLibrary.Core.ExplicitLayoutClass.html", + "topicHref": "CatLibrary.Core.ExplicitLayoutClass.html", + "tocHref": null, + "level": 4.0, + "items": [], + "leaf": true + }, + { + "name": "Issue231", + "href": "CatLibrary.Core.Issue231.html", + "topicHref": "CatLibrary.Core.Issue231.html", + "tocHref": null, + "level": 4.0, + "items": [], + "leaf": true + }, + { + "name": "Structs", + "topicHref": null, + "tocHref": null, + "level": 4.0, + "items": [], + "leaf": true + }, + { + "name": "ContainersRefType", + "href": "CatLibrary.Core.ContainersRefType.html", + "topicHref": "CatLibrary.Core.ContainersRefType.html", + "tocHref": null, + "level": 4.0, + "items": [], + "leaf": true + }, + { + "name": "Interfaces", + "topicHref": null, + "tocHref": null, + "level": 4.0, + "items": [], + "leaf": true + }, + { + "name": "ContainersRefType.ContainersRefTypeChildInterface", + "href": "CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html", + "topicHref": "CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html", + "tocHref": null, + "level": 4.0, + "items": [], + "leaf": true + }, + { + "name": "Enums", + "topicHref": null, + "tocHref": null, + "level": 4.0, + "items": [], + "leaf": true + }, + { + "name": "ContainersRefType.ColorType", + "href": "CatLibrary.Core.ContainersRefType.ColorType.html", + "topicHref": "CatLibrary.Core.ContainersRefType.ColorType.html", + "tocHref": null, + "level": 4.0, + "items": [], + "leaf": true + }, + { + "name": "Delegates", + "topicHref": null, + "tocHref": null, + "level": 4.0, + "items": [], + "leaf": true + }, + { + "name": "ContainersRefType.ContainersRefTypeDelegate", + "href": "CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html", + "topicHref": "CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html", + "tocHref": null, + "level": 4.0, + "items": [], + "leaf": true + } + ], + "tocHref": null, + "level": 3.0 + }, + { + "name": "Classes", + "topicHref": null, + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Cat", + "href": "CatLibrary.Cat-2.html", + "topicHref": "CatLibrary.Cat-2.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "CatException", + "href": "CatLibrary.CatException-1.html", + "topicHref": "CatLibrary.CatException-1.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Complex", + "href": "CatLibrary.Complex-2.html", + "topicHref": "CatLibrary.Complex-2.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "ICatExtension", + "href": "CatLibrary.ICatExtension.html", + "topicHref": "CatLibrary.ICatExtension.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Tom", + "href": "CatLibrary.Tom.html", + "topicHref": "CatLibrary.Tom.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "TomFromBaseClass", + "href": "CatLibrary.TomFromBaseClass.html", + "topicHref": "CatLibrary.TomFromBaseClass.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Interfaces", + "topicHref": null, + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "IAnimal", + "href": "CatLibrary.IAnimal.html", + "topicHref": "CatLibrary.IAnimal.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "ICat", + "href": "CatLibrary.ICat.html", + "topicHref": "CatLibrary.ICat.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "Delegates", + "topicHref": null, + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "FakeDelegate", + "href": "CatLibrary.FakeDelegate-1.html", + "topicHref": "CatLibrary.FakeDelegate-1.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "MRefDelegate", + "href": "CatLibrary.MRefDelegate-3.html", + "topicHref": "CatLibrary.MRefDelegate-3.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + }, + { + "name": "MRefNormalDelegate", + "href": "CatLibrary.MRefNormalDelegate.html", + "topicHref": "CatLibrary.MRefNormalDelegate.html", + "tocHref": null, + "level": 3.0, + "items": [], + "leaf": true + } + ], + "tocHref": null, + "level": 2.0 + }, + { + "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", + "topicHref": null, + "tocHref": null, + "level": 5.0, + "items": [], + "leaf": true + }, + { + "name": "ColorType", + "href": "MRef.Demo.Enumeration.ColorType.html", + "topicHref": "MRef.Demo.Enumeration.ColorType.html", + "tocHref": null, + "level": 5.0, + "items": [], + "leaf": true + } + ], + "tocHref": null, + "level": 4.0 + } + ], + "tocHref": null, + "level": 3.0 + } + ], + "tocHref": null, + "level": 2.0 + } + ], + "_appName": "Seed", + "_appTitle": "docfx seed website", + "_enableSearch": true, + "_key": "obj/apipage/toc.yml", + "_navKey": "~/toc.yml", + "_navPath": "toc.html", + "_navRel": "../toc.html", + "_path": "apipage/toc.html", + "_rel": "../", + "_tocKey": "~/obj/apipage/toc.yml", + "_tocPath": "apipage/toc.html", + "_tocRel": "toc.html", + "topicHref": null, + "tocHref": null, + "name": null, + "level": 1.0, + "leaf": false, + "title": "Table of Content", + "_disableToc": true +} \ No newline at end of file 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 new file mode 100644 index 00000000000..430fb9221f4 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.json.view.verified.json @@ -0,0 +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\":\"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\":\"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\":\"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\":\"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\"}]}]}]}]}" +} \ 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 new file mode 100644 index 00000000000..c8ec714a656 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/apipage/toc.verified.json @@ -0,0 +1,339 @@ +{ + "items": [ + { + "name": "BuildFromAssembly", + "href": "BuildFromAssembly.html", + "topicHref": "BuildFromAssembly.html", + "items": [ + { + "name": "Classes" + }, + { + "name": "Class1", + "href": "BuildFromAssembly.Class1.html", + "topicHref": "BuildFromAssembly.Class1.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": "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": "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": "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" + } + ] + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json index bd0d53fc74e..435d005cc6d 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json @@ -249,6 +249,266 @@ "title": "Namespace MRef.Demo.Enumeration | docfx seed website", "keywords": "Namespace MRef.Demo.Enumeration Enums ColorType Enumeration ColorType" }, + "apipage/BuildFromAssembly.Class1.html": { + "href": "apipage/BuildFromAssembly.Class1.html", + "title": "Class Class1 | docfx seed website", + "keywords": "Class Class1 Namespace BuildFromAssembly Assembly BuildFromAssembly.dll This is a test class. public class Class1 Inheritance object Class1 Inherited Members object.GetType() object.MemberwiseClone() object.ToString() object.Equals(object?) object.Equals(object?, object?) object.ReferenceEquals(object?, object?) object.GetHashCode() Constructors Class1() public Class1() Methods HelloWorld() Hello World. public static void HelloWorld()" + }, + "apipage/BuildFromAssembly.html": { + "href": "apipage/BuildFromAssembly.html", + "title": "Namespace BuildFromAssembly | docfx seed website", + "keywords": "Namespace BuildFromAssembly Classes Class1 This is a test class." + }, + "apipage/BuildFromCSharpSourceCode.CSharp.html": { + "href": "apipage/BuildFromCSharpSourceCode.CSharp.html", + "title": "Class CSharp | docfx seed website", + "keywords": "Class CSharp Namespace BuildFromCSharpSourceCode public class CSharp Inheritance object CSharp Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString() Methods Main(string[]) public static void Main(string[] args) Parameters args string[]" + }, + "apipage/BuildFromCSharpSourceCode.html": { + "href": "apipage/BuildFromCSharpSourceCode.html", + "title": "Namespace BuildFromCSharpSourceCode | docfx seed website", + "keywords": "Namespace BuildFromCSharpSourceCode Classes CSharp" + }, + "apipage/BuildFromProject.Class1.IIssue8948.html": { + "href": "apipage/BuildFromProject.Class1.IIssue8948.html", + "title": "Interface Class1.IIssue8948 | docfx seed website", + "keywords": "Interface Class1.IIssue8948 Namespace BuildFromProject Assembly BuildFromProject.dll public interface Class1.IIssue8948 Methods DoNothing() Does nothing with generic type T. void DoNothing() Type Parameters T A generic type." + }, + "apipage/BuildFromProject.Class1.Issue8665.html": { + "href": "apipage/BuildFromProject.Class1.Issue8665.html", + "title": "Class Class1.Issue8665 | docfx seed website", + "keywords": "Class Class1.Issue8665 Namespace BuildFromProject Assembly BuildFromProject.dll public class Class1.Issue8665 Inheritance object Class1.Issue8665 Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString() Constructors Issue8665() public Issue8665() Issue8665(int) public Issue8665(int foo) Parameters foo int Issue8665(int, char) public Issue8665(int foo, char bar) Parameters foo int bar char Issue8665(int, char, string) public Issue8665(int foo, char bar, string baz) Parameters foo int bar char baz string Properties Bar public char Bar { get; } Property Value char Baz public string Baz { get; } Property Value string Foo public int Foo { get; } Property Value int" + }, + "apipage/BuildFromProject.Class1.Issue8696Attribute.html": { + "href": "apipage/BuildFromProject.Class1.Issue8696Attribute.html", + "title": "Class Class1.Issue8696Attribute | docfx seed website", + "keywords": "Class Class1.Issue8696Attribute Namespace BuildFromProject Assembly BuildFromProject.dll public class Class1.Issue8696Attribute : Attribute Inheritance object Attribute Class1.Issue8696Attribute Inherited Members Attribute.Equals(object?) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object?) Attribute.TypeId object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString() Constructors Issue8696Attribute(string?, int, int, string[]?, bool, Type?) [Class1.Issue8696(\"Changes the name of the server in the server list\", 0, 0, null, false, null)] public Issue8696Attribute(string? description = null, int boundsMin = 0, int boundsMax = 0, string[]? validGameModes = null, bool hasMultipleSelections = false, Type? enumType = null) Parameters description string? boundsMin int boundsMax int validGameModes string[]? hasMultipleSelections bool enumType Type?" + }, + "apipage/BuildFromProject.Class1.Issue8948.html": { + "href": "apipage/BuildFromProject.Class1.Issue8948.html", + "title": "Class Class1.Issue8948 | docfx seed website", + "keywords": "Class Class1.Issue8948 Namespace BuildFromProject Assembly BuildFromProject.dll public class Class1.Issue8948 : Class1.IIssue8948 Inheritance object Class1.Issue8948 Implements Class1.IIssue8948 Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString() Methods DoNothing() Does nothing with generic type T. public void DoNothing() Type Parameters T A generic type." + }, + "apipage/BuildFromProject.Class1.Test-1.html": { + "href": "apipage/BuildFromProject.Class1.Test-1.html", + "title": "Class Class1.Test | docfx seed website", + "keywords": "Class Class1.Test Namespace BuildFromProject Assembly BuildFromProject.dll public class Class1.Test Type Parameters T Inheritance object Class1.Test Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString()" + }, + "apipage/BuildFromProject.Class1.html": { + "href": "apipage/BuildFromProject.Class1.html", + "title": "Class Class1 | docfx seed website", + "keywords": "Class Class1 Namespace BuildFromProject Assembly BuildFromProject.dll public class Class1 : IClass1 Inheritance object Class1 Implements IClass1 Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString() Methods Issue1651() Pricing models are used to calculate theoretical option values 1Black Scholes 2Black76 3Black76Fut 4Equity Tree 5Variance Swap 6Dividend Forecast public void Issue1651() Issue1887() IConfiguration related helper and extension routines. public void Issue1887() Issue2623() public void Issue2623() Examples MyClass myClass = new MyClass(); void Update() { myClass.Execute(); } Remarks For example: MyClass myClass = new MyClass(); void Update() { myClass.Execute(); } Issue2723() public void Issue2723() Remarks Note This is a . & \" ' Inline . link for (var i = 0; i > 10; i++) // & \" ' var range = new Range { Min = 0, Max = 10 }; var range = new Range { Min = 0, Max = 10 }; Issue4017() public void Issue4017() Examples public void HookMessageDeleted(BaseSocketClient client) { client.MessageDeleted += HandleMessageDelete; } public Task HandleMessageDelete(Cacheable cachedMessage, ISocketMessageChannel channel) { // check if the message exists in cache; if not, we cannot report what was removed if (!cachedMessage.HasValue) return; var message = cachedMessage.Value; Console.WriteLine($\"A message ({message.Id}) from {message.Author} was removed from the channel {channel.Name} ({channel.Id}):\" + Environment.NewLine + message.Content); return Task.CompletedTask; } Remarks void Update() { myClass.Execute(); } Issue4392() public void Issue4392() Remarks @\"\\\\?\\\" @\"\\\\?\\\" Issue7484() public void Issue7484() Remarks There's really no reason to not believe that this class can test things. Term Description A Term A Description Bee Term Bee Description Issue8764() public void Issue8764() where T : unmanaged Type Parameters T Issue896() Test public void Issue896() See Also Class1.Test Class1 Issue9216() Calculates the determinant of a 3-dimensional matrix: \\(A = \\begin{vmatrix} a_{11} & a_{12} & a_{13} \\\\ a_{21} & a_{22} & a_{23} \\\\ a_{31} & a_{32} & a_{33} \\end{vmatrix}\\) Returns the smallest value: \\(\\left\\{\\begin{matrix}a, aa\\\\ \\end{matrix} \\right.\\) public static double Issue9216() Returns double XmlCommentIncludeTag() This method should do something... public void XmlCommentIncludeTag() Remarks This is remarks." + }, + "apipage/BuildFromProject.IInheritdoc.html": { + "href": "apipage/BuildFromProject.IInheritdoc.html", + "title": "Interface IInheritdoc | docfx seed website", + "keywords": "Interface IInheritdoc Namespace BuildFromProject Assembly BuildFromProject.dll public interface IInheritdoc Methods Issue7629() This method should do something... void Issue7629()" + }, + "apipage/BuildFromProject.Inheritdoc.Issue6366.Class1-1.html": { + "href": "apipage/BuildFromProject.Inheritdoc.Issue6366.Class1-1.html", + "title": "Class Inheritdoc.Issue6366.Class1 | docfx seed website", + "keywords": "Class Inheritdoc.Issue6366.Class1 Namespace BuildFromProject Assembly BuildFromProject.dll public abstract class Inheritdoc.Issue6366.Class1 Type Parameters T Inheritance object Inheritdoc.Issue6366.Class1 Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString() Methods TestMethod1(T, int) This text inherited. public abstract T TestMethod1(T parm1, int parm2) Parameters parm1 T This text NOT inherited. parm2 int This text inherited. Returns T This text inherited." + }, + "apipage/BuildFromProject.Inheritdoc.Issue6366.Class2.html": { + "href": "apipage/BuildFromProject.Inheritdoc.Issue6366.Class2.html", + "title": "Class Inheritdoc.Issue6366.Class2 | docfx seed website", + "keywords": "Class Inheritdoc.Issue6366.Class2 Namespace BuildFromProject Assembly BuildFromProject.dll public class Inheritdoc.Issue6366.Class2 : Inheritdoc.Issue6366.Class1 Inheritance object Inheritdoc.Issue6366.Class1 Inheritdoc.Issue6366.Class2 Inherited Members Inheritdoc.Issue6366.Class1.TestMethod1(bool, int) object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString() Methods TestMethod1(bool, int) This text inherited. public override bool TestMethod1(bool parm1, int parm2) Parameters parm1 bool This text NOT inherited. parm2 int This text inherited. Returns bool This text inherited." + }, + "apipage/BuildFromProject.Inheritdoc.Issue6366.html": { + "href": "apipage/BuildFromProject.Inheritdoc.Issue6366.html", + "title": "Class Inheritdoc.Issue6366 | docfx seed website", + "keywords": "Class Inheritdoc.Issue6366 Namespace BuildFromProject Assembly BuildFromProject.dll public class Inheritdoc.Issue6366 Inheritance object Inheritdoc.Issue6366 Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString()" + }, + "apipage/BuildFromProject.Inheritdoc.Issue7035.html": { + "href": "apipage/BuildFromProject.Inheritdoc.Issue7035.html", + "title": "Class Inheritdoc.Issue7035 | docfx seed website", + "keywords": "Class Inheritdoc.Issue7035 Namespace BuildFromProject Assembly BuildFromProject.dll public class Inheritdoc.Issue7035 Inheritance object Inheritdoc.Issue7035 Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString() Methods A() public void A() B() public void B()" + }, + "apipage/BuildFromProject.Inheritdoc.Issue7484.html": { + "href": "apipage/BuildFromProject.Inheritdoc.Issue7484.html", + "title": "Class Inheritdoc.Issue7484 | docfx seed website", + "keywords": "Class Inheritdoc.Issue7484 Namespace BuildFromProject Assembly BuildFromProject.dll This is a test class to have something for DocFX to document. public class Inheritdoc.Issue7484 Inheritance object Inheritdoc.Issue7484 Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString() Remarks We're going to talk about things now. BoolReturningMethod(bool) Simple method to generate docs for. DoDad A string that could have something. Constructors Issue7484() This is a constructor to document. public Issue7484() Properties DoDad A string that could have something. public string DoDad { get; } Property Value string Methods BoolReturningMethod(bool) Simple method to generate docs for. public bool BoolReturningMethod(bool source) Parameters source bool A meaningless boolean value, much like most questions in the world. Returns bool An exactly equivalently meaningless boolean value, much like most answers in the world. Remarks I'd like to take a moment to thank all of those who helped me get to a place where I can write documentation like this." + }, + "apipage/BuildFromProject.Inheritdoc.Issue8101.html": { + "href": "apipage/BuildFromProject.Inheritdoc.Issue8101.html", + "title": "Class Inheritdoc.Issue8101 | docfx seed website", + "keywords": "Class Inheritdoc.Issue8101 Namespace BuildFromProject Assembly BuildFromProject.dll public class Inheritdoc.Issue8101 Inheritance object Inheritdoc.Issue8101 Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString() Methods Tween(float, float, float, Action) Create a new tween. public static object Tween(float from, float to, float duration, Action onChange) Parameters from float The starting value. to float The end value. duration float Total tween duration in seconds. onChange Action A callback that will be invoked every time the tween value changes. Returns object The newly created tween instance. Tween(int, int, float, Action) Create a new tween. public static object Tween(int from, int to, float duration, Action onChange) Parameters from int The starting value. to int The end value. duration float Total tween duration in seconds. onChange Action A callback that will be invoked every time the tween value changes. Returns object The newly created tween instance." + }, + "apipage/BuildFromProject.Inheritdoc.Issue8129.html": { + "href": "apipage/BuildFromProject.Inheritdoc.Issue8129.html", + "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.html": { + "href": "apipage/BuildFromProject.Inheritdoc.html", + "title": "Class Inheritdoc | docfx seed website", + "keywords": "Class Inheritdoc Namespace BuildFromProject Assembly BuildFromProject.dll public class Inheritdoc : IInheritdoc, IDisposable Inheritance object Inheritdoc Implements IInheritdoc IDisposable Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString() Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Issue7628() This method should do something... public void Issue7628() Issue7629() This method should do something... public void Issue7629()" + }, + "apipage/BuildFromProject.Issue8540.A.A.html": { + "href": "apipage/BuildFromProject.Issue8540.A.A.html", + "title": "Class A | docfx seed website", + "keywords": "Class A Namespace BuildFromProject.Issue8540.A Assembly BuildFromProject.dll public class A Inheritance object A Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString()" + }, + "apipage/BuildFromProject.Issue8540.A.html": { + "href": "apipage/BuildFromProject.Issue8540.A.html", + "title": "Namespace BuildFromProject.Issue8540.A | docfx seed website", + "keywords": "Namespace BuildFromProject.Issue8540.A Classes A" + }, + "apipage/BuildFromProject.Issue8540.B.B.html": { + "href": "apipage/BuildFromProject.Issue8540.B.B.html", + "title": "Class B | docfx seed website", + "keywords": "Class B Namespace BuildFromProject.Issue8540.B Assembly BuildFromProject.dll public class B Inheritance object B Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString()" + }, + "apipage/BuildFromProject.Issue8540.B.html": { + "href": "apipage/BuildFromProject.Issue8540.B.html", + "title": "Namespace BuildFromProject.Issue8540.B | docfx seed website", + "keywords": "Namespace BuildFromProject.Issue8540.B Classes B" + }, + "apipage/BuildFromProject.Issue8540.html": { + "href": "apipage/BuildFromProject.Issue8540.html", + "title": "Namespace BuildFromProject.Issue8540 | docfx seed website", + "keywords": "Namespace BuildFromProject.Issue8540 Namespaces BuildFromProject.Issue8540.A BuildFromProject.Issue8540.B" + }, + "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 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 Class1.Issue8948 Class1.Test Structs Inheritdoc.Issue8129 Interfaces IInheritdoc Class1.IIssue8948" + }, + "apipage/BuildFromVBSourceCode.BaseClass1.html": { + "href": "apipage/BuildFromVBSourceCode.BaseClass1.html", + "title": "Class BaseClass1 | docfx seed website", + "keywords": "Class BaseClass1 Namespace BuildFromVBSourceCode This is the BaseClass public abstract class BaseClass1 Inheritance object BaseClass1 Derived Class1 Inherited Members object.Equals(object) object.Equals(object, object) object.Finalize() object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods WithDeclarationKeyword(Class1) public abstract DateTime WithDeclarationKeyword(Class1 keyword) Parameters keyword Class1 Returns DateTime" + }, + "apipage/BuildFromVBSourceCode.Class1.html": { + "href": "apipage/BuildFromVBSourceCode.Class1.html", + "title": "Class Class1 | docfx seed website", + "keywords": "Class Class1 Namespace BuildFromVBSourceCode This is summary from vb class... public class Class1 : BaseClass1 Inheritance object BaseClass1 Class1 Inherited Members BaseClass1.WithDeclarationKeyword(Class1) object.Equals(object) object.Equals(object, object) object.Finalize() object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Fields ValueClass This is a Value type public Class1 ValueClass Field Value Class1 Properties Keyword [Obsolete(\"This member is obsolete.\", true)] public Class1 Keyword { get; } Property Value Class1 Methods Value(string) This is a Function public int Value(string name) Parameters name string Name as the String value Returns int Returns Ahooo WithDeclarationKeyword(Class1) What is Sub? public override DateTime WithDeclarationKeyword(Class1 keyword) Parameters keyword Class1 Returns DateTime" + }, + "apipage/BuildFromVBSourceCode.html": { + "href": "apipage/BuildFromVBSourceCode.html", + "title": "Namespace BuildFromVBSourceCode | docfx seed website", + "keywords": "Namespace BuildFromVBSourceCode Classes BaseClass1 This is the BaseClass Class1 This is summary from vb class..." + }, + "apipage/CatLibrary.Cat-2.html": { + "href": "apipage/CatLibrary.Cat-2.html", + "title": "Class Cat | docfx seed website", + "keywords": "Class Cat Namespace CatLibrary Assembly CatLibrary.dll Here's main class of this Demo. You can see mostly type of article within this class and you for more detail, please see the remarks. this class is a template class. It has two Generic parameter. they are: T and K. The extension method of this class can refer to ICatExtension class [Serializable] public class Cat : ICat, IAnimal where T : class, new() where K : struct Type Parameters T This type should be class and can new instance. K This type is a struct type, class type can't be used for this parameter. Inheritance object Cat Implements ICat IAnimal Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString() Extension Methods ICatExtension.Play(ICat, ContainersRefType.ColorType) ICatExtension.Sleep(ICat, long) 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 { a.GetFeetLength(catNumber); } As you see, here we bring in pointer so we need to add unsafe keyword. Remarks Here's all the content you can see in this class. Constructors Cat() Default constructor. public Cat() Cat(T) Constructor with one generic parameter. public Cat(T ownType) Parameters ownType T This parameter type defined by class. Cat(string, out int, string, bool) It's a complex constructor. The parameter will have some attributes. public Cat(string nickName, out int age, string realName, bool isHealthy) Parameters nickName string it's string type. age int It's an out and ref parameter. realName string It's an out paramter. isHealthy bool It's an in parameter. Fields isHealthy Field with attribute. [ContextStatic] [NonSerialized] public bool isHealthy Field Value bool Properties Age Hint cat's age. protected int Age { get; set; } Property Value int Name EII property. public string Name { get; } Property Value string this[string] This is index property of Cat. You can see that the visibility is different between get and set method. public int this[string a] { protected get; set; } Property Value int Methods CalculateFood(DateTime) It's a method with complex return type. public Dictionary> CalculateFood(DateTime date) Parameters date DateTime Date time to now. Returns Dictionary> It's a relationship map of different kind food. Equals(object) Override the method of Object.Equals(object obj). public override bool Equals(object obj) Parameters obj object Can pass any class type. Returns bool The return value tell you whehter the compare operation is successful. GetTailLength(int*, params object[]) It's an unsafe method. As you see, catName is a pointer, so we need to add unsafe keyword. public long GetTailLength(int* catName, params object[] parameters) Parameters catName int* Thie represent for cat name length. parameters object[] Optional parameters. Returns long Return cat tail's length. Jump(T, K, ref bool) This method have attribute above it. [Conditional(\"Debug\")] public void Jump(T ownType, K anotherOwnType, ref bool cheat) Parameters ownType T Type come from class define. anotherOwnType K Type come from class define. cheat bool Hint whether this cat has cheat mode. Exceptions ArgumentException This is an argument exception ownEat Eat event of this cat public event EventHandler ownEat Event Type EventHandler Operators operator +(Cat, int) Addition operator of this class. public static int operator +(Cat lsr, int rsr) Parameters lsr Cat .. rsr int ~~ Returns int Result with int type. explicit operator Tom(Cat) Expilicit operator of this class. It means this cat can evolve to change to Tom. Tom and Jerry. public static explicit operator Tom(Cat src) Parameters src Cat Instance of this class. Returns Tom Advanced class type of cat. operator -(Cat, int) Similar with operaotr +, refer to that topic. public static int operator -(Cat lsr, int rsr) Parameters lsr Cat rsr int Returns int" + }, + "apipage/CatLibrary.CatException-1.html": { + "href": "apipage/CatLibrary.CatException-1.html", + "title": "Class CatException | docfx seed website", + "keywords": "Class CatException Namespace CatLibrary Assembly CatLibrary.dll public class CatException : Exception, ISerializable Type Parameters T Inheritance object Exception CatException Implements ISerializable Inherited Members Exception.GetBaseException() Exception.GetObjectData(SerializationInfo, StreamingContext) Exception.GetType() Exception.ToString() Exception.Data Exception.HelpLink Exception.HResult Exception.InnerException Exception.Message Exception.Source Exception.StackTrace Exception.TargetSite Exception.SerializeObjectState object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString()" + }, + "apipage/CatLibrary.Complex-2.html": { + "href": "apipage/CatLibrary.Complex-2.html", + "title": "Class Complex | docfx seed website", + "keywords": "Class Complex Namespace CatLibrary Assembly CatLibrary.dll public class Complex Type Parameters T J Inheritance object Complex Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString()" + }, + "apipage/CatLibrary.Core.ContainersRefType.ColorType.html": { + "href": "apipage/CatLibrary.Core.ContainersRefType.ColorType.html", + "title": "Enum ContainersRefType.ColorType | docfx seed website", + "keywords": "Enum ContainersRefType.ColorType Namespace CatLibrary.Core Assembly CatLibrary.Core.dll Enumeration ColorType public enum ContainersRefType.ColorType Fields Red = 0 red Blue = 1 blue Yellow = 2 yellow" + }, + "apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html": { + "href": "apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html", + "title": "Class ContainersRefType.ContainersRefTypeChild | docfx seed website", + "keywords": "Class ContainersRefType.ContainersRefTypeChild Namespace CatLibrary.Core Assembly CatLibrary.Core.dll public class ContainersRefType.ContainersRefTypeChild Inheritance object ContainersRefType.ContainersRefTypeChild Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString()" + }, + "apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html": { + "href": "apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html", + "title": "Interface ContainersRefType.ContainersRefTypeChildInterface | docfx seed website", + "keywords": "Interface ContainersRefType.ContainersRefTypeChildInterface Namespace CatLibrary.Core Assembly CatLibrary.Core.dll public interface ContainersRefType.ContainersRefTypeChildInterface" + }, + "apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html": { + "href": "apipage/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html", + "title": "Delegate ContainersRefType.ContainersRefTypeDelegate | docfx seed website", + "keywords": "Delegate ContainersRefType.ContainersRefTypeDelegate Namespace CatLibrary.Core Assembly CatLibrary.Core.dll Delegate ContainersRefTypeDelegate public delegate void ContainersRefType.ContainersRefTypeDelegate()" + }, + "apipage/CatLibrary.Core.ContainersRefType.html": { + "href": "apipage/CatLibrary.Core.ContainersRefType.html", + "title": "Struct ContainersRefType | docfx seed website", + "keywords": "Struct ContainersRefType Namespace CatLibrary.Core Assembly CatLibrary.Core.dll Struct ContainersRefType public struct ContainersRefType Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.ReferenceEquals(object?, object?) object.ToString() Extension Methods Issue231.Bar(ContainersRefType) Issue231.Foo(ContainersRefType) Fields ColorCount ColorCount public long ColorCount Field Value long Properties GetColorCount GetColorCount public long GetColorCount { get; } Property Value long Methods ContainersRefTypeNonRefMethod(params object[]) ContainersRefTypeNonRefMethod array public static int ContainersRefTypeNonRefMethod(params object[] parmsArray) Parameters parmsArray object[] Returns int ContainersRefTypeEventHandler public event EventHandler ContainersRefTypeEventHandler Event Type EventHandler" + }, + "apipage/CatLibrary.Core.ExplicitLayoutClass.html": { + "href": "apipage/CatLibrary.Core.ExplicitLayoutClass.html", + "title": "Class ExplicitLayoutClass | docfx seed website", + "keywords": "Class ExplicitLayoutClass Namespace CatLibrary.Core Assembly CatLibrary.Core.dll public class ExplicitLayoutClass Inheritance object ExplicitLayoutClass Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString()" + }, + "apipage/CatLibrary.Core.Issue231.html": { + "href": "apipage/CatLibrary.Core.Issue231.html", + "title": "Class Issue231 | docfx seed website", + "keywords": "Class Issue231 Namespace CatLibrary.Core Assembly CatLibrary.dll, CatLibrary.Core.dll public static class Issue231 Inheritance object Issue231 Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString() Methods Bar(ContainersRefType) public static void Bar(this ContainersRefType c) Parameters c ContainersRefType Foo(ContainersRefType) public static void Foo(this ContainersRefType c) Parameters c ContainersRefType" + }, + "apipage/CatLibrary.Core.html": { + "href": "apipage/CatLibrary.Core.html", + "title": "Namespace CatLibrary.Core | docfx seed website", + "keywords": "Namespace CatLibrary.Core Classes ContainersRefType.ContainersRefTypeChild ExplicitLayoutClass Issue231 Issue231 Structs ContainersRefType Struct ContainersRefType Interfaces ContainersRefType.ContainersRefTypeChildInterface Enums ContainersRefType.ColorType Enumeration ColorType Delegates ContainersRefType.ContainersRefTypeDelegate Delegate ContainersRefTypeDelegate" + }, + "apipage/CatLibrary.FakeDelegate-1.html": { + "href": "apipage/CatLibrary.FakeDelegate-1.html", + "title": "Delegate FakeDelegate | docfx seed website", + "keywords": "Delegate FakeDelegate Namespace CatLibrary Assembly CatLibrary.dll Fake delegate public delegate int FakeDelegate(long num, string name, params object[] scores) Parameters num long Fake para name string Fake para scores object[] Optional Parameter. Returns int Return a fake number to confuse you. Type Parameters T Fake para" + }, + "apipage/CatLibrary.IAnimal.html": { + "href": "apipage/CatLibrary.IAnimal.html", + "title": "Interface IAnimal | docfx seed website", + "keywords": "Interface IAnimal Namespace CatLibrary Assembly CatLibrary.dll This is basic interface of all animal. public interface IAnimal Properties Name Name of Animal. string Name { get; } Property Value string this[int] Return specific number animal's name. string this[int index] { get; } Property Value string Methods Eat() Animal's eat method. void Eat() Eat(Tool) Overload method of eat. This define the animal eat by which tool. void Eat(Tool tool) where Tool : class Parameters tool Tool Tool name. Type Parameters Tool It's a class type. Eat(string) Feed the animal with some food void Eat(string food) Parameters food string Food to eat" + }, + "apipage/CatLibrary.ICat.html": { + "href": "apipage/CatLibrary.ICat.html", + "title": "Interface ICat | docfx seed website", + "keywords": "Interface ICat Namespace CatLibrary Assembly CatLibrary.dll Cat's interface public interface ICat : IAnimal Implements IAnimal Extension Methods ICatExtension.Play(ICat, ContainersRefType.ColorType) ICatExtension.Sleep(ICat, long) eat eat event of cat. Every cat must implement this event. event EventHandler eat Event Type EventHandler" + }, + "apipage/CatLibrary.ICatExtension.html": { + "href": "apipage/CatLibrary.ICatExtension.html", + "title": "Class ICatExtension | docfx seed website", + "keywords": "Class ICatExtension Namespace CatLibrary 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 public static class ICatExtension Inheritance object ICatExtension Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString() Methods Play(ICat, ColorType) Extension method to let cat play public static void Play(this ICat icat, ContainersRefType.ColorType toy) Parameters icat ICat Cat toy ContainersRefType.ColorType Something to play Sleep(ICat, long) Extension method hint that how long the cat can sleep. public static void Sleep(this ICat icat, long hours) Parameters icat ICat The type will be extended. hours long The length of sleep." + }, + "apipage/CatLibrary.MRefDelegate-3.html": { + "href": "apipage/CatLibrary.MRefDelegate-3.html", + "title": "Delegate MRefDelegate | docfx seed website", + "keywords": "Delegate MRefDelegate Namespace CatLibrary Assembly CatLibrary.dll Generic delegate with many constrains. public delegate void MRefDelegate(K k, T t, L l) where K : class, IComparable where T : struct where L : Tom, IEnumerable Parameters k K Type K. t T Type T. l L Type L. Type Parameters K Generic K. T Generic T. L Generic L." + }, + "apipage/CatLibrary.MRefNormalDelegate.html": { + "href": "apipage/CatLibrary.MRefNormalDelegate.html", + "title": "Delegate MRefNormalDelegate | docfx seed website", + "keywords": "Delegate MRefNormalDelegate Namespace CatLibrary Assembly CatLibrary.dll Delegate in the namespace public delegate void MRefNormalDelegate(List pics, out string name) Parameters pics List a name list of pictures. name string give out the needed name." + }, + "apipage/CatLibrary.Tom.html": { + "href": "apipage/CatLibrary.Tom.html", + "title": "Class Tom | docfx seed website", + "keywords": "Class Tom Namespace CatLibrary Assembly CatLibrary.dll Tom class is only inherit from Object. Not any member inside itself. public class Tom Inheritance object Tom Derived TomFromBaseClass Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString() Methods TomMethod(Complex, Tuple) This is a Tom Method with complex type as return public Complex TomMethod(Complex a, Tuple b) Parameters a Complex A complex input b Tuple Another complex input Returns Complex Complex TomFromBaseClass Exceptions NotImplementedException This is not implemented ArgumentException This is the exception to be thrown when implemented CatException This is the exception in current documentation" + }, + "apipage/CatLibrary.TomFromBaseClass.html": { + "href": "apipage/CatLibrary.TomFromBaseClass.html", + "title": "Class TomFromBaseClass | docfx seed website", + "keywords": "Class TomFromBaseClass Namespace CatLibrary Assembly CatLibrary.dll TomFromBaseClass inherits from @ public class TomFromBaseClass : Tom Inheritance object Tom TomFromBaseClass Inherited Members Tom.TomMethod(Complex, Tuple) object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString() Constructors TomFromBaseClass(int) This is a #ctor with parameter public TomFromBaseClass(int k) Parameters k int" + }, + "apipage/CatLibrary.html": { + "href": "apipage/CatLibrary.html", + "title": "Namespace CatLibrary | docfx seed website", + "keywords": "Namespace CatLibrary Namespaces CatLibrary.Core Classes Cat Here's main class of this Demo. You can see mostly type of article within this class and you for more detail, please see the remarks. this class is a template class. It has two Generic parameter. they are: T and K. The extension method of this class can refer to ICatExtension class CatException Complex ICatExtension 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 Tom Tom class is only inherit from Object. Not any member inside itself. TomFromBaseClass TomFromBaseClass inherits from @ Interfaces IAnimal This is basic interface of all animal. ICat Cat's interface Delegates FakeDelegate Fake delegate MRefDelegate Generic delegate with many constrains. MRefNormalDelegate Delegate in the namespace" + }, + "apipage/MRef.Demo.Enumeration.ColorType.html": { + "href": "apipage/MRef.Demo.Enumeration.ColorType.html", + "title": "Enum ColorType | docfx seed website", + "keywords": "Enum ColorType Namespace MRef.Demo.Enumeration Assembly CatLibrary.dll Enumeration ColorType public enum ColorType Fields Red = 0 this color is red Blue = 1 blue like river Yellow = 2 yellow comes from desert Remarks Red/Blue/Yellow can become all color you want. See Also object" + }, + "apipage/MRef.Demo.Enumeration.html": { + "href": "apipage/MRef.Demo.Enumeration.html", + "title": "Namespace MRef.Demo.Enumeration | docfx seed website", + "keywords": "Namespace MRef.Demo.Enumeration Enums ColorType Enumeration ColorType" + }, + "apipage/MRef.Demo.html": { + "href": "apipage/MRef.Demo.html", + "title": "Namespace MRef.Demo | docfx seed website", + "keywords": "Namespace MRef.Demo Namespaces MRef.Demo.Enumeration" + }, + "apipage/MRef.html": { + "href": "apipage/MRef.html", + "title": "Namespace MRef | docfx seed website", + "keywords": "Namespace MRef Namespaces MRef.Demo" + }, "articles/csharp_coding_standards.html": { "href": "articles/csharp_coding_standards.html", "title": "C# Coding Standards | docfx seed website", @@ -322,7 +582,7 @@ "md/BuildFromProject.Class1.html": { "href": "md/BuildFromProject.Class1.html", "title": "Class Class1 | docfx seed website", - "keywords": "Class Class1 Namespace: BuildFromProject Assembly: BuildFromProject.dll public class Class1 : IClass1 Inheritance object ← Class1 Implements IClass1 Inherited Members object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString() Methods Issue1651() Pricing models are used to calculate theoretical option values 1Black Scholes 2Black76 3Black76Fut 4Equity Tree 5Variance Swap 6Dividend Forecast public void Issue1651() Issue1887() IConfiguration related helper and extension routines. public void Issue1887() Issue2623() public void Issue2623() Examples MyClass myClass = new MyClass(); void Update() { myClass.Execute(); } Remarks For example: MyClass myClass = new MyClass(); void Update() { myClass.Execute(); } Issue2723() public void Issue2723() Remarks Note This is a . & \" ' Inline . link for (var i = 0; i > 10; i++) // & \" ' var range = new Range { Min = 0, Max = 10 }; var range = new Range { Min = 0, Max = 10 }; Issue4017() public void Issue4017() Examples public void HookMessageDeleted(BaseSocketClient client) { client.MessageDeleted += HandleMessageDelete; } public Task HandleMessageDelete(Cacheable cachedMessage, ISocketMessageChannel channel) { // check if the message exists in cache; if not, we cannot report what was removed if (!cachedMessage.HasValue) return; var message = cachedMessage.Value; Console.WriteLine($\"A message ({message.Id}) from {message.Author} was removed from the channel {channel.Name} ({channel.Id}):\" + Environment.NewLine + message.Content); return Task.CompletedTask; } Remarks void Update() { myClass.Execute(); } Issue4392() public void Issue4392() Remarks @\"\\\\?\\\" @\"\\\\?\\\" Issue7484() public void Issue7484() Remarks There's really no reason to not believe that this class can test things. Term Description A Term A Description Bee Term Bee Description Issue8764() public void Issue8764() where T : unmanaged Type Parameters T Issue896() Test public void Issue896() See Also Class1.Test Class1 Issue9216() Calculates the determinant of a 3-dimensional matrix: \\(A = \\begin{vmatrix} a_{11} & a_{12} & a_{13} \\\\ a_{21} & a_{22} & a_{23} \\\\ a_{31} & a_{32} & a_{33} \\end{vmatrix}\\) Returns the smallest value: \\(\\left\\{\\begin{matrix}a, aa\\\\ \\end{matrix} \\right.\\) public static double Issue9216() Returns double XmlCommentIncludeTag() This method should do something... public void XmlCommentIncludeTag() Remarks This is remarks." + "keywords": "Class Class1 Namespace: BuildFromProject Assembly: BuildFromProject.dll public class Class1 : IClass1 Inheritance object ← Class1 Implements IClass1 Inherited Members object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString() Methods Issue1651() Pricing models are used to calculate theoretical option values 1Black Scholes 2Black76 3Black76Fut 4Equity Tree 5Variance Swap 6Dividend Forecast public void Issue1651() Issue1887() IConfiguration related helper and extension routines. public void Issue1887() Issue2623() public void Issue2623() Examples MyClass myClass = new MyClass(); void Update() { myClass.Execute(); } Remarks For example: MyClass myClass = new MyClass(); void Update() { myClass.Execute(); } Issue2723() public void Issue2723() Remarks Note This is a . & \" ' Inline . link for (var i = 0; i > 10; i++) // & \" ' var range = new Range { Min = 0, Max = 10 }; var range = new Range { Min = 0, Max = 10 }; Issue4017() public void Issue4017() Examples public void HookMessageDeleted(BaseSocketClient client) { client.MessageDeleted += HandleMessageDelete; } public Task HandleMessageDelete(Cacheable cachedMessage, ISocketMessageChannel channel) { // check if the message exists in cache; if not, we cannot report what was removed if (!cachedMessage.HasValue) return; var message = cachedMessage.Value; Console.WriteLine($\"A message ({message.Id}) from {message.Author} was removed from the channel {channel.Name} ({channel.Id}):\" + Environment.NewLine + message.Content); return Task.CompletedTask; } Remarks void Update() { myClass.Execute(); } Issue4392() public void Issue4392() Remarks @\"\\\\?\\\" @\"\\\\?\\\" Issue7484() public void Issue7484() Remarks There's really no reason to not believe that this class can test things. Term Description A Term A Description Bee Term Bee Description Issue8764() public void Issue8764() where T : unmanaged Type Parameters T Issue896() Test public void Issue896() See Also Class1.Test, Class1 Issue9216() Calculates the determinant of a 3-dimensional matrix: \\(A = \\begin{vmatrix} a_{11} & a_{12} & a_{13} \\\\ a_{21} & a_{22} & a_{23} \\\\ a_{31} & a_{32} & a_{33} \\end{vmatrix}\\) Returns the smallest value: \\(\\left\\{\\begin{matrix}a, aa\\\\ \\end{matrix} \\right.\\) public static double Issue9216() Returns double XmlCommentIncludeTag() This method should do something... public void XmlCommentIncludeTag() Remarks This is remarks." }, "md/BuildFromProject.IInheritdoc.html": { "href": "md/BuildFromProject.IInheritdoc.html", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromAssembly.Class1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromAssembly.Class1.html.view.verified.json index c742d36dd34..a1d84dc4485 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromAssembly.Class1.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromAssembly.Class1.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromAssembly
    \nAssembly: BuildFromAssembly.dll

    \n

    This is a test class.

    \n
    public class Class1\n
    \n
    Inheritance
    \n

    object ←\nClass1

    \n
    Inherited Members
    \n

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

    \n

    Constructors

    \n

    Class1()

    \n
    public Class1()\n
    \n

    Methods

    \n

    HelloWorld()

    \n

    Hello World.

    \n
    public static void HelloWorld()\n
    \n", + "conceptual": "\n

    Namespace: BuildFromAssembly
    \nAssembly: BuildFromAssembly.dll

    \n

    This is a test class.

    \n
    public class Class1\n
    \n

    Inheritance

    \n

    object ←\nClass1

    \n

    Inherited Members

    \n

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

    \n

    Constructors

    \n

    Class1()

    \n
    public Class1()\n
    \n

    Methods

    \n

    HelloWorld()

    \n

    Hello World.

    \n
    public static void HelloWorld()\n
    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class Class1

    ", - "title": "Class Class1", + "rawTitle": "

    Class Class1

    ", + "title": " Class Class1", "wordCount": 39.0, "_key": "obj/md/BuildFromAssembly.Class1.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromAssembly.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromAssembly.html.view.verified.json index 5e0c0add001..6330f1fec3b 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromAssembly.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromAssembly.html.view.verified.json @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Namespace BuildFromAssembly

    ", - "title": "Namespace BuildFromAssembly", + "rawTitle": "

    Namespace BuildFromAssembly

    ", + "title": " Namespace BuildFromAssembly", "wordCount": 7.0, "_key": "obj/md/BuildFromAssembly.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromCSharpSourceCode.CSharp.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromCSharpSourceCode.CSharp.html.view.verified.json index e37a1e08637..3d28397b73e 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromCSharpSourceCode.CSharp.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromCSharpSourceCode.CSharp.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromCSharpSourceCode

    \n
    public class CSharp\n
    \n
    Inheritance
    \n

    object ←\nCSharp

    \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

    Main(string[])

    \n
    public static void Main(string[] args)\n
    \n

    Parameters

    \n

    args string[]

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

    Namespace: BuildFromCSharpSourceCode

    \n
    public class CSharp\n
    \n

    Inheritance

    \n

    object ←\nCSharp

    \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

    Main(string[])

    \n
    public static void Main(string[] args)\n
    \n

    Parameters

    \n

    args string[]

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class CSharp

    ", - "title": "Class CSharp", + "rawTitle": "

    Class CSharp

    ", + "title": " Class CSharp", "wordCount": 30.0, "_key": "obj/md/BuildFromCSharpSourceCode.CSharp.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromCSharpSourceCode.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromCSharpSourceCode.html.view.verified.json index d8c059676c4..39a4a173c27 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromCSharpSourceCode.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromCSharpSourceCode.html.view.verified.json @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Namespace BuildFromCSharpSourceCode

    ", - "title": "Namespace BuildFromCSharpSourceCode", + "rawTitle": "

    Namespace BuildFromCSharpSourceCode

    ", + "title": " Namespace BuildFromCSharpSourceCode", "wordCount": 2.0, "_key": "obj/md/BuildFromCSharpSourceCode.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.IIssue8948.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.IIssue8948.html.view.verified.json index 22b89a266b7..e9f1469d31d 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.IIssue8948.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.IIssue8948.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public interface Class1.IIssue8948\n
    \n

    Methods

    \n

    DoNothing<T>()

    \n

    Does nothing with generic type T.

    \n
    void DoNothing<T>()\n
    \n

    Type Parameters

    \n

    T

    \n

    A generic type.

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

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public interface Class1.IIssue8948\n
    \n

    Methods

    \n

    DoNothing<T>()

    \n

    Does nothing with generic type T.

    \n
    void DoNothing<T>()\n
    \n

    Type Parameters

    \n

    T

    \n

    A generic type.

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Interface Class1.IIssue8948

    ", - "title": "Interface Class1.IIssue8948", + "rawTitle": "

    Interface Class1.IIssue8948

    ", + "title": " Interface Class1.IIssue8948", "wordCount": 23.0, "_key": "obj/md/BuildFromProject.Class1.IIssue8948.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.Issue8665.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.Issue8665.html.view.verified.json index ea8d9ffd9b8..4aaf78963d3 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.Issue8665.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.Issue8665.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Class1.Issue8665\n
    \n
    Inheritance
    \n

    object ←\nClass1.Issue8665

    \n
    Inherited Members
    \n

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

    \n

    Constructors

    \n

    Issue8665()

    \n
    public Issue8665()\n
    \n

    Issue8665(int)

    \n
    public Issue8665(int foo)\n
    \n

    Parameters

    \n

    foo int

    \n

    Issue8665(int, char)

    \n
    public Issue8665(int foo, char bar)\n
    \n

    Parameters

    \n

    foo int

    \n

    bar char

    \n

    Issue8665(int, char, string)

    \n
    public Issue8665(int foo, char bar, string baz)\n
    \n

    Parameters

    \n

    foo int

    \n

    bar char

    \n

    baz string

    \n

    Properties

    \n

    Bar

    \n
    public char Bar { get; }\n
    \n

    Property Value

    \n

    char

    \n

    Baz

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

    Property Value

    \n

    string

    \n

    Foo

    \n
    public int Foo { get; }\n
    \n

    Property Value

    \n

    int

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

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Class1.Issue8665\n
    \n

    Inheritance

    \n

    object ←\nClass1.Issue8665

    \n

    Inherited Members

    \n

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

    \n

    Constructors

    \n

    Issue8665()

    \n
    public Issue8665()\n
    \n

    Issue8665(int)

    \n
    public Issue8665(int foo)\n
    \n

    Parameters

    \n

    foo int

    \n

    Issue8665(int, char)

    \n
    public Issue8665(int foo, char bar)\n
    \n

    Parameters

    \n

    foo int

    \n

    bar char

    \n

    Issue8665(int, char, string)

    \n
    public Issue8665(int foo, char bar, string baz)\n
    \n

    Parameters

    \n

    foo int

    \n

    bar char

    \n

    baz string

    \n

    Properties

    \n

    Bar

    \n
    public char Bar { get; }\n
    \n

    Property Value

    \n

    char

    \n

    Baz

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

    Property Value

    \n

    string

    \n

    Foo

    \n
    public int Foo { get; }\n
    \n

    Property Value

    \n

    int

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class Class1.Issue8665

    ", - "title": "Class Class1.Issue8665", + "rawTitle": "

    Class Class1.Issue8665

    ", + "title": " Class Class1.Issue8665", "wordCount": 93.0, "_key": "obj/md/BuildFromProject.Class1.Issue8665.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.Issue8696Attribute.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.Issue8696Attribute.html.view.verified.json index 622620b3ed9..02a4754dacb 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.Issue8696Attribute.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.Issue8696Attribute.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Class1.Issue8696Attribute : Attribute\n
    \n
    Inheritance
    \n

    object ←\nAttribute ←\nClass1.Issue8696Attribute

    \n
    Inherited Members
    \n

    Attribute.Equals(object?),\nAttribute.GetCustomAttribute(Assembly, Type),\nAttribute.GetCustomAttribute(Assembly, Type, bool),\nAttribute.GetCustomAttribute(MemberInfo, Type),\nAttribute.GetCustomAttribute(MemberInfo, Type, bool),\nAttribute.GetCustomAttribute(Module, Type),\nAttribute.GetCustomAttribute(Module, Type, bool),\nAttribute.GetCustomAttribute(ParameterInfo, Type),\nAttribute.GetCustomAttribute(ParameterInfo, Type, bool),\nAttribute.GetCustomAttributes(Assembly),\nAttribute.GetCustomAttributes(Assembly, bool),\nAttribute.GetCustomAttributes(Assembly, Type),\nAttribute.GetCustomAttributes(Assembly, Type, bool),\nAttribute.GetCustomAttributes(MemberInfo),\nAttribute.GetCustomAttributes(MemberInfo, bool),\nAttribute.GetCustomAttributes(MemberInfo, Type),\nAttribute.GetCustomAttributes(MemberInfo, Type, bool),\nAttribute.GetCustomAttributes(Module),\nAttribute.GetCustomAttributes(Module, bool),\nAttribute.GetCustomAttributes(Module, Type),\nAttribute.GetCustomAttributes(Module, Type, bool),\nAttribute.GetCustomAttributes(ParameterInfo),\nAttribute.GetCustomAttributes(ParameterInfo, bool),\nAttribute.GetCustomAttributes(ParameterInfo, Type),\nAttribute.GetCustomAttributes(ParameterInfo, Type, bool),\nAttribute.GetHashCode(),\nAttribute.IsDefaultAttribute(),\nAttribute.IsDefined(Assembly, Type),\nAttribute.IsDefined(Assembly, Type, bool),\nAttribute.IsDefined(MemberInfo, Type),\nAttribute.IsDefined(MemberInfo, Type, bool),\nAttribute.IsDefined(Module, Type),\nAttribute.IsDefined(Module, Type, bool),\nAttribute.IsDefined(ParameterInfo, Type),\nAttribute.IsDefined(ParameterInfo, Type, bool),\nAttribute.Match(object?),\nAttribute.TypeId,\nobject.Equals(object?),\nobject.Equals(object?, object?),\nobject.GetHashCode(),\nobject.GetType(),\nobject.MemberwiseClone(),\nobject.ReferenceEquals(object?, object?),\nobject.ToString()

    \n

    Constructors

    \n

    Issue8696Attribute(string?, int, int, string[]?, bool, Type?)

    \n
    [Class1.Issue8696("Changes the name of the server in the server list", 0, 0, null, false, null)]\npublic Issue8696Attribute(string? description = null, int boundsMin = 0, int boundsMax = 0, string[]? validGameModes = null, bool hasMultipleSelections = false, Type? enumType = null)\n
    \n

    Parameters

    \n

    description string?

    \n

    boundsMin int

    \n

    boundsMax int

    \n

    validGameModes string[]?

    \n

    hasMultipleSelections bool

    \n

    enumType Type?

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

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Class1.Issue8696Attribute : Attribute\n
    \n

    Inheritance

    \n

    object ←\nAttribute ←\nClass1.Issue8696Attribute

    \n

    Inherited Members

    \n

    Attribute.Equals(object?),\nAttribute.GetCustomAttribute(Assembly, Type),\nAttribute.GetCustomAttribute(Assembly, Type, bool),\nAttribute.GetCustomAttribute(MemberInfo, Type),\nAttribute.GetCustomAttribute(MemberInfo, Type, bool),\nAttribute.GetCustomAttribute(Module, Type),\nAttribute.GetCustomAttribute(Module, Type, bool),\nAttribute.GetCustomAttribute(ParameterInfo, Type),\nAttribute.GetCustomAttribute(ParameterInfo, Type, bool),\nAttribute.GetCustomAttributes(Assembly),\nAttribute.GetCustomAttributes(Assembly, bool),\nAttribute.GetCustomAttributes(Assembly, Type),\nAttribute.GetCustomAttributes(Assembly, Type, bool),\nAttribute.GetCustomAttributes(MemberInfo),\nAttribute.GetCustomAttributes(MemberInfo, bool),\nAttribute.GetCustomAttributes(MemberInfo, Type),\nAttribute.GetCustomAttributes(MemberInfo, Type, bool),\nAttribute.GetCustomAttributes(Module),\nAttribute.GetCustomAttributes(Module, bool),\nAttribute.GetCustomAttributes(Module, Type),\nAttribute.GetCustomAttributes(Module, Type, bool),\nAttribute.GetCustomAttributes(ParameterInfo),\nAttribute.GetCustomAttributes(ParameterInfo, bool),\nAttribute.GetCustomAttributes(ParameterInfo, Type),\nAttribute.GetCustomAttributes(ParameterInfo, Type, bool),\nAttribute.GetHashCode(),\nAttribute.IsDefaultAttribute(),\nAttribute.IsDefined(Assembly, Type),\nAttribute.IsDefined(Assembly, Type, bool),\nAttribute.IsDefined(MemberInfo, Type),\nAttribute.IsDefined(MemberInfo, Type, bool),\nAttribute.IsDefined(Module, Type),\nAttribute.IsDefined(Module, Type, bool),\nAttribute.IsDefined(ParameterInfo, Type),\nAttribute.IsDefined(ParameterInfo, Type, bool),\nAttribute.Match(object?),\nAttribute.TypeId,\nobject.Equals(object?),\nobject.Equals(object?, object?),\nobject.GetHashCode(),\nobject.GetType(),\nobject.MemberwiseClone(),\nobject.ReferenceEquals(object?, object?),\nobject.ToString()

    \n

    Constructors

    \n

    Issue8696Attribute(string?, int, int, string[]?, bool, Type?)

    \n
    [Class1.Issue8696("Changes the name of the server in the server list", 0, 0, null, false, null)]\npublic Issue8696Attribute(string? description = null, int boundsMin = 0, int boundsMax = 0, string[]? validGameModes = null, bool hasMultipleSelections = false, Type? enumType = null)\n
    \n

    Parameters

    \n

    description string?

    \n

    boundsMin int

    \n

    boundsMax int

    \n

    validGameModes string[]?

    \n

    hasMultipleSelections bool

    \n

    enumType Type?

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class Class1.Issue8696Attribute

    ", - "title": "Class Class1.Issue8696Attribute", + "rawTitle": "

    Class Class1.Issue8696Attribute

    ", + "title": " Class Class1.Issue8696Attribute", "wordCount": 162.0, "_key": "obj/md/BuildFromProject.Class1.Issue8696Attribute.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.Issue8948.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.Issue8948.html.view.verified.json index c3319383465..4cf0456fdd4 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.Issue8948.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.Issue8948.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Class1.Issue8948 : Class1.IIssue8948\n
    \n
    Inheritance
    \n

    object ←\nClass1.Issue8948

    \n
    Implements
    \n

    Class1.IIssue8948

    \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

    DoNothing<T>()

    \n

    Does nothing with generic type T.

    \n
    public void DoNothing<T>()\n
    \n

    Type Parameters

    \n

    T

    \n

    A generic type.

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

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Class1.Issue8948 : Class1.IIssue8948\n
    \n

    Inheritance

    \n

    object ←\nClass1.Issue8948

    \n

    Implements

    \n

    Class1.IIssue8948

    \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

    DoNothing<T>()

    \n

    Does nothing with generic type T.

    \n
    public void DoNothing<T>()\n
    \n

    Type Parameters

    \n

    T

    \n

    A generic type.

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class Class1.Issue8948

    ", - "title": "Class Class1.Issue8948", + "rawTitle": "

    Class Class1.Issue8948

    ", + "title": " Class Class1.Issue8948", "wordCount": 42.0, "_key": "obj/md/BuildFromProject.Class1.Issue8948.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.Test-1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.Test-1.html.view.verified.json index ccccfd2f9a7..02b3a4a535b 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.Test-1.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.Test-1.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Class1.Test<T>\n
    \n

    Type Parameters

    \n

    T

    \n
    Inheritance
    \n

    object ←\nClass1.Test<T>

    \n
    Inherited Members
    \n

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

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

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Class1.Test<T>\n
    \n

    Type Parameters

    \n

    T

    \n

    Inheritance

    \n

    object ←\nClass1.Test<T>

    \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": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class Class1.Test<T>

    ", - "title": "Class Class1.Test", + "rawTitle": "

    Class Class1.Test<T>

    ", + "title": " Class Class1.Test", "wordCount": 25.0, "_key": "obj/md/BuildFromProject.Class1.Test-1.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.html.view.verified.json index b8f308dd4e6..616670b9786 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Class1 : IClass1\n
    \n
    Inheritance
    \n

    object ←\nClass1

    \n
    Implements
    \n

    IClass1

    \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

    Issue1651()

    \n

    Pricing models are used to calculate theoretical option values

    \n
    • 1Black Scholes
    • 2Black76
    • 3Black76Fut
    • 4Equity Tree
    • 5Variance Swap
    • 6Dividend Forecast
    \n
    public void Issue1651()\n
    \n

    Issue1887()

    \n

    IConfiguration related helper and extension routines.

    \n
    public void Issue1887()\n
    \n

    Issue2623()

    \n
    public void Issue2623()\n
    \n

    Examples

    \n
    MyClass myClass = new MyClass();\n\nvoid Update()\n{\n    myClass.Execute();\n}\n
    \n

    Remarks

    \n

    For example:

    \n
    MyClass myClass = new MyClass();\n\nvoid Update()\n{\n    myClass.Execute();\n}\n
    \n

    Issue2723()

    \n
    public void Issue2723()\n
    \n

    Remarks

    \n
    \n
    Note
    \n

    This is a <note>. & " '

    \n
    \n

    Inline <angle brackets>.

    \n

    link

    \n
    for (var i = 0; i > 10; i++) // & " '\nvar range = new Range<int> { Min = 0, Max = 10 };\n
    \n
    var range = new Range<int> { Min = 0, Max = 10 };
    \n

    Issue4017()

    \n
    public void Issue4017()\n
    \n

    Examples

    \n
    public void HookMessageDeleted(BaseSocketClient client)\n{\n    client.MessageDeleted += HandleMessageDelete;\n}\n\npublic Task HandleMessageDelete(Cacheable<IMessage, ulong> cachedMessage, ISocketMessageChannel channel)\n{\n    // check if the message exists in cache; if not, we cannot report what was removed\n    if (!cachedMessage.HasValue) return;\n    var message = cachedMessage.Value;\n    Console.WriteLine($\"A message ({message.Id}) from {message.Author} was removed from the channel {channel.Name} ({channel.Id}):\"\n        + Environment.NewLine\n        + message.Content);\n    return Task.CompletedTask;\n}
    \n

    Remarks

    \n
    void Update()\n{\n    myClass.Execute();\n}
    \n

    Issue4392()

    \n
    public void Issue4392()\n
    \n

    Remarks

    \n

    @"\\\\?\\"

    \n

    Issue7484()

    \n
    public void Issue7484()\n
    \n

    Remarks

    \n

    There's really no reason to not believe that this class can test things.

    \n
    TermDescription
    A TermA Description
    Bee TermBee Description
    \n

    Issue8764<T>()

    \n
    public void Issue8764<T>() where T : unmanaged\n
    \n

    Type Parameters

    \n

    T

    \n

    Issue896()

    \n

    Test

    \n
    public void Issue896()\n
    \n

    See Also

    \n

    Class1.Test<T>
    \nClass1

    \n

    Issue9216()

    \n

    Calculates the determinant of a 3-dimensional matrix:

    \n

    \\(A = \\begin{vmatrix} a_{11} & a_{12} & a_{13} \\\\ a_{21} & a_{22} & a_{23} \\\\ a_{31} & a_{32} & a_{33} \\end{vmatrix}\\)

    \n

    Returns the smallest value:

    \n

    \\(\\left\\{\\begin{matrix}a, a<b \\\\ b, b>a\\\\ \\end{matrix} \\right.\\)

    \n
    public static double Issue9216()\n
    \n

    Returns

    \n

    double

    \n

    XmlCommentIncludeTag()

    \n

    This method should do something...

    \n
    public void XmlCommentIncludeTag()\n
    \n

    Remarks

    \n

    This is remarks.

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

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Class1 : IClass1\n
    \n

    Inheritance

    \n

    object ←\nClass1

    \n

    Implements

    \n

    IClass1

    \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

    Issue1651()

    \n

    Pricing models are used to calculate theoretical option values

    \n
    • 1Black Scholes
    • 2Black76
    • 3Black76Fut
    • 4Equity Tree
    • 5Variance Swap
    • 6Dividend Forecast
    \n
    public void Issue1651()\n
    \n

    Issue1887()

    \n

    IConfiguration related helper and extension routines.

    \n
    public void Issue1887()\n
    \n

    Issue2623()

    \n
    public void Issue2623()\n
    \n

    Examples

    \n
    MyClass myClass = new MyClass();\n\nvoid Update()\n{\n    myClass.Execute();\n}\n
    \n

    Remarks

    \n

    For example:

    \n
    MyClass myClass = new MyClass();\n\nvoid Update()\n{\n    myClass.Execute();\n}\n
    \n

    Issue2723()

    \n
    public void Issue2723()\n
    \n

    Remarks

    \n
    \n
    Note
    \n

    This is a <note>. & " '

    \n
    \n

    Inline <angle brackets>.

    \n

    link

    \n
    for (var i = 0; i > 10; i++) // & " '\nvar range = new Range<int> { Min = 0, Max = 10 };\n
    \n
    var range = new Range<int> { Min = 0, Max = 10 };
    \n

    Issue4017()

    \n
    public void Issue4017()\n
    \n

    Examples

    \n
    public void HookMessageDeleted(BaseSocketClient client)\n{\n    client.MessageDeleted += HandleMessageDelete;\n}\n\npublic Task HandleMessageDelete(Cacheable<IMessage, ulong> cachedMessage, ISocketMessageChannel channel)\n{\n    // check if the message exists in cache; if not, we cannot report what was removed\n    if (!cachedMessage.HasValue) return;\n    var message = cachedMessage.Value;\n    Console.WriteLine($\"A message ({message.Id}) from {message.Author} was removed from the channel {channel.Name} ({channel.Id}):\"\n        + Environment.NewLine\n        + message.Content);\n    return Task.CompletedTask;\n}
    \n

    Remarks

    \n
    void Update()\n{\n    myClass.Execute();\n}
    \n

    Issue4392()

    \n
    public void Issue4392()\n
    \n

    Remarks

    \n

    @"\\\\?\\"

    \n

    Issue7484()

    \n
    public void Issue7484()\n
    \n

    Remarks

    \n

    There's really no reason to not believe that this class can test things.

    \n
    TermDescription
    A TermA Description
    Bee TermBee Description
    \n

    Issue8764<T>()

    \n
    public void Issue8764<T>() where T : unmanaged\n
    \n

    Type Parameters

    \n

    T

    \n

    Issue896()

    \n

    Test

    \n
    public void Issue896()\n
    \n

    See Also

    \n

    Class1.Test<T>,\nClass1

    \n

    Issue9216()

    \n

    Calculates the determinant of a 3-dimensional matrix:

    \n

    \\(A = \\begin{vmatrix} a_{11} & a_{12} & a_{13} \\\\ a_{21} & a_{22} & a_{23} \\\\ a_{31} & a_{32} & a_{33} \\end{vmatrix}\\)

    \n

    Returns the smallest value:

    \n

    \\(\\left\\{\\begin{matrix}a, a<b \\\\ b, b>a\\\\ \\end{matrix} \\right.\\)

    \n
    public static double Issue9216()\n
    \n

    Returns

    \n

    double

    \n

    XmlCommentIncludeTag()

    \n

    This method should do something...

    \n
    public void XmlCommentIncludeTag()\n
    \n

    Remarks

    \n

    This is remarks.

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class Class1

    ", - "title": "Class Class1", + "rawTitle": "

    Class Class1

    ", + "title": " Class Class1", "wordCount": 333.0, "_key": "obj/md/BuildFromProject.Class1.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.IInheritdoc.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.IInheritdoc.html.view.verified.json index e4333b0d86e..e6133069ab9 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.IInheritdoc.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.IInheritdoc.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public interface IInheritdoc\n
    \n

    Methods

    \n

    Issue7629()

    \n

    This method should do something...

    \n
    void Issue7629()\n
    \n", + "conceptual": "\n

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public interface IInheritdoc\n
    \n

    Methods

    \n

    Issue7629()

    \n

    This method should do something...

    \n
    void Issue7629()\n
    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Interface IInheritdoc

    ", - "title": "Interface IInheritdoc", + "rawTitle": "

    Interface IInheritdoc

    ", + "title": " Interface IInheritdoc", "wordCount": 16.0, "_key": "obj/md/BuildFromProject.IInheritdoc.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue6366.Class1-1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue6366.Class1-1.html.view.verified.json index 792a838e48a..186d80aa0b2 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue6366.Class1-1.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue6366.Class1-1.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public abstract class Inheritdoc.Issue6366.Class1<T>\n
    \n

    Type Parameters

    \n

    T

    \n
    Inheritance
    \n

    object ←\nInheritdoc.Issue6366.Class1<T>

    \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

    TestMethod1(T, int)

    \n

    This text inherited.

    \n
    public abstract T TestMethod1(T parm1, int parm2)\n
    \n

    Parameters

    \n

    parm1 T

    \n

    This text NOT inherited.

    \n

    parm2 int

    \n

    This text inherited.

    \n

    Returns

    \n

    T

    \n

    This text inherited.

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

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public abstract class Inheritdoc.Issue6366.Class1<T>\n
    \n

    Type Parameters

    \n

    T

    \n

    Inheritance

    \n

    object ←\nInheritdoc.Issue6366.Class1<T>

    \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

    TestMethod1(T, int)

    \n

    This text inherited.

    \n
    public abstract T TestMethod1(T parm1, int parm2)\n
    \n

    Parameters

    \n

    parm1 T

    \n

    This text NOT inherited.

    \n

    parm2 int

    \n

    This text inherited.

    \n

    Returns

    \n

    T

    \n

    This text inherited.

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class Inheritdoc.Issue6366.Class1<T>

    ", - "title": "Class Inheritdoc.Issue6366.Class1", + "rawTitle": "

    Class Inheritdoc.Issue6366.Class1<T>

    ", + "title": " Class Inheritdoc.Issue6366.Class1", "wordCount": 56.0, "_key": "obj/md/BuildFromProject.Inheritdoc.Issue6366.Class1-1.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue6366.Class2.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue6366.Class2.html.view.verified.json index f981b862130..72843c61be3 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue6366.Class2.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue6366.Class2.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Inheritdoc.Issue6366.Class2 : Inheritdoc.Issue6366.Class1<bool>\n
    \n
    Inheritance
    \n

    object ←\nInheritdoc.Issue6366.Class1<bool> ←\nInheritdoc.Issue6366.Class2

    \n
    Inherited Members
    \n

    Inheritdoc.Issue6366.Class1<bool>.TestMethod1(bool, int),\nobject.Equals(object?),\nobject.Equals(object?, object?),\nobject.GetHashCode(),\nobject.GetType(),\nobject.MemberwiseClone(),\nobject.ReferenceEquals(object?, object?),\nobject.ToString()

    \n

    Methods

    \n

    TestMethod1(bool, int)

    \n

    This text inherited.

    \n
    public override bool TestMethod1(bool parm1, int parm2)\n
    \n

    Parameters

    \n

    parm1 bool

    \n

    This text NOT inherited.

    \n

    parm2 int

    \n

    This text inherited.

    \n

    Returns

    \n

    bool

    \n

    This text inherited.

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

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Inheritdoc.Issue6366.Class2 : Inheritdoc.Issue6366.Class1<bool>\n
    \n

    Inheritance

    \n

    object ←\nInheritdoc.Issue6366.Class1<bool> ←\nInheritdoc.Issue6366.Class2

    \n

    Inherited Members

    \n

    Inheritdoc.Issue6366.Class1<bool>.TestMethod1(bool, int),\nobject.Equals(object?),\nobject.Equals(object?, object?),\nobject.GetHashCode(),\nobject.GetType(),\nobject.MemberwiseClone(),\nobject.ReferenceEquals(object?, object?),\nobject.ToString()

    \n

    Methods

    \n

    TestMethod1(bool, int)

    \n

    This text inherited.

    \n
    public override bool TestMethod1(bool parm1, int parm2)\n
    \n

    Parameters

    \n

    parm1 bool

    \n

    This text NOT inherited.

    \n

    parm2 int

    \n

    This text inherited.

    \n

    Returns

    \n

    bool

    \n

    This text inherited.

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class Inheritdoc.Issue6366.Class2

    ", - "title": "Class Inheritdoc.Issue6366.Class2", + "rawTitle": "

    Class Inheritdoc.Issue6366.Class2

    ", + "title": " Class Inheritdoc.Issue6366.Class2", "wordCount": 57.0, "_key": "obj/md/BuildFromProject.Inheritdoc.Issue6366.Class2.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue6366.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue6366.html.view.verified.json index 1c31b99b55b..555d2e8831f 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue6366.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue6366.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Inheritdoc.Issue6366\n
    \n
    Inheritance
    \n

    object ←\nInheritdoc.Issue6366

    \n
    Inherited Members
    \n

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

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

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Inheritdoc.Issue6366\n
    \n

    Inheritance

    \n

    object ←\nInheritdoc.Issue6366

    \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": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class Inheritdoc.Issue6366

    ", - "title": "Class Inheritdoc.Issue6366", + "rawTitle": "

    Class Inheritdoc.Issue6366

    ", + "title": " Class Inheritdoc.Issue6366", "wordCount": 22.0, "_key": "obj/md/BuildFromProject.Inheritdoc.Issue6366.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue7035.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue7035.html.view.verified.json index 61c0bb597b3..ae38ac83e90 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue7035.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue7035.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Inheritdoc.Issue7035\n
    \n
    Inheritance
    \n

    object ←\nInheritdoc.Issue7035

    \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

    A()

    \n
    public void A()\n
    \n

    B()

    \n
    public void B()\n
    \n", + "conceptual": "\n

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Inheritdoc.Issue7035\n
    \n

    Inheritance

    \n

    object ←\nInheritdoc.Issue7035

    \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

    A()

    \n
    public void A()\n
    \n

    B()

    \n
    public void B()\n
    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class Inheritdoc.Issue7035

    ", - "title": "Class Inheritdoc.Issue7035", + "rawTitle": "

    Class Inheritdoc.Issue7035

    ", + "title": " Class Inheritdoc.Issue7035", "wordCount": 31.0, "_key": "obj/md/BuildFromProject.Inheritdoc.Issue7035.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue7484.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue7484.html.view.verified.json index dc82e879783..9db1be245b9 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue7484.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue7484.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n

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

    \n
    public class Inheritdoc.Issue7484\n
    \n
    Inheritance
    \n

    object ←\nInheritdoc.Issue7484

    \n
    Inherited Members
    \n

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

    \n

    Remarks

    \n

    We're going to talk about things now.

    \n
    \nSimple method to generate docs for.\n
    \nA string that could have something.\n
    \n

    Constructors

    \n

    Issue7484()

    \n

    This is a constructor to document.

    \n
    public Issue7484()\n
    \n

    Properties

    \n

    DoDad

    \n

    A string that could have something.

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

    Property Value

    \n

    string

    \n

    Methods

    \n

    BoolReturningMethod(bool)

    \n

    Simple method to generate docs for.

    \n
    public bool BoolReturningMethod(bool source)\n
    \n

    Parameters

    \n

    source bool

    \n

    A meaningless boolean value, much like most questions in the world.

    \n

    Returns

    \n

    bool

    \n

    An exactly equivalently meaningless boolean value, much like most answers in the world.

    \n

    Remarks

    \n

    I'd like to take a moment to thank all of those who helped me get to\na place where I can write documentation like this.

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

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n

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

    \n
    public class Inheritdoc.Issue7484\n
    \n

    Inheritance

    \n

    object ←\nInheritdoc.Issue7484

    \n

    Inherited Members

    \n

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

    \n

    Remarks

    \n

    We're going to talk about things now.

    \n
    \nSimple method to generate docs for.\n
    \nA string that could have something.\n
    \n

    Constructors

    \n

    Issue7484()

    \n

    This is a constructor to document.

    \n
    public Issue7484()\n
    \n

    Properties

    \n

    DoDad

    \n

    A string that could have something.

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

    Property Value

    \n

    string

    \n

    Methods

    \n

    BoolReturningMethod(bool)

    \n

    Simple method to generate docs for.

    \n
    public bool BoolReturningMethod(bool source)\n
    \n

    Parameters

    \n

    source bool

    \n

    A meaningless boolean value, much like most questions in the world.

    \n

    Returns

    \n

    bool

    \n

    An exactly equivalently meaningless boolean value, much like most answers in the world.

    \n

    Remarks

    \n

    I'd like to take a moment to thank all of those who helped me get to\na place where I can write documentation like this.

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class Inheritdoc.Issue7484

    ", - "title": "Class Inheritdoc.Issue7484", + "rawTitle": "

    Class Inheritdoc.Issue7484

    ", + "title": " Class Inheritdoc.Issue7484", "wordCount": 148.0, "_key": "obj/md/BuildFromProject.Inheritdoc.Issue7484.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue8101.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue8101.html.view.verified.json index b020c80810f..949f541ad14 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue8101.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue8101.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Inheritdoc.Issue8101\n
    \n
    Inheritance
    \n

    object ←\nInheritdoc.Issue8101

    \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

    Tween(float, float, float, Action<float>)

    \n

    Create a new tween.

    \n
    public static object Tween(float from, float to, float duration, Action<float> onChange)\n
    \n

    Parameters

    \n

    from float

    \n

    The starting value.

    \n

    to float

    \n

    The end value.

    \n

    duration float

    \n

    Total tween duration in seconds.

    \n

    onChange Action<float>

    \n

    A callback that will be invoked every time the tween value changes.

    \n

    Returns

    \n

    object

    \n

    The newly created tween instance.

    \n

    Tween(int, int, float, Action<int>)

    \n

    Create a new tween.

    \n
    public static object Tween(int from, int to, float duration, Action<int> onChange)\n
    \n

    Parameters

    \n

    from int

    \n

    The starting value.

    \n

    to int

    \n

    The end value.

    \n

    duration float

    \n

    Total tween duration in seconds.

    \n

    onChange Action<int>

    \n

    A callback that will be invoked every time the tween value changes.

    \n

    Returns

    \n

    object

    \n

    The newly created tween instance.

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

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Inheritdoc.Issue8101\n
    \n

    Inheritance

    \n

    object ←\nInheritdoc.Issue8101

    \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

    Tween(float, float, float, Action<float>)

    \n

    Create a new tween.

    \n
    public static object Tween(float from, float to, float duration, Action<float> onChange)\n
    \n

    Parameters

    \n

    from float

    \n

    The starting value.

    \n

    to float

    \n

    The end value.

    \n

    duration float

    \n

    Total tween duration in seconds.

    \n

    onChange Action<float>

    \n

    A callback that will be invoked every time the tween value changes.

    \n

    Returns

    \n

    object

    \n

    The newly created tween instance.

    \n

    Tween(int, int, float, Action<int>)

    \n

    Create a new tween.

    \n
    public static object Tween(int from, int to, float duration, Action<int> onChange)\n
    \n

    Parameters

    \n

    from int

    \n

    The starting value.

    \n

    to int

    \n

    The end value.

    \n

    duration float

    \n

    Total tween duration in seconds.

    \n

    onChange Action<int>

    \n

    A callback that will be invoked every time the tween value changes.

    \n

    Returns

    \n

    object

    \n

    The newly created tween instance.

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class Inheritdoc.Issue8101

    ", - "title": "Class Inheritdoc.Issue8101", + "rawTitle": "

    Class Inheritdoc.Issue8101

    ", + "title": " Class Inheritdoc.Issue8101", "wordCount": 143.0, "_key": "obj/md/BuildFromProject.Inheritdoc.Issue8101.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue8129.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue8129.html.view.verified.json index 355bcc54538..76003641fdd 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue8129.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.Issue8129.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public struct Inheritdoc.Issue8129\n
    \n
    Inherited Members
    \n

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

    \n

    Constructors

    \n

    Issue8129(string)

    \n
    public Issue8129(string foo)\n
    \n

    Parameters

    \n

    foo string

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

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public struct Inheritdoc.Issue8129\n
    \n

    Inherited Members

    \n

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

    \n

    Constructors

    \n

    Issue8129(string)

    \n
    public Issue8129(string foo)\n
    \n

    Parameters

    \n

    foo string

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Struct Inheritdoc.Issue8129

    ", - "title": "Struct Inheritdoc.Issue8129", + "rawTitle": "

    Struct Inheritdoc.Issue8129

    ", + "title": " Struct Inheritdoc.Issue8129", "wordCount": 25.0, "_key": "obj/md/BuildFromProject.Inheritdoc.Issue8129.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.html.view.verified.json index 9563d728918..c0e33aff31e 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Inheritdoc.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Inheritdoc : IInheritdoc, IDisposable\n
    \n
    Inheritance
    \n

    object ←\nInheritdoc

    \n
    Implements
    \n

    IInheritdoc,\nIDisposable

    \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

    Dispose()

    \n

    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

    \n
    public void Dispose()\n
    \n

    Issue7628()

    \n

    This method should do something...

    \n
    public void Issue7628()\n
    \n

    Issue7629()

    \n

    This method should do something...

    \n
    public void Issue7629()\n
    \n", + "conceptual": "\n

    Namespace: BuildFromProject
    \nAssembly: BuildFromProject.dll

    \n
    public class Inheritdoc : IInheritdoc, IDisposable\n
    \n

    Inheritance

    \n

    object ←\nInheritdoc

    \n

    Implements

    \n

    IInheritdoc,\nIDisposable

    \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

    Dispose()

    \n

    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

    \n
    public void Dispose()\n
    \n

    Issue7628()

    \n

    This method should do something...

    \n
    public void Issue7628()\n
    \n

    Issue7629()

    \n

    This method should do something...

    \n
    public void Issue7629()\n
    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class Inheritdoc

    ", - "title": "Class Inheritdoc", + "rawTitle": "

    Class Inheritdoc

    ", + "title": " Class Inheritdoc", "wordCount": 61.0, "_key": "obj/md/BuildFromProject.Inheritdoc.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.A.A.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.A.A.html.view.verified.json index 293b676e1d2..131e9288899 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.A.A.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.A.A.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromProject.Issue8540.A
    \nAssembly: BuildFromProject.dll

    \n
    public class A\n
    \n
    Inheritance
    \n

    object ←\nA

    \n
    Inherited Members
    \n

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

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

    Namespace: BuildFromProject.Issue8540.A
    \nAssembly: BuildFromProject.dll

    \n
    public class A\n
    \n

    Inheritance

    \n

    object ←\nA

    \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": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class A

    ", - "title": "Class A", + "rawTitle": "

    Class A

    ", + "title": " Class A", "wordCount": 22.0, "_key": "obj/md/BuildFromProject.Issue8540.A.A.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.A.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.A.html.view.verified.json index c16fe6040e2..f63612cd3d1 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.A.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.A.html.view.verified.json @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Namespace BuildFromProject.Issue8540.A

    ", - "title": "Namespace BuildFromProject.Issue8540.A", + "rawTitle": "

    Namespace BuildFromProject.Issue8540.A

    ", + "title": " Namespace BuildFromProject.Issue8540.A", "wordCount": 2.0, "_key": "obj/md/BuildFromProject.Issue8540.A.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.B.B.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.B.B.html.view.verified.json index c676d12d7dc..ce22595dbb5 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.B.B.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.B.B.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromProject.Issue8540.B
    \nAssembly: BuildFromProject.dll

    \n
    public class B\n
    \n
    Inheritance
    \n

    object ←\nB

    \n
    Inherited Members
    \n

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

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

    Namespace: BuildFromProject.Issue8540.B
    \nAssembly: BuildFromProject.dll

    \n
    public class B\n
    \n

    Inheritance

    \n

    object ←\nB

    \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": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class B

    ", - "title": "Class B", + "rawTitle": "

    Class B

    ", + "title": " Class B", "wordCount": 22.0, "_key": "obj/md/BuildFromProject.Issue8540.B.B.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.B.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.B.html.view.verified.json index c43b153f2d1..822d9f76c1f 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.B.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.B.html.view.verified.json @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Namespace BuildFromProject.Issue8540.B

    ", - "title": "Namespace BuildFromProject.Issue8540.B", + "rawTitle": "

    Namespace BuildFromProject.Issue8540.B

    ", + "title": " Namespace BuildFromProject.Issue8540.B", "wordCount": 2.0, "_key": "obj/md/BuildFromProject.Issue8540.B.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.html.view.verified.json index 7e0722e2d89..135fbddf930 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Issue8540.html.view.verified.json @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Namespace BuildFromProject.Issue8540

    ", - "title": "Namespace BuildFromProject.Issue8540", + "rawTitle": "

    Namespace BuildFromProject.Issue8540

    ", + "title": " Namespace BuildFromProject.Issue8540", "wordCount": 3.0, "_key": "obj/md/BuildFromProject.Issue8540.md", "_navKey": "~/toc.yml", 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 848ab83298b..552bd332237 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 @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Namespace BuildFromProject

    ", - "title": "Namespace BuildFromProject", + "rawTitle": "

    Namespace BuildFromProject

    ", + "title": " Namespace BuildFromProject", "wordCount": 32.0, "_key": "obj/md/BuildFromProject.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromVBSourceCode.BaseClass1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromVBSourceCode.BaseClass1.html.view.verified.json index 1856c4a0de7..ab0d2aafb1c 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromVBSourceCode.BaseClass1.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromVBSourceCode.BaseClass1.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromVBSourceCode

    \n

    This is the BaseClass

    \n
    public abstract class BaseClass1\n
    \n
    Inheritance
    \n

    object ←\nBaseClass1

    \n
    Derived
    \n

    Class1

    \n
    Inherited Members
    \n

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

    \n

    Methods

    \n

    WithDeclarationKeyword(Class1)

    \n
    public abstract DateTime WithDeclarationKeyword(Class1 keyword)\n
    \n

    Parameters

    \n

    keyword Class1

    \n

    Returns

    \n

    DateTime

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

    Namespace: BuildFromVBSourceCode

    \n

    This is the BaseClass

    \n
    public abstract class BaseClass1\n
    \n

    Inheritance

    \n

    object ←\nBaseClass1

    \n

    Derived

    \n

    Class1

    \n

    Inherited Members

    \n

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

    \n

    Methods

    \n

    WithDeclarationKeyword(Class1)

    \n
    public abstract DateTime WithDeclarationKeyword(Class1 keyword)\n
    \n

    Parameters

    \n

    keyword Class1

    \n

    Returns

    \n

    DateTime

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class BaseClass1

    ", - "title": "Class BaseClass1", + "rawTitle": "

    Class BaseClass1

    ", + "title": " Class BaseClass1", "wordCount": 40.0, "_key": "obj/md/BuildFromVBSourceCode.BaseClass1.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromVBSourceCode.Class1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromVBSourceCode.Class1.html.view.verified.json index ac61d535be4..0ce2d8fb1ae 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromVBSourceCode.Class1.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromVBSourceCode.Class1.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: BuildFromVBSourceCode

    \n

    This is summary from vb class...

    \n
    public class Class1 : BaseClass1\n
    \n
    Inheritance
    \n

    object ←\nBaseClass1 ←\nClass1

    \n
    Inherited Members
    \n

    BaseClass1.WithDeclarationKeyword(Class1),\nobject.Equals(object),\nobject.Equals(object, object),\nobject.Finalize(),\nobject.GetHashCode(),\nobject.GetType(),\nobject.MemberwiseClone(),\nobject.ReferenceEquals(object, object),\nobject.ToString()

    \n

    Fields

    \n

    ValueClass

    \n

    This is a Value type

    \n
    public Class1 ValueClass\n
    \n

    Field Value

    \n

    Class1

    \n

    Properties

    \n

    Keyword

    \n
    [Obsolete("This member is obsolete.", true)]\npublic Class1 Keyword { get; }\n
    \n

    Property Value

    \n

    Class1

    \n

    Methods

    \n

    Value(string)

    \n

    This is a Function

    \n
    public int Value(string name)\n
    \n

    Parameters

    \n

    name string

    \n

    Name as the String\nvalue

    \n

    Returns

    \n

    int

    \n

    Returns\nAhooo

    \n

    WithDeclarationKeyword(Class1)

    \n

    What is Sub?

    \n
    public override DateTime WithDeclarationKeyword(Class1 keyword)\n
    \n

    Parameters

    \n

    keyword Class1

    \n

    Returns

    \n

    DateTime

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

    Namespace: BuildFromVBSourceCode

    \n

    This is summary from vb class...

    \n
    public class Class1 : BaseClass1\n
    \n

    Inheritance

    \n

    object ←\nBaseClass1 ←\nClass1

    \n

    Inherited Members

    \n

    BaseClass1.WithDeclarationKeyword(Class1),\nobject.Equals(object),\nobject.Equals(object, object),\nobject.Finalize(),\nobject.GetHashCode(),\nobject.GetType(),\nobject.MemberwiseClone(),\nobject.ReferenceEquals(object, object),\nobject.ToString()

    \n

    Fields

    \n

    ValueClass

    \n

    This is a Value type

    \n
    public Class1 ValueClass\n
    \n

    Field Value

    \n

    Class1

    \n

    Properties

    \n

    Keyword

    \n
    [Obsolete("This member is obsolete.", true)]\npublic Class1 Keyword { get; }\n
    \n

    Property Value

    \n

    Class1

    \n

    Methods

    \n

    Value(string)

    \n

    This is a Function

    \n
    public int Value(string name)\n
    \n

    Parameters

    \n

    name string

    \n

    Name as the String\nvalue

    \n

    Returns

    \n

    int

    \n

    Returns\nAhooo

    \n

    WithDeclarationKeyword(Class1)

    \n

    What is Sub?

    \n
    public override DateTime WithDeclarationKeyword(Class1 keyword)\n
    \n

    Parameters

    \n

    keyword Class1

    \n

    Returns

    \n

    DateTime

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class Class1

    ", - "title": "Class Class1", + "rawTitle": "

    Class Class1

    ", + "title": " Class Class1", "wordCount": 96.0, "_key": "obj/md/BuildFromVBSourceCode.Class1.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromVBSourceCode.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromVBSourceCode.html.view.verified.json index c81e7f498df..6205bcb0ef5 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromVBSourceCode.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromVBSourceCode.html.view.verified.json @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Namespace BuildFromVBSourceCode

    ", - "title": "Namespace BuildFromVBSourceCode", + "rawTitle": "

    Namespace BuildFromVBSourceCode

    ", + "title": " Namespace BuildFromVBSourceCode", "wordCount": 13.0, "_key": "obj/md/BuildFromVBSourceCode.md", "_navKey": "~/toc.yml", 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 b5566a65f82..02c67271ae4 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]\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]\npublic bool isHealthy\n
    \n

    Field Value

    \n

    bool

    \n

    Properties

    \n

    Age

    \n

    Hint cat's age.

    \n
    protected 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
    public 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]\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]\npublic bool isHealthy\n
    \n

    Field Value

    \n

    bool

    \n

    Properties

    \n

    Age

    \n

    Hint cat's age.

    \n
    protected 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
    public 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": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class Cat<T, K>

    ", - "title": "Class Cat", + "rawTitle": "

    Class Cat<T, K>

    ", + "title": " Class Cat", "wordCount": 621.0, "_key": "obj/md/CatLibrary.Cat-2.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.CatException-1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.CatException-1.html.view.verified.json index 8b6c0cdf55c..cc108683feb 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.CatException-1.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.CatException-1.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: CatLibrary
    \nAssembly: CatLibrary.dll

    \n
    public class CatException<T> : Exception, ISerializable\n
    \n

    Type Parameters

    \n

    T

    \n
    Inheritance
    \n

    object ←\nException ←\nCatException<T>

    \n
    Implements
    \n

    ISerializable

    \n
    Inherited Members
    \n

    Exception.GetBaseException(),\nException.GetObjectData(SerializationInfo, StreamingContext),\nException.GetType(),\nException.ToString(),\nException.Data,\nException.HelpLink,\nException.HResult,\nException.InnerException,\nException.Message,\nException.Source,\nException.StackTrace,\nException.TargetSite,\nException.SerializeObjectState,\nobject.Equals(object?),\nobject.Equals(object?, object?),\nobject.GetHashCode(),\nobject.GetType(),\nobject.MemberwiseClone(),\nobject.ReferenceEquals(object?, object?),\nobject.ToString()

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

    Namespace: CatLibrary
    \nAssembly: CatLibrary.dll

    \n
    public class CatException<T> : Exception, ISerializable\n
    \n

    Type Parameters

    \n

    T

    \n

    Inheritance

    \n

    object ←\nException ←\nCatException<T>

    \n

    Implements

    \n

    ISerializable

    \n

    Inherited Members

    \n

    Exception.GetBaseException(),\nException.GetObjectData(SerializationInfo, StreamingContext),\nException.GetType(),\nException.ToString(),\nException.Data,\nException.HelpLink,\nException.HResult,\nException.InnerException,\nException.Message,\nException.Source,\nException.StackTrace,\nException.TargetSite,\nException.SerializeObjectState,\nobject.Equals(object?),\nobject.Equals(object?, object?),\nobject.GetHashCode(),\nobject.GetType(),\nobject.MemberwiseClone(),\nobject.ReferenceEquals(object?, object?),\nobject.ToString()

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class CatException<T>

    ", - "title": "Class CatException", + "rawTitle": "

    Class CatException<T>

    ", + "title": " Class CatException", "wordCount": 45.0, "_key": "obj/md/CatLibrary.CatException-1.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Complex-2.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Complex-2.html.view.verified.json index 9641d236f9a..ede302baf28 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Complex-2.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Complex-2.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: CatLibrary
    \nAssembly: CatLibrary.dll

    \n
    public class Complex<T, J>\n
    \n

    Type Parameters

    \n

    T

    \n

    J

    \n
    Inheritance
    \n

    object ←\nComplex<T, J>

    \n
    Inherited Members
    \n

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

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

    Namespace: CatLibrary
    \nAssembly: CatLibrary.dll

    \n
    public class Complex<T, J>\n
    \n

    Type Parameters

    \n

    T

    \n

    J

    \n

    Inheritance

    \n

    object ←\nComplex<T, J>

    \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": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class Complex<T, J>

    ", - "title": "Class Complex", + "rawTitle": "

    Class Complex<T, J>

    ", + "title": " Class Complex", "wordCount": 28.0, "_key": "obj/md/CatLibrary.Complex-2.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.ColorType.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.ColorType.html.view.verified.json index 13a49df3f56..71193510186 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.ColorType.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.ColorType.html.view.verified.json @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Enum ContainersRefType.ColorType

    ", - "title": "Enum ContainersRefType.ColorType", + "rawTitle": "

    Enum ContainersRefType.ColorType

    ", + "title": " Enum ContainersRefType.ColorType", "wordCount": 22.0, "_key": "obj/md/CatLibrary.Core.ContainersRefType.ColorType.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html.view.verified.json index 29bbd4a2921..bcd6d62033a 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: CatLibrary.Core
    \nAssembly: CatLibrary.Core.dll

    \n
    public class ContainersRefType.ContainersRefTypeChild\n
    \n
    Inheritance
    \n

    object ←\nContainersRefType.ContainersRefTypeChild

    \n
    Inherited Members
    \n

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

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

    Namespace: CatLibrary.Core
    \nAssembly: CatLibrary.Core.dll

    \n
    public class ContainersRefType.ContainersRefTypeChild\n
    \n

    Inheritance

    \n

    object ←\nContainersRefType.ContainersRefTypeChild

    \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": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class ContainersRefType.ContainersRefTypeChild

    ", - "title": "Class ContainersRefType.ContainersRefTypeChild", + "rawTitle": "

    Class ContainersRefType.ContainersRefTypeChild

    ", + "title": " Class ContainersRefType.ContainersRefTypeChild", "wordCount": 22.0, "_key": "obj/md/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html.view.verified.json index f93d3d67cad..fa37ee58e5c 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html.view.verified.json @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Interface ContainersRefType.ContainersRefTypeChildInterface

    ", - "title": "Interface ContainersRefType.ContainersRefTypeChildInterface", + "rawTitle": "

    Interface ContainersRefType.ContainersRefTypeChildInterface

    ", + "title": " Interface ContainersRefType.ContainersRefTypeChildInterface", "wordCount": 7.0, "_key": "obj/md/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html.view.verified.json index 0a7df49e0bd..0bafa8c4a16 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html.view.verified.json @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Delegate ContainersRefType.ContainersRefTypeDelegate

    ", - "title": "Delegate ContainersRefType.ContainersRefTypeDelegate", + "rawTitle": "

    Delegate ContainersRefType.ContainersRefTypeDelegate

    ", + "title": " Delegate ContainersRefType.ContainersRefTypeDelegate", "wordCount": 10.0, "_key": "obj/md/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.html.view.verified.json index 0527bccee9d..db7f7f085a7 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ContainersRefType.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: CatLibrary.Core
    \nAssembly: CatLibrary.Core.dll

    \n

    Struct ContainersRefType

    \n
    public struct ContainersRefType\n
    \n
    Inherited Members
    \n

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

    \n
    Extension Methods
    \n

    Issue231.Bar(ContainersRefType),\nIssue231.Foo(ContainersRefType)

    \n

    Fields

    \n

    ColorCount

    \n

    ColorCount

    \n
    public long ColorCount\n
    \n

    Field Value

    \n

    long

    \n

    Properties

    \n

    GetColorCount

    \n

    GetColorCount

    \n
    public long GetColorCount { get; }\n
    \n

    Property Value

    \n

    long

    \n

    Methods

    \n

    ContainersRefTypeNonRefMethod(params object[])

    \n

    ContainersRefTypeNonRefMethod

    \narray\n
    public static int ContainersRefTypeNonRefMethod(params object[] parmsArray)\n
    \n

    Parameters

    \n

    parmsArray object[]

    \n

    Returns

    \n

    int

    \n

    ContainersRefTypeEventHandler

    \n
    public event EventHandler ContainersRefTypeEventHandler\n
    \n

    Event Type

    \n

    EventHandler

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

    Namespace: CatLibrary.Core
    \nAssembly: CatLibrary.Core.dll

    \n

    Struct ContainersRefType

    \n
    public struct ContainersRefType\n
    \n

    Inherited Members

    \n

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

    \n

    Extension Methods

    \n

    Issue231.Bar(ContainersRefType),\nIssue231.Foo(ContainersRefType)

    \n

    Fields

    \n

    ColorCount

    \n

    ColorCount

    \n
    public long ColorCount\n
    \n

    Field Value

    \n

    long

    \n

    Properties

    \n

    GetColorCount

    \n

    GetColorCount

    \n
    public long GetColorCount { get; }\n
    \n

    Property Value

    \n

    long

    \n

    Methods

    \n

    ContainersRefTypeNonRefMethod(params object[])

    \n

    ContainersRefTypeNonRefMethod

    \narray\n
    public static int ContainersRefTypeNonRefMethod(params object[] parmsArray)\n
    \n

    Parameters

    \n

    parmsArray object[]

    \n

    Returns

    \n

    int

    \n

    ContainersRefTypeEventHandler

    \n
    public event EventHandler ContainersRefTypeEventHandler\n
    \n

    Event Type

    \n

    EventHandler

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Struct ContainersRefType

    ", - "title": "Struct ContainersRefType", + "rawTitle": "

    Struct ContainersRefType

    ", + "title": " Struct ContainersRefType", "wordCount": 68.0, "_key": "obj/md/CatLibrary.Core.ContainersRefType.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ExplicitLayoutClass.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ExplicitLayoutClass.html.view.verified.json index b42f04311fb..6f25302c001 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ExplicitLayoutClass.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.ExplicitLayoutClass.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: CatLibrary.Core
    \nAssembly: CatLibrary.Core.dll

    \n
    public class ExplicitLayoutClass\n
    \n
    Inheritance
    \n

    object ←\nExplicitLayoutClass

    \n
    Inherited Members
    \n

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

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

    Namespace: CatLibrary.Core
    \nAssembly: CatLibrary.Core.dll

    \n
    public class ExplicitLayoutClass\n
    \n

    Inheritance

    \n

    object ←\nExplicitLayoutClass

    \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": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class ExplicitLayoutClass

    ", - "title": "Class ExplicitLayoutClass", + "rawTitle": "

    Class ExplicitLayoutClass

    ", + "title": " Class ExplicitLayoutClass", "wordCount": 22.0, "_key": "obj/md/CatLibrary.Core.ExplicitLayoutClass.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.Issue231.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.Issue231.html.view.verified.json index 394a222ba1c..8a11c93e3d2 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.Issue231.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.Issue231.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: CatLibrary.Core
    \nAssembly: CatLibrary.dll, CatLibrary.Core.dll

    \n
    public static class Issue231\n
    \n
    Inheritance
    \n

    object ←\nIssue231

    \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

    Bar(ContainersRefType)

    \n
    public static void Bar(this ContainersRefType c)\n
    \n

    Parameters

    \n

    c ContainersRefType

    \n

    Foo(ContainersRefType)

    \n
    public static void Foo(this ContainersRefType c)\n
    \n

    Parameters

    \n

    c ContainersRefType

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

    Namespace: CatLibrary.Core
    \nAssembly: CatLibrary.dll, CatLibrary.Core.dll

    \n
    public static class Issue231\n
    \n

    Inheritance

    \n

    object ←\nIssue231

    \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

    Bar(ContainersRefType)

    \n
    public static void Bar(this ContainersRefType c)\n
    \n

    Parameters

    \n

    c ContainersRefType

    \n

    Foo(ContainersRefType)

    \n
    public static void Foo(this ContainersRefType c)\n
    \n

    Parameters

    \n

    c ContainersRefType

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class Issue231

    ", - "title": "Class Issue231", + "rawTitle": "

    Class Issue231

    ", + "title": " Class Issue231", "wordCount": 45.0, "_key": "obj/md/CatLibrary.Core.Issue231.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.html.view.verified.json index 2724f455722..40d0e3bd56b 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Core.html.view.verified.json @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Namespace CatLibrary.Core

    ", - "title": "Namespace CatLibrary.Core", + "rawTitle": "

    Namespace CatLibrary.Core

    ", + "title": " Namespace CatLibrary.Core", "wordCount": 19.0, "_key": "obj/md/CatLibrary.Core.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.FakeDelegate-1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.FakeDelegate-1.html.view.verified.json index b2d46bdcafa..aa2da7d51a7 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.FakeDelegate-1.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.FakeDelegate-1.html.view.verified.json @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Delegate FakeDelegate<T>

    ", - "title": "Delegate FakeDelegate", + "rawTitle": "

    Delegate FakeDelegate<T>

    ", + "title": " Delegate FakeDelegate", "wordCount": 43.0, "_key": "obj/md/CatLibrary.FakeDelegate-1.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.IAnimal.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.IAnimal.html.view.verified.json index 612baa58e3b..56d4ed1fe69 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.IAnimal.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.IAnimal.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: CatLibrary
    \nAssembly: CatLibrary.dll

    \n

    This is basic interface of all animal.

    \n
    public interface IAnimal\n
    \n

    Properties

    \n

    Name

    \n

    Name of Animal.

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

    Property Value

    \n

    string

    \n

    this[int]

    \n

    Return specific number animal's name.

    \n
    string this[int index] { get; }\n
    \n

    Property Value

    \n

    string

    \n

    Methods

    \n

    Eat()

    \n

    Animal's eat method.

    \n
    void Eat()\n
    \n

    Eat<Tool>(Tool)

    \n

    Overload method of eat. This define the animal eat by which tool.

    \n
    void Eat<Tool>(Tool tool) where Tool : class\n
    \n

    Parameters

    \n

    tool Tool

    \n

    Tool name.

    \n

    Type Parameters

    \n

    Tool

    \n

    It's a class type.

    \n

    Eat(string)

    \n

    Feed the animal with some food

    \n
    void Eat(string food)\n
    \n

    Parameters

    \n

    food string

    \n

    Food to eat

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

    Namespace: CatLibrary
    \nAssembly: CatLibrary.dll

    \n

    This is basic interface of all animal.

    \n
    public interface IAnimal\n
    \n

    Properties

    \n

    Name

    \n

    Name of Animal.

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

    Property Value

    \n

    string

    \n

    this[int]

    \n

    Return specific number animal's name.

    \n
    string this[int index] { get; }\n
    \n

    Property Value

    \n

    string

    \n

    Methods

    \n

    Eat()

    \n

    Animal's eat method.

    \n
    void Eat()\n
    \n

    Eat<Tool>(Tool)

    \n

    Overload method of eat. This define the animal eat by which tool.

    \n
    void Eat<Tool>(Tool tool) where Tool : class\n
    \n

    Parameters

    \n

    tool Tool

    \n

    Tool name.

    \n

    Type Parameters

    \n

    Tool

    \n

    It's a class type.

    \n

    Eat(string)

    \n

    Feed the animal with some food

    \n
    void Eat(string food)\n
    \n

    Parameters

    \n

    food string

    \n

    Food to eat

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Interface IAnimal

    ", - "title": "Interface IAnimal", + "rawTitle": "

    Interface IAnimal

    ", + "title": " Interface IAnimal", "wordCount": 96.0, "_key": "obj/md/CatLibrary.IAnimal.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.ICat.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.ICat.html.view.verified.json index 55231813bf8..903e2d8f70b 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.ICat.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.ICat.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: CatLibrary
    \nAssembly: CatLibrary.dll

    \n

    Cat's interface

    \n
    public interface ICat : IAnimal\n
    \n
    Implements
    \n

    IAnimal

    \n
    Extension Methods
    \n

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

    \n

    eat

    \n

    eat event of cat. Every cat must implement this event.

    \n
    event EventHandler eat\n
    \n

    Event Type

    \n

    EventHandler

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

    Namespace: CatLibrary
    \nAssembly: CatLibrary.dll

    \n

    Cat's interface

    \n
    public interface ICat : IAnimal\n
    \n

    Implements

    \n

    IAnimal

    \n

    Extension Methods

    \n

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

    \n

    eat

    \n

    eat event of cat. Every cat must implement this event.

    \n
    event EventHandler eat\n
    \n

    Event Type

    \n

    EventHandler

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Interface ICat

    ", - "title": "Interface ICat", + "rawTitle": "

    Interface ICat

    ", + "title": " Interface ICat", "wordCount": 35.0, "_key": "obj/md/CatLibrary.ICat.md", "_navKey": "~/toc.yml", 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 839d5a20eb2..afffd174531 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.

    \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", + "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": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class ICatExtension

    ", - "title": "Class ICatExtension", + "rawTitle": "

    Class ICatExtension

    ", + "title": " Class ICatExtension", "wordCount": 107.0, "_key": "obj/md/CatLibrary.ICatExtension.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.MRefDelegate-3.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.MRefDelegate-3.html.view.verified.json index 1cc60eaef4b..4443a0a4f1f 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.MRefDelegate-3.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.MRefDelegate-3.html.view.verified.json @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Delegate MRefDelegate<K, T, L>

    ", - "title": "Delegate MRefDelegate", + "rawTitle": "

    Delegate MRefDelegate<K, T, L>

    ", + "title": " Delegate MRefDelegate", "wordCount": 55.0, "_key": "obj/md/CatLibrary.MRefDelegate-3.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.MRefNormalDelegate.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.MRefNormalDelegate.html.view.verified.json index 0ef282e4183..d024f24f916 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.MRefNormalDelegate.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.MRefNormalDelegate.html.view.verified.json @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Delegate MRefNormalDelegate

    ", - "title": "Delegate MRefNormalDelegate", + "rawTitle": "

    Delegate MRefNormalDelegate

    ", + "title": " Delegate MRefNormalDelegate", "wordCount": 33.0, "_key": "obj/md/CatLibrary.MRefNormalDelegate.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Tom.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Tom.html.view.verified.json index 1f4f50c44cb..92d632857a7 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Tom.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.Tom.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: CatLibrary
    \nAssembly: CatLibrary.dll

    \n

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

    \n
    public class Tom\n
    \n
    Inheritance
    \n

    object ←\nTom

    \n
    Derived
    \n

    TomFromBaseClass

    \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

    TomMethod(Complex<TomFromBaseClass, TomFromBaseClass>, Tuple<string, Tom>)

    \n

    This is a Tom Method with complex type as return

    \n
    public Complex<string, TomFromBaseClass> TomMethod(Complex<TomFromBaseClass, TomFromBaseClass> a, Tuple<string, Tom> b)\n
    \n

    Parameters

    \n

    a Complex<TomFromBaseClass, TomFromBaseClass>

    \n

    A complex input

    \n

    b Tuple<string, Tom>

    \n

    Another complex input

    \n

    Returns

    \n

    Complex<string, TomFromBaseClass>

    \n

    Complex

    \n

    Exceptions

    \n

    NotImplementedException

    \n

    This is not implemented

    \n

    ArgumentException

    \n

    This is the exception to be thrown when implemented

    \n

    CatException<T>

    \n

    This is the exception in current documentation

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

    Namespace: CatLibrary
    \nAssembly: CatLibrary.dll

    \n

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

    \n
    public class Tom\n
    \n

    Inheritance

    \n

    object ←\nTom

    \n

    Derived

    \n

    TomFromBaseClass

    \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

    TomMethod(Complex<TomFromBaseClass, TomFromBaseClass>, Tuple<string, Tom>)

    \n

    This is a Tom Method with complex type as return

    \n
    public Complex<string, TomFromBaseClass> TomMethod(Complex<TomFromBaseClass, TomFromBaseClass> a, Tuple<string, Tom> b)\n
    \n

    Parameters

    \n

    a Complex<TomFromBaseClass, TomFromBaseClass>

    \n

    A complex input

    \n

    b Tuple<string, Tom>

    \n

    Another complex input

    \n

    Returns

    \n

    Complex<string, TomFromBaseClass>

    \n

    Complex

    \n

    Exceptions

    \n

    NotImplementedException

    \n

    This is not implemented

    \n

    ArgumentException

    \n

    This is the exception to be thrown when implemented

    \n

    CatException<T>

    \n

    This is the exception in current documentation

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class Tom

    ", - "title": "Class Tom", + "rawTitle": "

    Class Tom

    ", + "title": " Class Tom", "wordCount": 108.0, "_key": "obj/md/CatLibrary.Tom.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.TomFromBaseClass.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.TomFromBaseClass.html.view.verified.json index 0b8ab37b7eb..9d04c50d2e1 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.TomFromBaseClass.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/CatLibrary.TomFromBaseClass.html.view.verified.json @@ -1,5 +1,5 @@ { - "conceptual": "\n

    Namespace: CatLibrary
    \nAssembly: CatLibrary.dll

    \n

    TomFromBaseClass inherits from @

    \n
    public class TomFromBaseClass : Tom\n
    \n
    Inheritance
    \n

    object ←\nTom ←\nTomFromBaseClass

    \n
    Inherited Members
    \n

    Tom.TomMethod(Complex<TomFromBaseClass, TomFromBaseClass>, Tuple<string, Tom>),\nobject.Equals(object?),\nobject.Equals(object?, object?),\nobject.GetHashCode(),\nobject.GetType(),\nobject.MemberwiseClone(),\nobject.ReferenceEquals(object?, object?),\nobject.ToString()

    \n

    Constructors

    \n

    TomFromBaseClass(int)

    \n

    This is a #ctor with parameter

    \n
    public TomFromBaseClass(int k)\n
    \n

    Parameters

    \n

    k int

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

    Namespace: CatLibrary
    \nAssembly: CatLibrary.dll

    \n

    TomFromBaseClass inherits from @

    \n
    public class TomFromBaseClass : Tom\n
    \n

    Inheritance

    \n

    object ←\nTom ←\nTomFromBaseClass

    \n

    Inherited Members

    \n

    Tom.TomMethod(Complex<TomFromBaseClass, TomFromBaseClass>, Tuple<string, Tom>),\nobject.Equals(object?),\nobject.Equals(object?, object?),\nobject.GetHashCode(),\nobject.GetType(),\nobject.MemberwiseClone(),\nobject.ReferenceEquals(object?, object?),\nobject.ToString()

    \n

    Constructors

    \n

    TomFromBaseClass(int)

    \n

    This is a #ctor with parameter

    \n
    public TomFromBaseClass(int k)\n
    \n

    Parameters

    \n

    k int

    \n", "type": "Conceptual", "source": { "remote": { @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Class TomFromBaseClass

    ", - "title": "Class TomFromBaseClass", + "rawTitle": "

    Class TomFromBaseClass

    ", + "title": " Class TomFromBaseClass", "wordCount": 47.0, "_key": "obj/md/CatLibrary.TomFromBaseClass.md", "_navKey": "~/toc.yml", 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 06661454e9b..9ee550e98d4 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 @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Namespace CatLibrary

    ", - "title": "Namespace CatLibrary", + "rawTitle": "

    Namespace CatLibrary

    ", + "title": " Namespace CatLibrary", "wordCount": 130.0, "_key": "obj/md/CatLibrary.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/MRef.Demo.Enumeration.ColorType.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/MRef.Demo.Enumeration.ColorType.html.view.verified.json index d09c89c1dd1..133ce736377 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/MRef.Demo.Enumeration.ColorType.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/MRef.Demo.Enumeration.ColorType.html.view.verified.json @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Enum ColorType

    ", - "title": "Enum ColorType", + "rawTitle": "

    Enum ColorType

    ", + "title": " Enum ColorType", "wordCount": 41.0, "_key": "obj/md/MRef.Demo.Enumeration.ColorType.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/MRef.Demo.Enumeration.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/MRef.Demo.Enumeration.html.view.verified.json index 7d603e4730b..f923168256e 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/MRef.Demo.Enumeration.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/MRef.Demo.Enumeration.html.view.verified.json @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Namespace MRef.Demo.Enumeration

    ", - "title": "Namespace MRef.Demo.Enumeration", + "rawTitle": "

    Namespace MRef.Demo.Enumeration

    ", + "title": " Namespace MRef.Demo.Enumeration", "wordCount": 4.0, "_key": "obj/md/MRef.Demo.Enumeration.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/MRef.Demo.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/MRef.Demo.html.view.verified.json index f6b2356b7c4..5918d0b3317 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/MRef.Demo.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/MRef.Demo.html.view.verified.json @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Namespace MRef.Demo

    ", - "title": "Namespace MRef.Demo", + "rawTitle": "

    Namespace MRef.Demo

    ", + "title": " Namespace MRef.Demo", "wordCount": 2.0, "_key": "obj/md/MRef.Demo.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/MRef.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/MRef.html.view.verified.json index 132ed1a1bc8..7e09e86f6bd 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/MRef.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/md/MRef.html.view.verified.json @@ -25,8 +25,8 @@ "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, - "rawTitle": "

    Namespace MRef

    ", - "title": "Namespace MRef", + "rawTitle": "

    Namespace MRef

    ", + "title": " Namespace MRef", "wordCount": 2.0, "_key": "obj/md/MRef.md", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/toc.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/toc.html.view.verified.json index eff9e1766c7..e81d7514613 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/toc.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/toc.html.view.verified.json @@ -40,6 +40,15 @@ "items": [], "leaf": true }, + { + "name": ".NET API (apipage)", + "href": "apipage/BuildFromAssembly.html", + "tocHref": "apipage/toc.html", + "topicHref": "apipage/BuildFromAssembly.html", + "level": 3.0, + "items": [], + "leaf": true + }, { "name": "REST API", "href": "restapi/petstore.html", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/toc.json.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/toc.json.view.verified.json index 249a01a694c..f98121b9136 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/toc.json.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/toc.json.view.verified.json @@ -1,3 +1,3 @@ { - "content": "{\"items\":[{\"name\":\"Home\",\"href\":\"index.html\",\"topicHref\":\"index.html\"},{\"name\":\"Articles\",\"href\":\"articles/docfx_getting_started.html\",\"tocHref\":\"articles/toc.html\",\"topicHref\":\"articles/docfx_getting_started.html\"},{\"name\":\"API Documentation\",\"items\":[{\"name\":\".NET API\",\"href\":\"api/BuildFromAssembly.html\",\"tocHref\":\"api/toc.html\",\"topicHref\":\"api/BuildFromAssembly.html\",\"topicUid\":\"BuildFromAssembly\"},{\"name\":\".NET API (markdown)\",\"href\":\"md/BuildFromAssembly.html\",\"tocHref\":\"md/toc.html\",\"topicHref\":\"md/BuildFromAssembly.html\"},{\"name\":\"REST API\",\"href\":\"restapi/petstore.html\",\"tocHref\":\"restapi/toc.html\",\"topicHref\":\"restapi/petstore.html\"}]}]}" + "content": "{\"items\":[{\"name\":\"Home\",\"href\":\"index.html\",\"topicHref\":\"index.html\"},{\"name\":\"Articles\",\"href\":\"articles/docfx_getting_started.html\",\"tocHref\":\"articles/toc.html\",\"topicHref\":\"articles/docfx_getting_started.html\"},{\"name\":\"API Documentation\",\"items\":[{\"name\":\".NET API\",\"href\":\"api/BuildFromAssembly.html\",\"tocHref\":\"api/toc.html\",\"topicHref\":\"api/BuildFromAssembly.html\",\"topicUid\":\"BuildFromAssembly\"},{\"name\":\".NET API (markdown)\",\"href\":\"md/BuildFromAssembly.html\",\"tocHref\":\"md/toc.html\",\"topicHref\":\"md/BuildFromAssembly.html\"},{\"name\":\".NET API (apipage)\",\"href\":\"apipage/BuildFromAssembly.html\",\"tocHref\":\"apipage/toc.html\",\"topicHref\":\"apipage/BuildFromAssembly.html\"},{\"name\":\"REST API\",\"href\":\"restapi/petstore.html\",\"tocHref\":\"restapi/toc.html\",\"topicHref\":\"restapi/petstore.html\"}]}]}" } \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/toc.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/toc.verified.json index 5dc1ce76a64..343cf181aa5 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/toc.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/toc.verified.json @@ -27,6 +27,12 @@ "tocHref": "md/toc.html", "topicHref": "md/BuildFromAssembly.html" }, + { + "name": ".NET API (apipage)", + "href": "apipage/BuildFromAssembly.html", + "tocHref": "apipage/toc.html", + "topicHref": "apipage/BuildFromAssembly.html" + }, { "name": "REST API", "href": "restapi/petstore.html", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/api-CatLibrary.html-term-cat.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/api-CatLibrary.html-term-cat.verified.png index c8c93358a64..3fd52a3d9ad 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/api-CatLibrary.html-term-cat.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/api-CatLibrary.html-term-cat.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:dab3df44a4163d17a0630075ac9b81ea4f1a673714ae146232fa845164f9fdea -size 160467 +oid sha256:33272ca0ba2da89a5a59fe16af70aaeaff987e8f764fbecfe79b6597092da907 +size 157496 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/api-CatLibrary.html-term-cat.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/api-CatLibrary.html-term-cat.verified.png index bf0fa007257..ac187511b89 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/api-CatLibrary.html-term-cat.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/api-CatLibrary.html-term-cat.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:39f0b8176dce4548a97b24375a96474dc79649983a1e5442e6fa1db447e62928 -size 346420 +oid sha256:65efcd2098cc42711bcc72c6696b4b9edb3c4213d8a8f60ddaa49ca5767d2563 +size 508181 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/api-CatLibrary.html-term-cat.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/api-CatLibrary.html-term-cat.verified.png index d8803eefd22..2201409949d 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/api-CatLibrary.html-term-cat.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/api-CatLibrary.html-term-cat.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7cbf71c610545663d3cc738616d85e06b517e2e3a0465207ceb800322c066b6e -size 499159 +oid sha256:2704a4f576594ad09ddf9f4d794b524b08ca710173090ef54cc3fafd7feefbff +size 741521 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/768x600/api-CatLibrary.html-term-cat.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/768x600/api-CatLibrary.html-term-cat.verified.png index 6903a7a31c4..1febb6aeef6 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/768x600/api-CatLibrary.html-term-cat.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/768x600/api-CatLibrary.html-term-cat.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:605ff9dee07e55e20ea164e88f964fcc59f88658b27bda0ba62f5777e1fd39ff -size 138254 +oid sha256:d25e70cea3249241f881d6966b7629e13b95bc3d50f4b093a07286396e04d3b9 +size 116250 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-BuildFromProject.Class1.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-BuildFromProject.Class1.html.verified.html index db8d2adca82..b6431cfb627 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-BuildFromProject.Class1.html.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-BuildFromProject.Class1.html.verified.html @@ -236,7 +236,7 @@ - +
    diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html index 8cdd0ebcf3d..34f8166702b 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html @@ -60,7 +60,7 @@ - + diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html index 5bfc3c43dd9..9a05da6ff6b 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html @@ -60,7 +60,7 @@ - + @@ -452,8 +452,13 @@
    In this article
    -
    6 results for "cat"
    +
    9 results for "cat"
    +
    +
    Interface ICat | docfx seed website
    +
    http:/localhost:8089/apipage/CatLibrary.ICat.html
    +
    Interface ICat Namespace CatLibrary Assembly CatLibrary.dll Cat's interface public interface ICat : IAnimal Implements IAnimal Extension Methods ICatExtension.Play(ICat, ContainersRefType.ColorType) ICatExtension.Sleep(ICat, long) eat eat event of cat. Every cat must implement this event. event EventHandler eat Event Type EventHandler...
    +
    Interface ICat | docfx seed website
    http:/localhost:8089/md/CatLibrary.ICat.html
    @@ -464,6 +469,11 @@
    In this article
    http:/localhost:8089/api/CatLibrary.Cat-2.html
    ... used for this parameter. Inheritance object Cat<T, K> Implements ICat IAnimal Inherited Members object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods ICatExtension.Play(ICat, ContainersRefType.ColorType) ICatExtension.Sleep(ICat, long) 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 { a.GetFeetLength(catNumber); } As you see, here we bring in pointer so we need to add unsafe keyword. Remarks THIS is remarks overridden in MARKDWON file Constructors Cat() Default constructor. public Cat() Cat(string, out int, string, bool) It's a complex constructor. The parameter will have some attributes. public Cat(string nickName, out int age, string realName, bool isHealthy) Parameters nickName string it's string type. age int It's an out and ref parameter. realName str...
    +
    +
    Class Cat<T, K> | docfx seed website
    +
    http:/localhost:8089/apipage/CatLibrary.Cat-2.html
    +
    ...nheritance object Cat<T, K> Implements ICat IAnimal Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString() Extension Methods ICatExtension.Play(ICat, ContainersRefType.ColorType) ICatExtension.Sleep(ICat, long) 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 { a.GetFeetLength(catNumber); } As you see, here we bring in pointer so we need to add unsafe keyword. Remarks Here's all the content you can see in this class. Constructors Cat() Default constructor. public Cat() Cat(T) Constructor with one generic parameter. public Cat(T ownType) Parameters ownType T This parameter type defined by class. Cat(string, out int, string, bool) It's a complex constructor. The parameter will have some attributes. public Cat(string nickName, out int ...
    +
    Class Cat<T, K> | docfx seed website
    http:/localhost:8089/md/CatLibrary.Cat-2.html
    @@ -479,6 +489,11 @@
    In this article
    http:/localhost:8089/api/CatLibrary.ICatExtension.html
    ...ass ICatExtension Namespace CatLibrary 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 public static class ICatExtension Inheritance object ICatExtension Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods Play(ICat, ColorType) Extension method to let cat play public static void Play(this ICat icat, ContainersRefType.ColorType toy) Parameters icat ICat Cat toy ContainersRefType.ColorType Something to play Sleep(ICat, long) Extension method hint that how long the cat can sleep. public static void Sleep(this ICat icat, long hours) Parameters icat ICat The type will be extended. hours long The length of sleep....
    +
    +
    Class ICatExtension | docfx seed website
    +
    http:/localhost:8089/apipage/CatLibrary.ICatExtension.html
    +
    ...CatExtension Namespace CatLibrary 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 public static class ICatExtension Inheritance object ICatExtension Inherited Members object.Equals(object?) object.Equals(object?, object?) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object?, object?) object.ToString() Methods Play(ICat, ColorType) Extension method to let cat play public static void Play(this ICat icat, ContainersRefType.ColorType toy) Parameters icat ICat Cat toy ContainersRefType.ColorType Something to play Sleep(ICat, long) Extension method hint that how long the cat can sleep. public static void Sleep(this ICat icat, long hours) Parameters icat ICat The type will be extended. hours long The length of sleep....
    +
    Class ICatExtension | docfx seed website
    http:/localhost:8089/md/CatLibrary.ICatExtension.html
    diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html index 63f25ad88b6..6cd0a97cbc1 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html @@ -60,7 +60,7 @@ - + diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-csharp_coding_standards.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-csharp_coding_standards.html.verified.html index cd06a4db714..1a31021ab01 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-csharp_coding_standards.html.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-csharp_coding_standards.html.verified.html @@ -58,7 +58,7 @@ - + diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-markdown.html-tabs-windows-2Ctypescript-markdown-extensions.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-markdown.html-tabs-windows-2Ctypescript-markdown-extensions.verified.html index 2d2d735a3af..b31ba72f087 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-markdown.html-tabs-windows-2Ctypescript-markdown-extensions.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/articles-markdown.html-tabs-windows-2Ctypescript-markdown-extensions.verified.html @@ -234,7 +234,7 @@ - + diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/index.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/index.html.verified.html index 31f94004c61..b1ca906be3f 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/index.html.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/index.html.verified.html @@ -58,7 +58,7 @@ - + @@ -115,6 +115,11 @@
    Table of Contents
    .NET API (markdown) + +
  • + + .NET API (apipage) +
  • diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/restapi-petstore.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/restapi-petstore.html.verified.html index 3e6d560d614..882dd4d65ed 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/restapi-petstore.html.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/restapi-petstore.html.verified.html @@ -58,7 +58,7 @@ - +
    • diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromAssembly.Class1.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromAssembly.Class1.verified.md index 85c732bdd9f..f4779f9cde8 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromAssembly.Class1.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromAssembly.Class1.verified.md @@ -1,7 +1,7 @@ -# Class Class1 +# Class Class1 Namespace: [BuildFromAssembly](BuildFromAssembly.md) -Assembly: BuildFromAssembly.dll +Assembly: BuildFromAssembly.dll This is a test class. @@ -9,12 +9,12 @@ This is a test class. public class Class1 ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Class1](BuildFromAssembly.Class1.md) -###### Inherited Members +#### Inherited Members [object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype), [object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone), @@ -26,7 +26,7 @@ public class Class1 ## Constructors -### Class1\(\) +### Class1\(\) ```csharp public Class1() @@ -34,7 +34,7 @@ public Class1() ## Methods -### HelloWorld\(\) +### HelloWorld\(\) Hello World. diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromAssembly.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromAssembly.verified.md index 479d572088c..5b6d719bbb0 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromAssembly.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromAssembly.verified.md @@ -1,8 +1,8 @@ -# Namespace BuildFromAssembly +# Namespace BuildFromAssembly ### Classes -[Class1](BuildFromAssembly.Class1.md) + [Class1](BuildFromAssembly.Class1.md) This is a test class. diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromCSharpSourceCode.CSharp.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromCSharpSourceCode.CSharp.verified.md index e4b4ea0b84c..ff5c4587b40 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromCSharpSourceCode.CSharp.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromCSharpSourceCode.CSharp.verified.md @@ -1,17 +1,17 @@ -# Class CSharp +# Class CSharp -Namespace: [BuildFromCSharpSourceCode](BuildFromCSharpSourceCode.md) +Namespace: [BuildFromCSharpSourceCode](BuildFromCSharpSourceCode.md) ```csharp public class CSharp ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [CSharp](BuildFromCSharpSourceCode.CSharp.md) -###### Inherited Members +#### 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\)), @@ -23,7 +23,7 @@ public class CSharp ## Methods -### Main\(string\[\]\) +### Main\(string\[\]\) ```csharp public static void Main(string[] args) diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromCSharpSourceCode.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromCSharpSourceCode.verified.md index 61cfc44de41..2deb942acf5 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromCSharpSourceCode.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromCSharpSourceCode.verified.md @@ -1,6 +1,6 @@ -# Namespace BuildFromCSharpSourceCode +# Namespace BuildFromCSharpSourceCode ### Classes -[CSharp](BuildFromCSharpSourceCode.CSharp.md) + [CSharp](BuildFromCSharpSourceCode.CSharp.md) diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.IIssue8948.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.IIssue8948.verified.md index e6b42e045d7..d0ea4e11493 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.IIssue8948.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.IIssue8948.verified.md @@ -1,7 +1,7 @@ -# Interface Class1.IIssue8948 +# Interface Class1.IIssue8948 Namespace: [BuildFromProject](BuildFromProject.md) -Assembly: BuildFromProject.dll +Assembly: BuildFromProject.dll ```csharp public interface Class1.IIssue8948 @@ -9,7 +9,7 @@ public interface Class1.IIssue8948 ## Methods -### DoNothing\(\) +### DoNothing\(\) Does nothing with generic type T. diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8665.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8665.verified.md index 16320abcf2b..7ea0446f833 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8665.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8665.verified.md @@ -1,18 +1,18 @@ -# Class Class1.Issue8665 +# Class Class1.Issue8665 Namespace: [BuildFromProject](BuildFromProject.md) -Assembly: BuildFromProject.dll +Assembly: BuildFromProject.dll ```csharp public class Class1.Issue8665 ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Class1.Issue8665](BuildFromProject.Class1.Issue8665.md) -###### Inherited Members +#### 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\)), @@ -24,13 +24,13 @@ public class Class1.Issue8665 ## Constructors -### Issue8665\(\) +### Issue8665\(\) ```csharp public Issue8665() ``` -### Issue8665\(int\) +### Issue8665\(int\) ```csharp public Issue8665(int foo) @@ -40,7 +40,7 @@ public Issue8665(int foo) `foo` [int](https://learn.microsoft.com/dotnet/api/system.int32) -### Issue8665\(int, char\) +### Issue8665\(int, char\) ```csharp public Issue8665(int foo, char bar) @@ -52,7 +52,7 @@ public Issue8665(int foo, char bar) `bar` [char](https://learn.microsoft.com/dotnet/api/system.char) -### Issue8665\(int, char, string\) +### Issue8665\(int, char, string\) ```csharp public Issue8665(int foo, char bar, string baz) @@ -68,7 +68,7 @@ public Issue8665(int foo, char bar, string baz) ## Properties -### Bar +### Bar ```csharp public char Bar { get; } @@ -76,9 +76,9 @@ public char Bar { get; } #### Property Value -[char](https://learn.microsoft.com/dotnet/api/system.char) + [char](https://learn.microsoft.com/dotnet/api/system.char) -### Baz +### Baz ```csharp public string Baz { get; } @@ -86,9 +86,9 @@ public string Baz { get; } #### Property Value -[string](https://learn.microsoft.com/dotnet/api/system.string) + [string](https://learn.microsoft.com/dotnet/api/system.string) -### Foo +### Foo ```csharp public int Foo { get; } @@ -96,5 +96,5 @@ public int Foo { get; } #### Property Value -[int](https://learn.microsoft.com/dotnet/api/system.int32) + [int](https://learn.microsoft.com/dotnet/api/system.int32) diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8696Attribute.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8696Attribute.verified.md index 0632f5c4675..130058fd900 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8696Attribute.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8696Attribute.verified.md @@ -1,19 +1,19 @@ -# Class Class1.Issue8696Attribute +# Class Class1.Issue8696Attribute Namespace: [BuildFromProject](BuildFromProject.md) -Assembly: BuildFromProject.dll +Assembly: BuildFromProject.dll ```csharp public class Class1.Issue8696Attribute : Attribute ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Attribute](https://learn.microsoft.com/dotnet/api/system.attribute) ← [Class1.Issue8696Attribute](BuildFromProject.Class1.Issue8696Attribute.md) -###### Inherited Members +#### Inherited Members [Attribute.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.attribute.equals), [Attribute.GetCustomAttribute\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-assembly\-system\-type\)), @@ -62,7 +62,7 @@ public class Class1.Issue8696Attribute : Attribute ## Constructors -### Issue8696Attribute\(string?, int, int, string\[\]?, bool, Type?\) +### Issue8696Attribute\(string?, int, int, string\[\]?, bool, Type?\) ```csharp [Class1.Issue8696("Changes the name of the server in the server list", 0, 0, null, false, null)] diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8948.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8948.verified.md index cb89fe21be4..b581855389e 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8948.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8948.verified.md @@ -1,22 +1,22 @@ -# Class Class1.Issue8948 +# Class Class1.Issue8948 Namespace: [BuildFromProject](BuildFromProject.md) -Assembly: BuildFromProject.dll +Assembly: BuildFromProject.dll ```csharp public class Class1.Issue8948 : Class1.IIssue8948 ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Class1.Issue8948](BuildFromProject.Class1.Issue8948.md) -###### Implements +#### Implements [Class1.IIssue8948](BuildFromProject.Class1.IIssue8948.md) -###### Inherited Members +#### 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\)), @@ -28,7 +28,7 @@ public class Class1.Issue8948 : Class1.IIssue8948 ## Methods -### DoNothing\(\) +### DoNothing\(\) Does nothing with generic type T. diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Test-1.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Test-1.verified.md index 5a0484a32fe..f0d735e3bcf 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Test-1.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Test-1.verified.md @@ -1,7 +1,7 @@ -# Class Class1.Test +# Class Class1.Test Namespace: [BuildFromProject](BuildFromProject.md) -Assembly: BuildFromProject.dll +Assembly: BuildFromProject.dll ```csharp public class Class1.Test @@ -11,12 +11,12 @@ public class Class1.Test `T` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Class1.Test](BuildFromProject.Class1.Test\-1.md) -###### Inherited Members +#### 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\)), diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.verified.md index 43297f814ef..80a08dca133 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.verified.md @@ -1,22 +1,22 @@ -# Class Class1 +# Class Class1 Namespace: [BuildFromProject](BuildFromProject.md) -Assembly: BuildFromProject.dll +Assembly: BuildFromProject.dll ```csharp public class Class1 : IClass1 ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Class1](BuildFromProject.Class1.md) -###### Implements +#### Implements IClass1 -###### Inherited Members +#### 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\)), @@ -28,7 +28,7 @@ IClass1 ## Methods -### Issue1651\(\) +### Issue1651\(\) Pricing models are used to calculate theoretical option values
    • 1Black Scholes
    • 2Black76
    • 3Black76Fut
    • 4Equity Tree
    • 5Variance Swap
    • 6Dividend Forecast
    @@ -37,7 +37,7 @@ Pricing models are used to calculate theoretical option values public void Issue1651() ``` -### Issue1887\(\) +### Issue1887\(\) IConfiguration related helper and extension routines. @@ -45,7 +45,7 @@ IConfiguration related helper and extension routines. public void Issue1887() ``` -### Issue2623\(\) +### Issue2623\(\) ```csharp public void Issue2623() @@ -73,7 +73,7 @@ For example: myClass.Execute(); } -### Issue2723\(\) +### Issue2723\(\) ```csharp public void Issue2723() @@ -95,7 +95,7 @@ var range = new Range { Min = 0, Max = 10 }; 
    var range = new Range<int> { Min = 0, Max = 10 };
    -### Issue4017\(\) +### Issue4017\(\) ```csharp public void Issue4017() @@ -126,7 +126,7 @@ public Task HandleMessageDelete(Cacheable<IMessage, ulong> cachedMessage, myClass.Execute(); } -### Issue4392\(\) +### Issue4392\(\) ```csharp public void Issue4392() @@ -136,7 +136,7 @@ public void Issue4392() @"\\?\" `@"\\?\"` -### Issue7484\(\) +### Issue7484\(\) ```csharp public void Issue7484() @@ -147,7 +147,7 @@ public void Issue7484() There's really no reason to not believe that this class can test things.
    TermDescription
    A TermA Description
    Bee TermBee Description
    -### Issue8764\(\) +### Issue8764\(\) ```csharp public void Issue8764() where T : unmanaged @@ -157,7 +157,7 @@ public void Issue8764() where T : unmanaged `T` -### Issue896\(\) +### Issue896\(\) Test @@ -167,10 +167,10 @@ public void Issue896() #### See Also -[Class1](BuildFromProject.Class1.md).[Test](BuildFromProject.Class1.Test\-1.md) +[Class1](BuildFromProject.Class1.md).[Test](BuildFromProject.Class1.Test\-1.md), [Class1](BuildFromProject.Class1.md) -### Issue9216\(\) +### Issue9216\(\) Calculates the determinant of a 3-dimensional matrix: @@ -186,9 +186,9 @@ public static double Issue9216() #### Returns -[double](https://learn.microsoft.com/dotnet/api/system.double) + [double](https://learn.microsoft.com/dotnet/api/system.double) -### XmlCommentIncludeTag\(\) +### XmlCommentIncludeTag\(\) This method should do something... diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.IInheritdoc.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.IInheritdoc.verified.md index 06d10f9501d..b6401eab1b5 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.IInheritdoc.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.IInheritdoc.verified.md @@ -1,7 +1,7 @@ -# Interface IInheritdoc +# Interface IInheritdoc Namespace: [BuildFromProject](BuildFromProject.md) -Assembly: BuildFromProject.dll +Assembly: BuildFromProject.dll ```csharp public interface IInheritdoc @@ -9,7 +9,7 @@ public interface IInheritdoc ## Methods -### Issue7629\(\) +### Issue7629\(\) This method should do something... diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue6366.Class1-1.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue6366.Class1-1.verified.md index eb099b1a84e..c96f0a79ef3 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue6366.Class1-1.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue6366.Class1-1.verified.md @@ -1,7 +1,7 @@ -# Class Inheritdoc.Issue6366.Class1 +# Class Inheritdoc.Issue6366.Class1 Namespace: [BuildFromProject](BuildFromProject.md) -Assembly: BuildFromProject.dll +Assembly: BuildFromProject.dll ```csharp public abstract class Inheritdoc.Issue6366.Class1 @@ -11,12 +11,12 @@ public abstract class Inheritdoc.Issue6366.Class1 `T` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Inheritdoc.Issue6366.Class1](BuildFromProject.Inheritdoc.Issue6366.Class1\-1.md) -###### Inherited Members +#### 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\)), @@ -28,7 +28,7 @@ public abstract class Inheritdoc.Issue6366.Class1 ## Methods -### TestMethod1\(T, int\) +### TestMethod1\(T, int\) This text inherited. @@ -48,7 +48,7 @@ This text inherited. #### Returns -T + T This text inherited. diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue6366.Class2.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue6366.Class2.verified.md index e106c06586f..b19228b7c6d 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue6366.Class2.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue6366.Class2.verified.md @@ -1,19 +1,19 @@ -# Class Inheritdoc.Issue6366.Class2 +# Class Inheritdoc.Issue6366.Class2 Namespace: [BuildFromProject](BuildFromProject.md) -Assembly: BuildFromProject.dll +Assembly: BuildFromProject.dll ```csharp public class Inheritdoc.Issue6366.Class2 : Inheritdoc.Issue6366.Class1 ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Inheritdoc.Issue6366.Class1](BuildFromProject.Inheritdoc.Issue6366.Class1\-1.md) ← [Inheritdoc.Issue6366.Class2](BuildFromProject.Inheritdoc.Issue6366.Class2.md) -###### Inherited Members +#### Inherited Members [Inheritdoc.Issue6366.Class1.TestMethod1\(bool, int\)](BuildFromProject.Inheritdoc.Issue6366.Class1\-1.md\#BuildFromProject\_Inheritdoc\_Issue6366\_Class1\_1\_TestMethod1\_\_0\_System\_Int32\_), [object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)), @@ -26,7 +26,7 @@ public class Inheritdoc.Issue6366.Class2 : Inheritdoc.Issue6366.Class1 ## Methods -### TestMethod1\(bool, int\) +### TestMethod1\(bool, int\) This text inherited. @@ -46,7 +46,7 @@ This text inherited. #### Returns -[bool](https://learn.microsoft.com/dotnet/api/system.boolean) + [bool](https://learn.microsoft.com/dotnet/api/system.boolean) This text inherited. diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue6366.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue6366.verified.md index 7d7845bccf5..dbc941a5f60 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue6366.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue6366.verified.md @@ -1,18 +1,18 @@ -# Class Inheritdoc.Issue6366 +# Class Inheritdoc.Issue6366 Namespace: [BuildFromProject](BuildFromProject.md) -Assembly: BuildFromProject.dll +Assembly: BuildFromProject.dll ```csharp public class Inheritdoc.Issue6366 ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Inheritdoc.Issue6366](BuildFromProject.Inheritdoc.Issue6366.md) -###### Inherited Members +#### 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\)), diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue7035.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue7035.verified.md index 26b30421e5f..ee4a1827cad 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue7035.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue7035.verified.md @@ -1,18 +1,18 @@ -# Class Inheritdoc.Issue7035 +# Class Inheritdoc.Issue7035 Namespace: [BuildFromProject](BuildFromProject.md) -Assembly: BuildFromProject.dll +Assembly: BuildFromProject.dll ```csharp public class Inheritdoc.Issue7035 ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Inheritdoc.Issue7035](BuildFromProject.Inheritdoc.Issue7035.md) -###### Inherited Members +#### 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\)), @@ -24,13 +24,13 @@ public class Inheritdoc.Issue7035 ## Methods -### A\(\) +### A\(\) ```csharp public void A() ``` -### B\(\) +### B\(\) ```csharp public void B() diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue7484.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue7484.verified.md index bed9b11dc3e..f5c3bde8213 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue7484.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue7484.verified.md @@ -1,7 +1,7 @@ -# Class Inheritdoc.Issue7484 +# Class Inheritdoc.Issue7484 Namespace: [BuildFromProject](BuildFromProject.md) -Assembly: BuildFromProject.dll +Assembly: BuildFromProject.dll This is a test class to have something for DocFX to document. @@ -9,12 +9,12 @@ This is a test class to have something for DocFX to document. public class Inheritdoc.Issue7484 ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Inheritdoc.Issue7484](BuildFromProject.Inheritdoc.Issue7484.md) -###### Inherited Members +#### 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\)), @@ -35,7 +35,7 @@ A string that could have something. ## Constructors -### Issue7484\(\) +### Issue7484\(\) This is a constructor to document. @@ -45,7 +45,7 @@ public Issue7484() ## Properties -### DoDad +### DoDad A string that could have something. @@ -55,11 +55,11 @@ public string DoDad { get; } #### Property Value -[string](https://learn.microsoft.com/dotnet/api/system.string) + [string](https://learn.microsoft.com/dotnet/api/system.string) ## Methods -### BoolReturningMethod\(bool\) +### BoolReturningMethod\(bool\) Simple method to generate docs for. @@ -75,7 +75,7 @@ A meaningless boolean value, much like most questions in the world. #### Returns -[bool](https://learn.microsoft.com/dotnet/api/system.boolean) + [bool](https://learn.microsoft.com/dotnet/api/system.boolean) An exactly equivalently meaningless boolean value, much like most answers in the world. diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue8101.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue8101.verified.md index daa5b06615e..f529d852ba3 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue8101.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue8101.verified.md @@ -1,18 +1,18 @@ -# Class Inheritdoc.Issue8101 +# Class Inheritdoc.Issue8101 Namespace: [BuildFromProject](BuildFromProject.md) -Assembly: BuildFromProject.dll +Assembly: BuildFromProject.dll ```csharp public class Inheritdoc.Issue8101 ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Inheritdoc.Issue8101](BuildFromProject.Inheritdoc.Issue8101.md) -###### Inherited Members +#### 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\)), @@ -24,7 +24,7 @@ public class Inheritdoc.Issue8101 ## Methods -### Tween\(float, float, float, Action\) +### Tween\(float, float, float, Action\) Create a new tween. @@ -52,11 +52,11 @@ A callback that will be invoked every time the tween value changes. #### Returns -[object](https://learn.microsoft.com/dotnet/api/system.object) + [object](https://learn.microsoft.com/dotnet/api/system.object) The newly created tween instance. -### Tween\(int, int, float, Action\) +### Tween\(int, int, float, Action\) Create a new tween. @@ -84,7 +84,7 @@ A callback that will be invoked every time the tween value changes. #### Returns -[object](https://learn.microsoft.com/dotnet/api/system.object) + [object](https://learn.microsoft.com/dotnet/api/system.object) The newly created tween instance. diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue8129.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue8129.verified.md index 60c15be505e..7bb7a4419e4 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue8129.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.Issue8129.verified.md @@ -1,13 +1,13 @@ -# Struct Inheritdoc.Issue8129 +# Struct Inheritdoc.Issue8129 Namespace: [BuildFromProject](BuildFromProject.md) -Assembly: BuildFromProject.dll +Assembly: BuildFromProject.dll ```csharp public struct Inheritdoc.Issue8129 ``` -###### Inherited Members +#### 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\)), @@ -18,7 +18,7 @@ public struct Inheritdoc.Issue8129 ## Constructors -### Issue8129\(string\) +### Issue8129\(string\) ```csharp public Issue8129(string foo) diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.verified.md index 885789ae020..2f5bfe0aa50 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Inheritdoc.verified.md @@ -1,23 +1,23 @@ -# Class Inheritdoc +# Class Inheritdoc Namespace: [BuildFromProject](BuildFromProject.md) -Assembly: BuildFromProject.dll +Assembly: BuildFromProject.dll ```csharp public class Inheritdoc : IInheritdoc, IDisposable ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Inheritdoc](BuildFromProject.Inheritdoc.md) -###### Implements +#### Implements [IInheritdoc](BuildFromProject.IInheritdoc.md), [IDisposable](https://learn.microsoft.com/dotnet/api/system.idisposable) -###### Inherited Members +#### 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\)), @@ -29,7 +29,7 @@ public class Inheritdoc : IInheritdoc, IDisposable ## Methods -### Dispose\(\) +### Dispose\(\) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. @@ -37,7 +37,7 @@ Performs application-defined tasks associated with freeing, releasing, or resett public void Dispose() ``` -### Issue7628\(\) +### Issue7628\(\) This method should do something... @@ -45,7 +45,7 @@ This method should do something... public void Issue7628() ``` -### Issue7629\(\) +### Issue7629\(\) This method should do something... diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.A.A.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.A.A.verified.md index dd2aed7cf69..1d78fa256cf 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.A.A.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.A.A.verified.md @@ -1,18 +1,18 @@ -# Class A +# Class A Namespace: [BuildFromProject.Issue8540.A](BuildFromProject.Issue8540.A.md) -Assembly: BuildFromProject.dll +Assembly: BuildFromProject.dll ```csharp public class A ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [A](BuildFromProject.Issue8540.A.A.md) -###### Inherited Members +#### 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\)), diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.A.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.A.verified.md index 2631a9836b8..78825fc21e9 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.A.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.A.verified.md @@ -1,6 +1,6 @@ -# Namespace BuildFromProject.Issue8540.A +# Namespace BuildFromProject.Issue8540.A ### Classes -[A](BuildFromProject.Issue8540.A.A.md) + [A](BuildFromProject.Issue8540.A.A.md) diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.B.B.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.B.B.verified.md index d3d78bdcea0..02203b648c4 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.B.B.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.B.B.verified.md @@ -1,18 +1,18 @@ -# Class B +# Class B Namespace: [BuildFromProject.Issue8540.B](BuildFromProject.Issue8540.B.md) -Assembly: BuildFromProject.dll +Assembly: BuildFromProject.dll ```csharp public class B ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [B](BuildFromProject.Issue8540.B.B.md) -###### Inherited Members +#### 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\)), diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.B.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.B.verified.md index 32af83dd3a3..1bae43c16f5 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.B.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.B.verified.md @@ -1,6 +1,6 @@ -# Namespace BuildFromProject.Issue8540.B +# Namespace BuildFromProject.Issue8540.B ### Classes -[B](BuildFromProject.Issue8540.B.B.md) + [B](BuildFromProject.Issue8540.B.B.md) diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.verified.md index c2d031df469..53be9e79bb2 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Issue8540.verified.md @@ -1,8 +1,8 @@ -# Namespace BuildFromProject.Issue8540 +# Namespace BuildFromProject.Issue8540 ### Namespaces -[BuildFromProject.Issue8540.A](BuildFromProject.Issue8540.A.md) + [BuildFromProject.Issue8540.A](BuildFromProject.Issue8540.A.md) -[BuildFromProject.Issue8540.B](BuildFromProject.Issue8540.B.md) + [BuildFromProject.Issue8540.B](BuildFromProject.Issue8540.B.md) diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.verified.md index 784ebcdd466..c3c68be8fbd 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.verified.md @@ -1,44 +1,44 @@ -# Namespace BuildFromProject +# Namespace BuildFromProject ### Namespaces -[BuildFromProject.Issue8540](BuildFromProject.Issue8540.md) + [BuildFromProject.Issue8540](BuildFromProject.Issue8540.md) ### Classes -[Inheritdoc.Issue6366.Class1](BuildFromProject.Inheritdoc.Issue6366.Class1\-1.md) + [Inheritdoc.Issue6366.Class1](BuildFromProject.Inheritdoc.Issue6366.Class1\-1.md) -[Class1](BuildFromProject.Class1.md) + [Class1](BuildFromProject.Class1.md) -[Inheritdoc.Issue6366.Class2](BuildFromProject.Inheritdoc.Issue6366.Class2.md) + [Inheritdoc.Issue6366.Class2](BuildFromProject.Inheritdoc.Issue6366.Class2.md) -[Inheritdoc](BuildFromProject.Inheritdoc.md) + [Inheritdoc](BuildFromProject.Inheritdoc.md) -[Inheritdoc.Issue6366](BuildFromProject.Inheritdoc.Issue6366.md) + [Inheritdoc.Issue6366](BuildFromProject.Inheritdoc.Issue6366.md) -[Inheritdoc.Issue7035](BuildFromProject.Inheritdoc.Issue7035.md) + [Inheritdoc.Issue7035](BuildFromProject.Inheritdoc.Issue7035.md) -[Inheritdoc.Issue7484](BuildFromProject.Inheritdoc.Issue7484.md) + [Inheritdoc.Issue7484](BuildFromProject.Inheritdoc.Issue7484.md) This is a test class to have something for DocFX to document. -[Inheritdoc.Issue8101](BuildFromProject.Inheritdoc.Issue8101.md) + [Inheritdoc.Issue8101](BuildFromProject.Inheritdoc.Issue8101.md) -[Class1.Issue8665](BuildFromProject.Class1.Issue8665.md) + [Class1.Issue8665](BuildFromProject.Class1.Issue8665.md) -[Class1.Issue8696Attribute](BuildFromProject.Class1.Issue8696Attribute.md) + [Class1.Issue8696Attribute](BuildFromProject.Class1.Issue8696Attribute.md) -[Class1.Issue8948](BuildFromProject.Class1.Issue8948.md) + [Class1.Issue8948](BuildFromProject.Class1.Issue8948.md) -[Class1.Test](BuildFromProject.Class1.Test\-1.md) + [Class1.Test](BuildFromProject.Class1.Test\-1.md) ### Structs -[Inheritdoc.Issue8129](BuildFromProject.Inheritdoc.Issue8129.md) + [Inheritdoc.Issue8129](BuildFromProject.Inheritdoc.Issue8129.md) ### Interfaces -[IInheritdoc](BuildFromProject.IInheritdoc.md) + [IInheritdoc](BuildFromProject.IInheritdoc.md) -[Class1.IIssue8948](BuildFromProject.Class1.IIssue8948.md) + [Class1.IIssue8948](BuildFromProject.Class1.IIssue8948.md) diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromVBSourceCode.BaseClass1.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromVBSourceCode.BaseClass1.verified.md index 02e2b0f39e4..975d78e8206 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromVBSourceCode.BaseClass1.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromVBSourceCode.BaseClass1.verified.md @@ -1,6 +1,6 @@ -# Class BaseClass1 +# Class BaseClass1 -Namespace: [BuildFromVBSourceCode](BuildFromVBSourceCode.md) +Namespace: [BuildFromVBSourceCode](BuildFromVBSourceCode.md) This is the BaseClass @@ -8,16 +8,16 @@ This is the BaseClass public abstract class BaseClass1 ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [BaseClass1](BuildFromVBSourceCode.BaseClass1.md) -###### Derived +#### Derived [Class1](BuildFromVBSourceCode.Class1.md) -###### Inherited Members +#### 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\)), @@ -30,7 +30,7 @@ public abstract class BaseClass1 ## Methods -### WithDeclarationKeyword\(Class1\) +### WithDeclarationKeyword\(Class1\) ```csharp public abstract DateTime WithDeclarationKeyword(Class1 keyword) @@ -42,5 +42,5 @@ public abstract DateTime WithDeclarationKeyword(Class1 keyword) #### Returns -[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime) + [DateTime](https://learn.microsoft.com/dotnet/api/system.datetime) diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromVBSourceCode.Class1.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromVBSourceCode.Class1.verified.md index 80cc2fa42e0..2b4a66b16eb 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromVBSourceCode.Class1.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromVBSourceCode.Class1.verified.md @@ -1,6 +1,6 @@ -# Class Class1 +# Class Class1 -Namespace: [BuildFromVBSourceCode](BuildFromVBSourceCode.md) +Namespace: [BuildFromVBSourceCode](BuildFromVBSourceCode.md) This is summary from vb class... @@ -8,13 +8,13 @@ This is summary from vb class... public class Class1 : BaseClass1 ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [BaseClass1](BuildFromVBSourceCode.BaseClass1.md) ← [Class1](BuildFromVBSourceCode.Class1.md) -###### Inherited Members +#### Inherited Members [BaseClass1.WithDeclarationKeyword\(Class1\)](BuildFromVBSourceCode.BaseClass1.md\#BuildFromVBSourceCode\_BaseClass1\_WithDeclarationKeyword\_BuildFromVBSourceCode\_Class1\_), [object.Equals\(object\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)), @@ -28,7 +28,7 @@ public class Class1 : BaseClass1 ## Fields -### ValueClass +### ValueClass This is a *Value* type @@ -38,11 +38,11 @@ public Class1 ValueClass #### Field Value -[Class1](BuildFromVBSourceCode.Class1.md) + [Class1](BuildFromVBSourceCode.Class1.md) ## Properties -### Keyword +### Keyword ```csharp [Obsolete("This member is obsolete.", true)] @@ -51,11 +51,11 @@ public Class1 Keyword { get; } #### Property Value -[Class1](BuildFromVBSourceCode.Class1.md) + [Class1](BuildFromVBSourceCode.Class1.md) ## Methods -### Value\(string\) +### Value\(string\) This is a *Function* @@ -72,12 +72,12 @@ Name as the **String** #### Returns -[int](https://learn.microsoft.com/dotnet/api/system.int32) + [int](https://learn.microsoft.com/dotnet/api/system.int32) **Returns** Ahooo -### WithDeclarationKeyword\(Class1\) +### WithDeclarationKeyword\(Class1\) What is **Sub**? @@ -91,5 +91,5 @@ public override DateTime WithDeclarationKeyword(Class1 keyword) #### Returns -[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime) + [DateTime](https://learn.microsoft.com/dotnet/api/system.datetime) diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromVBSourceCode.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromVBSourceCode.verified.md index e0e599d9f66..594703abca7 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromVBSourceCode.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromVBSourceCode.verified.md @@ -1,12 +1,12 @@ -# Namespace BuildFromVBSourceCode +# Namespace BuildFromVBSourceCode ### Classes -[BaseClass1](BuildFromVBSourceCode.BaseClass1.md) + [BaseClass1](BuildFromVBSourceCode.BaseClass1.md) This is the BaseClass -[Class1](BuildFromVBSourceCode.Class1.md) + [Class1](BuildFromVBSourceCode.Class1.md) This is summary from vb class... 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 1b3d98a5d5d..5a3969a8f3c 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 @@ -1,7 +1,7 @@ -# Class Cat +# Class Cat Namespace: [CatLibrary](CatLibrary.md) -Assembly: CatLibrary.dll +Assembly: CatLibrary.dll

    Here's main class of this Demo.

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

    @@ -24,17 +24,17 @@ This type should be class and can new instance. This type is a struct type, class type can't be used for this parameter. -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Cat](CatLibrary.Cat\-2.md) -###### Implements +#### Implements [ICat](CatLibrary.ICat.md), [IAnimal](CatLibrary.IAnimal.md) -###### Inherited Members +#### 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\)), @@ -44,7 +44,7 @@ This type is a struct type, class type can't be used for this parameter. [object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals), [object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring) -###### Extension Methods +#### Extension Methods [ICatExtension.Play\(ICat, ContainersRefType.ColorType\)](CatLibrary.ICatExtension.md\#CatLibrary\_ICatExtension\_Play\_CatLibrary\_ICat\_CatLibrary\_Core\_ContainersRefType\_ColorType\_), [ICatExtension.Sleep\(ICat, long\)](CatLibrary.ICatExtension.md\#CatLibrary\_ICatExtension\_Sleep\_CatLibrary\_ICat\_System\_Int64\_) @@ -66,7 +66,7 @@ unsafe ## Constructors -### Cat\(\) +### Cat\(\) Default constructor. @@ -74,7 +74,7 @@ Default constructor. public Cat() ``` -### Cat\(T\) +### Cat\(T\) Constructor with one generic parameter. @@ -88,7 +88,7 @@ public Cat(T ownType) This parameter type defined by class. -### Cat\(string, out int, string, bool\) +### Cat\(string, out int, string, bool\) It's a complex constructor. The parameter will have some attributes. @@ -116,7 +116,7 @@ It's an in parameter. ## Fields -### isHealthy +### isHealthy Field with attribute. @@ -128,11 +128,11 @@ public bool isHealthy #### Field Value -[bool](https://learn.microsoft.com/dotnet/api/system.boolean) + [bool](https://learn.microsoft.com/dotnet/api/system.boolean) ## Properties -### Age +### Age Hint cat's age. @@ -142,9 +142,9 @@ protected int Age { get; set; } #### Property Value -[int](https://learn.microsoft.com/dotnet/api/system.int32) + [int](https://learn.microsoft.com/dotnet/api/system.int32) -### Name +### Name EII property. @@ -154,9 +154,9 @@ public string Name { get; } #### Property Value -[string](https://learn.microsoft.com/dotnet/api/system.string) + [string](https://learn.microsoft.com/dotnet/api/system.string) -### this\[string\] +### this\[string\] This is index property of Cat. You can see that the visibility is different between get and set method. @@ -166,11 +166,11 @@ public int this[string a] { protected get; set; } #### Property Value -[int](https://learn.microsoft.com/dotnet/api/system.int32) + [int](https://learn.microsoft.com/dotnet/api/system.int32) ## Methods -### CalculateFood\(DateTime\) +### CalculateFood\(DateTime\) It's a method with complex return type. @@ -186,11 +186,11 @@ Date time to now. #### Returns -[Dictionary](https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary\-2)<[string](https://learn.microsoft.com/dotnet/api/system.string), [List](https://learn.microsoft.com/dotnet/api/system.collections.generic.list\-1)<[int](https://learn.microsoft.com/dotnet/api/system.int32)\>\> + [Dictionary](https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary\-2)<[string](https://learn.microsoft.com/dotnet/api/system.string), [List](https://learn.microsoft.com/dotnet/api/system.collections.generic.list\-1)<[int](https://learn.microsoft.com/dotnet/api/system.int32)\>\> It's a relationship map of different kind food. -### Equals\(object\) +### Equals\(object\) Override the method of Object.Equals(object obj). @@ -206,11 +206,11 @@ Can pass any class type. #### Returns -[bool](https://learn.microsoft.com/dotnet/api/system.boolean) + [bool](https://learn.microsoft.com/dotnet/api/system.boolean) The return value tell you whehter the compare operation is successful. -### GetTailLength\(int\*, params object\[\]\) +### GetTailLength\(int\*, params object\[\]\) It's an unsafe method. As you see, catName is a pointer, so we need to add unsafe keyword. @@ -231,11 +231,11 @@ Optional parameters. #### Returns -[long](https://learn.microsoft.com/dotnet/api/system.int64) + [long](https://learn.microsoft.com/dotnet/api/system.int64) Return cat tail's length. -### Jump\(T, K, ref bool\) +### Jump\(T, K, ref bool\) This method have attribute above it. @@ -260,11 +260,11 @@ Hint whether this cat has cheat mode. #### Exceptions -[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception) + [ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception) This is an argument exception -### ownEat +### ownEat Eat event of this cat @@ -274,11 +274,11 @@ public event EventHandler ownEat #### Event Type -[EventHandler](https://learn.microsoft.com/dotnet/api/system.eventhandler) + [EventHandler](https://learn.microsoft.com/dotnet/api/system.eventhandler) ## Operators -### operator \+\(Cat, int\) +### operator \+\(Cat, int\) Addition operator of this class. @@ -298,11 +298,11 @@ public static int operator +(Cat lsr, int rsr) #### Returns -[int](https://learn.microsoft.com/dotnet/api/system.int32) + [int](https://learn.microsoft.com/dotnet/api/system.int32) Result with int type. -### explicit operator Tom\(Cat\) +### explicit operator Tom\(Cat\) Expilicit operator of this class.

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

    @@ -319,11 +319,11 @@ Instance of this class. #### Returns -[Tom](CatLibrary.Tom.md) + [Tom](CatLibrary.Tom.md) Advanced class type of cat. -### operator \-\(Cat, int\) +### operator \-\(Cat, int\) Similar with operaotr +, refer to that topic. @@ -339,5 +339,5 @@ public static int operator -(Cat lsr, int rsr) #### Returns -[int](https://learn.microsoft.com/dotnet/api/system.int32) + [int](https://learn.microsoft.com/dotnet/api/system.int32) diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.CatException-1.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.CatException-1.verified.md index acd5d2e5c81..4831a85a189 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.CatException-1.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.CatException-1.verified.md @@ -1,7 +1,7 @@ -# Class CatException +# Class CatException Namespace: [CatLibrary](CatLibrary.md) -Assembly: CatLibrary.dll +Assembly: CatLibrary.dll ```csharp public class CatException : Exception, ISerializable @@ -11,17 +11,17 @@ public class CatException : Exception, ISerializable `T` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Exception](https://learn.microsoft.com/dotnet/api/system.exception) ← [CatException](CatLibrary.CatException\-1.md) -###### Implements +#### Implements [ISerializable](https://learn.microsoft.com/dotnet/api/system.runtime.serialization.iserializable) -###### Inherited Members +#### Inherited Members [Exception.GetBaseException\(\)](https://learn.microsoft.com/dotnet/api/system.exception.getbaseexception), [Exception.GetObjectData\(SerializationInfo, StreamingContext\)](https://learn.microsoft.com/dotnet/api/system.exception.getobjectdata), diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Complex-2.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Complex-2.verified.md index af965fad182..3689ea5840b 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Complex-2.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Complex-2.verified.md @@ -1,7 +1,7 @@ -# Class Complex +# Class Complex Namespace: [CatLibrary](CatLibrary.md) -Assembly: CatLibrary.dll +Assembly: CatLibrary.dll ```csharp public class Complex @@ -13,12 +13,12 @@ public class Complex `J` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Complex](CatLibrary.Complex\-2.md) -###### Inherited Members +#### 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\)), diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.ColorType.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.ColorType.verified.md index 719c9796f6d..7b4cc82d237 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.ColorType.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.ColorType.verified.md @@ -1,7 +1,7 @@ -# Enum ContainersRefType.ColorType +# Enum ContainersRefType.ColorType Namespace: [CatLibrary.Core](CatLibrary.Core.md) -Assembly: CatLibrary.Core.dll +Assembly: CatLibrary.Core.dll Enumeration ColorType diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.verified.md index cc9cba725c1..fb9c9373ced 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.verified.md @@ -1,18 +1,18 @@ -# Class ContainersRefType.ContainersRefTypeChild +# Class ContainersRefType.ContainersRefTypeChild Namespace: [CatLibrary.Core](CatLibrary.Core.md) -Assembly: CatLibrary.Core.dll +Assembly: CatLibrary.Core.dll ```csharp public class ContainersRefType.ContainersRefTypeChild ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [ContainersRefType.ContainersRefTypeChild](CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.md) -###### Inherited Members +#### 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\)), diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.verified.md index 8e06dbdf553..cb871561b9a 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.verified.md @@ -1,7 +1,7 @@ -# Interface ContainersRefType.ContainersRefTypeChildInterface +# Interface ContainersRefType.ContainersRefTypeChildInterface Namespace: [CatLibrary.Core](CatLibrary.Core.md) -Assembly: CatLibrary.Core.dll +Assembly: CatLibrary.Core.dll ```csharp public interface ContainersRefType.ContainersRefTypeChildInterface diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.verified.md index 768ed241aa1..6304a168814 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.verified.md @@ -1,7 +1,7 @@ -# Delegate ContainersRefType.ContainersRefTypeDelegate +# Delegate ContainersRefType.ContainersRefTypeDelegate Namespace: [CatLibrary.Core](CatLibrary.Core.md) -Assembly: CatLibrary.Core.dll +Assembly: CatLibrary.Core.dll Delegate ContainersRefTypeDelegate diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.verified.md index bff4928b69d..ae0f6a1680c 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ContainersRefType.verified.md @@ -1,7 +1,7 @@ -# Struct ContainersRefType +# Struct ContainersRefType Namespace: [CatLibrary.Core](CatLibrary.Core.md) -Assembly: CatLibrary.Core.dll +Assembly: CatLibrary.Core.dll Struct ContainersRefType @@ -9,7 +9,7 @@ Struct ContainersRefType public struct ContainersRefType ``` -###### Inherited Members +#### 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\)), @@ -18,14 +18,14 @@ public struct ContainersRefType [object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals), [object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring) -###### Extension Methods +#### Extension Methods [Issue231.Bar\(ContainersRefType\)](CatLibrary.Core.Issue231.md\#CatLibrary\_Core\_Issue231\_Bar\_CatLibrary\_Core\_ContainersRefType\_), [Issue231.Foo\(ContainersRefType\)](CatLibrary.Core.Issue231.md\#CatLibrary\_Core\_Issue231\_Foo\_CatLibrary\_Core\_ContainersRefType\_) ## Fields -### ColorCount +### ColorCount ColorCount @@ -35,11 +35,11 @@ public long ColorCount #### Field Value -[long](https://learn.microsoft.com/dotnet/api/system.int64) + [long](https://learn.microsoft.com/dotnet/api/system.int64) ## Properties -### GetColorCount +### GetColorCount GetColorCount @@ -49,11 +49,11 @@ public long GetColorCount { get; } #### Property Value -[long](https://learn.microsoft.com/dotnet/api/system.int64) + [long](https://learn.microsoft.com/dotnet/api/system.int64) ## Methods -### ContainersRefTypeNonRefMethod\(params object\[\]\) +### ContainersRefTypeNonRefMethod\(params object\[\]\) ContainersRefTypeNonRefMethod array @@ -68,9 +68,9 @@ public static int ContainersRefTypeNonRefMethod(params object[] parmsArray) #### Returns -[int](https://learn.microsoft.com/dotnet/api/system.int32) + [int](https://learn.microsoft.com/dotnet/api/system.int32) -### ContainersRefTypeEventHandler +### ContainersRefTypeEventHandler ```csharp public event EventHandler ContainersRefTypeEventHandler @@ -78,5 +78,5 @@ public event EventHandler ContainersRefTypeEventHandler #### Event Type -[EventHandler](https://learn.microsoft.com/dotnet/api/system.eventhandler) + [EventHandler](https://learn.microsoft.com/dotnet/api/system.eventhandler) diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ExplicitLayoutClass.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ExplicitLayoutClass.verified.md index 7eaad93b65b..41b7fc0d426 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ExplicitLayoutClass.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.ExplicitLayoutClass.verified.md @@ -1,18 +1,18 @@ -# Class ExplicitLayoutClass +# Class ExplicitLayoutClass Namespace: [CatLibrary.Core](CatLibrary.Core.md) -Assembly: CatLibrary.Core.dll +Assembly: CatLibrary.Core.dll ```csharp public class ExplicitLayoutClass ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [ExplicitLayoutClass](CatLibrary.Core.ExplicitLayoutClass.md) -###### Inherited Members +#### 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\)), diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.Issue231.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.Issue231.verified.md index f5f1feb2aa9..2cc25ce3cc1 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.Issue231.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.Issue231.verified.md @@ -1,18 +1,18 @@ -# Class Issue231 +# Class Issue231 Namespace: [CatLibrary.Core](CatLibrary.Core.md) -Assembly: CatLibrary.dll, CatLibrary.Core.dll +Assembly: CatLibrary.dll, CatLibrary.Core.dll ```csharp public static class Issue231 ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Issue231](CatLibrary.Core.Issue231.md) -###### Inherited Members +#### 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\)), @@ -24,7 +24,7 @@ public static class Issue231 ## Methods -### Bar\(ContainersRefType\) +### Bar\(ContainersRefType\) ```csharp public static void Bar(this ContainersRefType c) @@ -34,7 +34,7 @@ public static void Bar(this ContainersRefType c) `c` [ContainersRefType](CatLibrary.Core.ContainersRefType.md) -### Foo\(ContainersRefType\) +### Foo\(ContainersRefType\) ```csharp public static void Foo(this ContainersRefType c) diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.verified.md index 7e9b34342de..a2ab65462e9 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Core.verified.md @@ -1,34 +1,34 @@ -# Namespace CatLibrary.Core +# Namespace CatLibrary.Core ### Classes -[ContainersRefType.ContainersRefTypeChild](CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.md) + [ContainersRefType.ContainersRefTypeChild](CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.md) -[ExplicitLayoutClass](CatLibrary.Core.ExplicitLayoutClass.md) + [ExplicitLayoutClass](CatLibrary.Core.ExplicitLayoutClass.md) -[Issue231](CatLibrary.Core.Issue231.md) + [Issue231](CatLibrary.Core.Issue231.md) -[Issue231](CatLibrary.Core.Issue231.md) + [Issue231](CatLibrary.Core.Issue231.md) ### Structs -[ContainersRefType](CatLibrary.Core.ContainersRefType.md) + [ContainersRefType](CatLibrary.Core.ContainersRefType.md) Struct ContainersRefType ### Interfaces -[ContainersRefType.ContainersRefTypeChildInterface](CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.md) + [ContainersRefType.ContainersRefTypeChildInterface](CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.md) ### Enums -[ContainersRefType.ColorType](CatLibrary.Core.ContainersRefType.ColorType.md) + [ContainersRefType.ColorType](CatLibrary.Core.ContainersRefType.ColorType.md) Enumeration ColorType ### Delegates -[ContainersRefType.ContainersRefTypeDelegate](CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.md) + [ContainersRefType.ContainersRefTypeDelegate](CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.md) Delegate ContainersRefTypeDelegate diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.FakeDelegate-1.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.FakeDelegate-1.verified.md index 0c889530516..44488a72551 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.FakeDelegate-1.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.FakeDelegate-1.verified.md @@ -1,7 +1,7 @@ -# Delegate FakeDelegate +# Delegate FakeDelegate Namespace: [CatLibrary](CatLibrary.md) -Assembly: CatLibrary.dll +Assembly: CatLibrary.dll Fake delegate @@ -25,7 +25,7 @@ Optional Parameter. #### Returns -[int](https://learn.microsoft.com/dotnet/api/system.int32) + [int](https://learn.microsoft.com/dotnet/api/system.int32) Return a fake number to confuse you. diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.IAnimal.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.IAnimal.verified.md index 9ec948b4171..7152ce8d699 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.IAnimal.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.IAnimal.verified.md @@ -1,7 +1,7 @@ -# Interface IAnimal +# Interface IAnimal Namespace: [CatLibrary](CatLibrary.md) -Assembly: CatLibrary.dll +Assembly: CatLibrary.dll This is basic interface of all animal. @@ -11,7 +11,7 @@ public interface IAnimal ## Properties -### Name +### Name Name of Animal. @@ -21,9 +21,9 @@ string Name { get; } #### Property Value -[string](https://learn.microsoft.com/dotnet/api/system.string) + [string](https://learn.microsoft.com/dotnet/api/system.string) -### this\[int\] +### this\[int\] Return specific number animal's name. @@ -33,11 +33,11 @@ string this[int index] { get; } #### Property Value -[string](https://learn.microsoft.com/dotnet/api/system.string) + [string](https://learn.microsoft.com/dotnet/api/system.string) ## Methods -### Eat\(\) +### Eat\(\) Animal's eat method. @@ -45,7 +45,7 @@ Animal's eat method. void Eat() ``` -### Eat\(Tool\) +### Eat\(Tool\) Overload method of eat. This define the animal eat by which tool. @@ -65,7 +65,7 @@ Tool name. It's a class type. -### Eat\(string\) +### Eat\(string\) Feed the animal with some food diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.ICat.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.ICat.verified.md index 2ba0055291b..1a5c16cb025 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.ICat.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.ICat.verified.md @@ -1,7 +1,7 @@ -# Interface ICat +# Interface ICat Namespace: [CatLibrary](CatLibrary.md) -Assembly: CatLibrary.dll +Assembly: CatLibrary.dll Cat's interface @@ -9,16 +9,16 @@ Cat's interface public interface ICat : IAnimal ``` -###### Implements +#### Implements [IAnimal](CatLibrary.IAnimal.md) -###### Extension Methods +#### Extension Methods [ICatExtension.Play\(ICat, ContainersRefType.ColorType\)](CatLibrary.ICatExtension.md\#CatLibrary\_ICatExtension\_Play\_CatLibrary\_ICat\_CatLibrary\_Core\_ContainersRefType\_ColorType\_), [ICatExtension.Sleep\(ICat, long\)](CatLibrary.ICatExtension.md\#CatLibrary\_ICatExtension\_Sleep\_CatLibrary\_ICat\_System\_Int64\_) -### eat +### eat eat event of cat. Every cat must implement this event. @@ -28,5 +28,5 @@ event EventHandler eat #### Event Type -[EventHandler](https://learn.microsoft.com/dotnet/api/system.eventhandler) + [EventHandler](https://learn.microsoft.com/dotnet/api/system.eventhandler) 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 ad1fa2dcf17..f0ba1fb6128 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.ICatExtension.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.ICatExtension.verified.md @@ -1,7 +1,7 @@ -# Class ICatExtension +# Class ICatExtension Namespace: [CatLibrary](CatLibrary.md) -Assembly: CatLibrary.dll +Assembly: CatLibrary.dll It's the class that contains ICat interface's extension method.

    This class must be public and static.

    @@ -11,12 +11,12 @@ It's the class that contains ICat interface's extension method. public static class ICatExtension ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [ICatExtension](CatLibrary.ICatExtension.md) -###### Inherited Members +#### 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\)), @@ -28,7 +28,7 @@ public static class ICatExtension ## Methods -### Play\(ICat, ColorType\) +### Play\(ICat, ColorType\) Extension method to let cat play @@ -46,7 +46,7 @@ Cat Something to play -### Sleep\(ICat, long\) +### Sleep\(ICat, long\) Extension method hint that how long the cat can sleep. diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.MRefDelegate-3.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.MRefDelegate-3.verified.md index 53536c7a98e..f2406df12f8 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.MRefDelegate-3.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.MRefDelegate-3.verified.md @@ -1,7 +1,7 @@ -# Delegate MRefDelegate +# Delegate MRefDelegate Namespace: [CatLibrary](CatLibrary.md) -Assembly: CatLibrary.dll +Assembly: CatLibrary.dll Generic delegate with many constrains. diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.MRefNormalDelegate.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.MRefNormalDelegate.verified.md index a45a243853e..d9f3eee7b41 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.MRefNormalDelegate.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.MRefNormalDelegate.verified.md @@ -1,7 +1,7 @@ -# Delegate MRefNormalDelegate +# Delegate MRefNormalDelegate Namespace: [CatLibrary](CatLibrary.md) -Assembly: CatLibrary.dll +Assembly: CatLibrary.dll Delegate in the namespace diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Tom.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Tom.verified.md index 4246224ecdb..34d03543a6d 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Tom.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.Tom.verified.md @@ -1,7 +1,7 @@ -# Class Tom +# Class Tom Namespace: [CatLibrary](CatLibrary.md) -Assembly: CatLibrary.dll +Assembly: CatLibrary.dll Tom class is only inherit from Object. Not any member inside itself. @@ -9,16 +9,16 @@ Tom class is only inherit from Object. Not any member inside itself. public class Tom ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Tom](CatLibrary.Tom.md) -###### Derived +#### Derived [TomFromBaseClass](CatLibrary.TomFromBaseClass.md) -###### Inherited Members +#### 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\)), @@ -30,7 +30,7 @@ public class Tom ## Methods -### TomMethod\(Complex, Tuple\) +### TomMethod\(Complex, Tuple\) This is a Tom Method with complex type as return @@ -50,21 +50,21 @@ Another complex input #### Returns -[Complex](CatLibrary.Complex\-2.md)<[string](https://learn.microsoft.com/dotnet/api/system.string), [TomFromBaseClass](CatLibrary.TomFromBaseClass.md)\> + [Complex](CatLibrary.Complex\-2.md)<[string](https://learn.microsoft.com/dotnet/api/system.string), [TomFromBaseClass](CatLibrary.TomFromBaseClass.md)\> Complex @CatLibrary.TomFromBaseClass #### Exceptions -[NotImplementedException](https://learn.microsoft.com/dotnet/api/system.notimplementedexception) + [NotImplementedException](https://learn.microsoft.com/dotnet/api/system.notimplementedexception) This is not implemented -[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception) + [ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception) This is the exception to be thrown when implemented -[CatException](CatLibrary.CatException\-1.md) + [CatException](CatLibrary.CatException\-1.md) This is the exception in current documentation diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.TomFromBaseClass.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.TomFromBaseClass.verified.md index 101c3c03db6..a966e0dbdab 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.TomFromBaseClass.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.TomFromBaseClass.verified.md @@ -1,7 +1,7 @@ -# Class TomFromBaseClass +# Class TomFromBaseClass Namespace: [CatLibrary](CatLibrary.md) -Assembly: CatLibrary.dll +Assembly: CatLibrary.dll *TomFromBaseClass* inherits from @ @@ -9,13 +9,13 @@ Assembly: CatLibrary.dll public class TomFromBaseClass : Tom ``` -###### Inheritance +#### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← [Tom](CatLibrary.Tom.md) ← [TomFromBaseClass](CatLibrary.TomFromBaseClass.md) -###### Inherited Members +#### Inherited Members [Tom.TomMethod\(Complex, Tuple\)](CatLibrary.Tom.md\#CatLibrary\_Tom\_TomMethod\_CatLibrary\_Complex\_CatLibrary\_TomFromBaseClass\_CatLibrary\_TomFromBaseClass\_\_System\_Tuple\_System\_String\_CatLibrary\_Tom\_\_), [object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)), @@ -28,7 +28,7 @@ public class TomFromBaseClass : Tom ## Constructors -### TomFromBaseClass\(int\) +### TomFromBaseClass\(int\) This is a #ctor with parameter diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.verified.md index eddb2725587..9701b5ef723 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/CatLibrary.verified.md @@ -1,12 +1,12 @@ -# Namespace CatLibrary +# Namespace CatLibrary ### Namespaces -[CatLibrary.Core](CatLibrary.Core.md) + [CatLibrary.Core](CatLibrary.Core.md) ### Classes -[Cat](CatLibrary.Cat\-2.md) + [Cat](CatLibrary.Cat\-2.md)

    Here's main class of this Demo.

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

    @@ -14,45 +14,45 @@

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

    The extension method of this class can refer to class

    -[CatException](CatLibrary.CatException\-1.md) + [CatException](CatLibrary.CatException\-1.md) -[Complex](CatLibrary.Complex\-2.md) + [Complex](CatLibrary.Complex\-2.md) -[ICatExtension](CatLibrary.ICatExtension.md) + [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

    -[Tom](CatLibrary.Tom.md) + [Tom](CatLibrary.Tom.md) Tom class is only inherit from Object. Not any member inside itself. -[TomFromBaseClass](CatLibrary.TomFromBaseClass.md) + [TomFromBaseClass](CatLibrary.TomFromBaseClass.md) *TomFromBaseClass* inherits from @ ### Interfaces -[IAnimal](CatLibrary.IAnimal.md) + [IAnimal](CatLibrary.IAnimal.md) This is basic interface of all animal. -[ICat](CatLibrary.ICat.md) + [ICat](CatLibrary.ICat.md) Cat's interface ### Delegates -[FakeDelegate](CatLibrary.FakeDelegate\-1.md) + [FakeDelegate](CatLibrary.FakeDelegate\-1.md) Fake delegate -[MRefDelegate](CatLibrary.MRefDelegate\-3.md) + [MRefDelegate](CatLibrary.MRefDelegate\-3.md) Generic delegate with many constrains. -[MRefNormalDelegate](CatLibrary.MRefNormalDelegate.md) + [MRefNormalDelegate](CatLibrary.MRefNormalDelegate.md) Delegate in the namespace diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/MRef.Demo.Enumeration.ColorType.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/MRef.Demo.Enumeration.ColorType.verified.md index 010fa37fa46..320dc216043 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/MRef.Demo.Enumeration.ColorType.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/MRef.Demo.Enumeration.ColorType.verified.md @@ -1,7 +1,7 @@ -# Enum ColorType +# Enum ColorType Namespace: [MRef.Demo.Enumeration](MRef.Demo.Enumeration.md) -Assembly: CatLibrary.dll +Assembly: CatLibrary.dll Enumeration ColorType diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/MRef.Demo.Enumeration.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/MRef.Demo.Enumeration.verified.md index a17d40d8174..fbc24e4250b 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/MRef.Demo.Enumeration.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/MRef.Demo.Enumeration.verified.md @@ -1,8 +1,8 @@ -# Namespace MRef.Demo.Enumeration +# Namespace MRef.Demo.Enumeration ### Enums -[ColorType](MRef.Demo.Enumeration.ColorType.md) + [ColorType](MRef.Demo.Enumeration.ColorType.md) Enumeration ColorType diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/MRef.Demo.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/MRef.Demo.verified.md index 3e8758b82ca..d8110c381bb 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/MRef.Demo.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/MRef.Demo.verified.md @@ -1,6 +1,6 @@ -# Namespace MRef.Demo +# Namespace MRef.Demo ### Namespaces -[MRef.Demo.Enumeration](MRef.Demo.Enumeration.md) + [MRef.Demo.Enumeration](MRef.Demo.Enumeration.md) diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/MRef.verified.md b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/MRef.verified.md index 85bdca79d8c..ad61f1e7a62 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/MRef.verified.md +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/MRef.verified.md @@ -1,6 +1,6 @@ -# Namespace MRef +# Namespace MRef ### Namespaces -[MRef.Demo](MRef.Demo.md) + [MRef.Demo](MRef.Demo.md) diff --git a/test/docfx.Snapshot.Tests/SamplesTest.cs b/test/docfx.Snapshot.Tests/SamplesTest.cs index 264f99b08cd..0a3be2889da 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.cs +++ b/test/docfx.Snapshot.Tests/SamplesTest.cs @@ -180,7 +180,7 @@ static string NormalizeHtml(string html) } } - [Fact] + [SnapshotFact] public async Task SeedMarkdown() { var samplePath = $"{s_samplesDir}/seed";