From 6a1e6d7eda3339dd5c7cd7a387f5637132122c2d Mon Sep 17 00:00:00 2001 From: Yufei Huang Date: Thu, 30 Mar 2023 11:59:26 +0800 Subject: [PATCH] feat: memberpage plugin -> memberLayout.SeparatePages (#8569) --- docfx.sln | 30 - docs/docs/dotnet-api-docs.md | 12 + ...e.Build.MemberLevelManagedReference.csproj | 12 - .../memberpage/ManagedReference.extension.js | 20 - .../memberpage/ManagedReference.overwrite.js | 10 - .../templates/memberpage/toc.html.js | 74 - samples/extensions/README.md | 2 +- samples/extensions/build/build.csproj | 2 - samples/extensions/docfx.json | 5 +- .../SplitClassPageToMemberLevel.cs | 2 +- .../DotnetApiCatalog.cs | 3 +- .../ExtractMetadata/ExtractMetadataConfig.cs | 2 + .../ExtractMetadata/ExtractMetadataWorker.cs | 7 +- .../ExtractMetadata/NamespaceLayout.cs | 17 - .../ManagedReference/PageViewModel.cs | 4 + .../MetadataJsonConfig.cs | 84 + .../MetadataJsonItemConfig.cs | 60 - .../default/ManagedReference.html.primary.js | 31 +- .../ManagedReference.html.primary.tmpl | 9 + .../partials/class.memberpage.tmpl.partial | 0 .../default}/partials/collection.tmpl.partial | 0 .../partials/customMREFContent.tmpl.partial | 10 +- .../default}/partials/item.tmpl.partial | 0 templates/default/toc.html.js | 86 +- .../modern/partials/class.header.tmpl.partial | 4 +- .../partials/class.memberpage.tmpl.partial | 31 + templates/modern/partials/class.tmpl.partial | 4 + .../modern/partials/collection.tmpl.partial | 3 + .../partials/customMREFContent.tmpl.partial | 3 + templates/modern/partials/item.tmpl.partial | 3 + templates/modern/toc.json.js | 78 + .../ManagedReference.html.primary.js | 47 +- ...rosoft.DocAsCode.Build.Engine.Tests.csproj | 1 - ....ManagedReference.WithPlugins.Tests.csproj | 9 - .../SplitClassPageToMemberLevelTest.cs | 316 --- .../TestData/mref/CatLibrary.Cat`2.yml | 2001 ----------------- ...DocAsCode.Build.SchemaDriven.MergeType.yml | 290 --- .../TestData/mref/ModelItemDictionary/toc.yml | 3 - ...Presentation.Model.ModelItemDictionary.yml | 1890 ---------------- ...management.sql.SqlServer.FirewallRules.yml | 68 - ...crosoft.azure.management.sql.SqlServer.yml | 66 - .../com.microsoft.azure.management.sql.yml | 67 - .../TestData/mref/sql/toc.yml | 11 - .../TestData/mref/toc.yml | 3 - .../template/ManagedReference.html.tmpl | 1 - .../api/toc.html.view.verified.json | 1 + .../api/toc.html.view.verified.json | 1 + .../api/toc.json.view.verified.json | 3 + .../api/toc.verified.json | 2 + .../toc.html.view.verified.json | 4 +- .../toc.json.view.verified.json | 3 + .../SamplesTest.Extensions/toc.verified.json | 2 + .../api/toc.html.view.verified.json | 1 + .../api/toc.json.view.verified.json | 2 +- .../SamplesTest.Seed/api/toc.verified.json | 3 +- .../SamplesTest.Seed/index.verified.json | 2 +- ...BuildFromProject.Class1.html.verified.html | 4 + ...-CatLibrary.Cat-2.html-q-cat.verified.html | 14 + ...api-CatLibrary.html-term-cat.verified.html | 2 + .../html/api-CatLibrary.html.verified.html | 2 + test/docfx.Tests/MetadataCommandTest.cs | 14 +- 61 files changed, 457 insertions(+), 4984 deletions(-) delete mode 100644 plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/Microsoft.DocAsCode.Build.MemberLevelManagedReference.csproj delete mode 100644 plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/ManagedReference.extension.js delete mode 100644 plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/ManagedReference.overwrite.js delete mode 100644 plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/toc.html.js rename {plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference => src/Microsoft.DocAsCode.Build.ManagedReference}/SplitClassPageToMemberLevel.cs (99%) delete mode 100644 src/Microsoft.DocAsCode.Dotnet/ExtractMetadata/NamespaceLayout.cs delete mode 100644 src/Microsoft.DocAsCode.Dotnet/MetadataJsonItemConfig.cs rename plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/partials/class.tmpl.partial => templates/default/partials/class.memberpage.tmpl.partial (100%) rename {plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage => templates/default}/partials/collection.tmpl.partial (100%) rename {plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage => templates/default}/partials/item.tmpl.partial (100%) create mode 100644 templates/modern/partials/class.memberpage.tmpl.partial create mode 100644 templates/modern/partials/collection.tmpl.partial rename {plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage => templates/modern}/partials/customMREFContent.tmpl.partial (68%) create mode 100644 templates/modern/partials/item.tmpl.partial delete mode 100644 test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests.csproj delete mode 100644 test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/SplitClassPageToMemberLevelTest.cs delete mode 100644 test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/CatLibrary.Cat`2.yml delete mode 100644 test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/Microsoft.DocAsCode.Build.SchemaDriven.MergeType.yml delete mode 100644 test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/ModelItemDictionary/toc.yml delete mode 100644 test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/System.Activities.Presentation.Model.ModelItemDictionary.yml delete mode 100644 test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/com.microsoft.azure.management.sql.SqlServer.FirewallRules.yml delete mode 100644 test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/com.microsoft.azure.management.sql.SqlServer.yml delete mode 100644 test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/com.microsoft.azure.management.sql.yml delete mode 100644 test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/sql/toc.yml delete mode 100644 test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/toc.yml delete mode 100644 test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/template/ManagedReference.html.tmpl create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Extensions/api/toc.json.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Extensions/api/toc.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Extensions/toc.json.view.verified.json create mode 100644 test/docfx.Snapshot.Tests/SamplesTest.Extensions/toc.verified.json diff --git a/docfx.sln b/docfx.sln index 742a7c72e35..9c88eaae8ce 100644 --- a/docfx.sln +++ b/docfx.sln @@ -64,14 +64,10 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.DocAsCode.Common. EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.DocAsCode.Glob.Tests", "test\Microsoft.DocAsCode.Glob.Tests\Microsoft.DocAsCode.Glob.Tests.csproj", "{A95C5BAE-1D0D-44FD-A984-7CBF055A62E2}" EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.DocAsCode.Build.MemberLevelManagedReference", "plugins\Microsoft.DocAsCode.Build.MemberLevelManagedReference\Microsoft.DocAsCode.Build.MemberLevelManagedReference.csproj", "{2746DA6E-D310-4F07-B41B-929BB3D6E14B}" -EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.DocAsCode.Plugins.Tests", "test\Microsoft.DocAsCode.Plugins.Tests\Microsoft.DocAsCode.Plugins.Tests.csproj", "{B3EEB5FE-CF39-4CC7-9650-5709E71D2BA9}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.DocAsCode.Build.ManagedReference.Tests", "test\Microsoft.DocAsCode.Build.ManagedReference.Tests\Microsoft.DocAsCode.Build.ManagedReference.Tests.csproj", "{958DF90F-0528-4C50-9AC2-E86C60971B7D}" EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests", "test\Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests\Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests.csproj", "{958DF90F-0528-4C53-9AC2-E86C60971B7D}" -EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "docfx", "src\docfx\docfx.csproj", "{EF53214F-BA98-4026-BEED-CF771865C312}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.DocAsCode.Build.UniversalReference.Tests", "test\Microsoft.DocAsCode.Build.UniversalReference.Tests\Microsoft.DocAsCode.Build.UniversalReference.Tests.csproj", "{E9795C9A-1F98-4716-A0FC-843C6B000BE5}" @@ -382,18 +378,6 @@ Global {A95C5BAE-1D0D-44FD-A984-7CBF055A62E2}.Release|x64.Build.0 = Release|Any CPU {A95C5BAE-1D0D-44FD-A984-7CBF055A62E2}.Release|x86.ActiveCfg = Release|Any CPU {A95C5BAE-1D0D-44FD-A984-7CBF055A62E2}.Release|x86.Build.0 = Release|Any CPU - {2746DA6E-D310-4F07-B41B-929BB3D6E14B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {2746DA6E-D310-4F07-B41B-929BB3D6E14B}.Debug|Any CPU.Build.0 = Debug|Any CPU - {2746DA6E-D310-4F07-B41B-929BB3D6E14B}.Debug|x64.ActiveCfg = Debug|Any CPU - {2746DA6E-D310-4F07-B41B-929BB3D6E14B}.Debug|x64.Build.0 = Debug|Any CPU - {2746DA6E-D310-4F07-B41B-929BB3D6E14B}.Debug|x86.ActiveCfg = Debug|Any CPU - {2746DA6E-D310-4F07-B41B-929BB3D6E14B}.Debug|x86.Build.0 = Debug|Any CPU - {2746DA6E-D310-4F07-B41B-929BB3D6E14B}.Release|Any CPU.ActiveCfg = Release|Any CPU - {2746DA6E-D310-4F07-B41B-929BB3D6E14B}.Release|Any CPU.Build.0 = Release|Any CPU - {2746DA6E-D310-4F07-B41B-929BB3D6E14B}.Release|x64.ActiveCfg = Release|Any CPU - {2746DA6E-D310-4F07-B41B-929BB3D6E14B}.Release|x64.Build.0 = Release|Any CPU - {2746DA6E-D310-4F07-B41B-929BB3D6E14B}.Release|x86.ActiveCfg = Release|Any CPU - {2746DA6E-D310-4F07-B41B-929BB3D6E14B}.Release|x86.Build.0 = Release|Any CPU {B3EEB5FE-CF39-4CC7-9650-5709E71D2BA9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {B3EEB5FE-CF39-4CC7-9650-5709E71D2BA9}.Debug|Any CPU.Build.0 = Debug|Any CPU {B3EEB5FE-CF39-4CC7-9650-5709E71D2BA9}.Debug|x64.ActiveCfg = Debug|Any CPU @@ -418,18 +402,6 @@ Global {958DF90F-0528-4C50-9AC2-E86C60971B7D}.Release|x64.Build.0 = Release|Any CPU {958DF90F-0528-4C50-9AC2-E86C60971B7D}.Release|x86.ActiveCfg = Release|Any CPU {958DF90F-0528-4C50-9AC2-E86C60971B7D}.Release|x86.Build.0 = Release|Any CPU - {958DF90F-0528-4C53-9AC2-E86C60971B7D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {958DF90F-0528-4C53-9AC2-E86C60971B7D}.Debug|Any CPU.Build.0 = Debug|Any CPU - {958DF90F-0528-4C53-9AC2-E86C60971B7D}.Debug|x64.ActiveCfg = Debug|Any CPU - {958DF90F-0528-4C53-9AC2-E86C60971B7D}.Debug|x64.Build.0 = Debug|Any CPU - {958DF90F-0528-4C53-9AC2-E86C60971B7D}.Debug|x86.ActiveCfg = Debug|Any CPU - {958DF90F-0528-4C53-9AC2-E86C60971B7D}.Debug|x86.Build.0 = Debug|Any CPU - {958DF90F-0528-4C53-9AC2-E86C60971B7D}.Release|Any CPU.ActiveCfg = Release|Any CPU - {958DF90F-0528-4C53-9AC2-E86C60971B7D}.Release|Any CPU.Build.0 = Release|Any CPU - {958DF90F-0528-4C53-9AC2-E86C60971B7D}.Release|x64.ActiveCfg = Release|Any CPU - {958DF90F-0528-4C53-9AC2-E86C60971B7D}.Release|x64.Build.0 = Release|Any CPU - {958DF90F-0528-4C53-9AC2-E86C60971B7D}.Release|x86.ActiveCfg = Release|Any CPU - {958DF90F-0528-4C53-9AC2-E86C60971B7D}.Release|x86.Build.0 = Release|Any CPU {EF53214F-BA98-4026-BEED-CF771865C312}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {EF53214F-BA98-4026-BEED-CF771865C312}.Debug|Any CPU.Build.0 = Debug|Any CPU {EF53214F-BA98-4026-BEED-CF771865C312}.Debug|x64.ActiveCfg = Debug|Any CPU @@ -722,10 +694,8 @@ Global {05A49D39-97F0-46AF-9EDC-76D1E19FE3AC} = {926A0726-B806-4215-82EF-AF8E22D0FACF} {B2EEB5FE-CF39-4CC7-9650-5709E71D2BA9} = {926A0726-B806-4215-82EF-AF8E22D0FACF} {A95C5BAE-1D0D-44FD-A984-7CBF055A62E2} = {926A0726-B806-4215-82EF-AF8E22D0FACF} - {2746DA6E-D310-4F07-B41B-929BB3D6E14B} = {DF2BA00B-1742-4F84-A469-08D7F019498E} {B3EEB5FE-CF39-4CC7-9650-5709E71D2BA9} = {926A0726-B806-4215-82EF-AF8E22D0FACF} {958DF90F-0528-4C50-9AC2-E86C60971B7D} = {926A0726-B806-4215-82EF-AF8E22D0FACF} - {958DF90F-0528-4C53-9AC2-E86C60971B7D} = {926A0726-B806-4215-82EF-AF8E22D0FACF} {EF53214F-BA98-4026-BEED-CF771865C312} = {6A65A769-DAC3-4E99-96F9-991F4CE8D164} {E9795C9A-1F98-4716-A0FC-843C6B000BE5} = {926A0726-B806-4215-82EF-AF8E22D0FACF} {FF8D61D0-01C9-44B9-98F9-37FCBF20CD72} = {6A65A769-DAC3-4E99-96F9-991F4CE8D164} diff --git a/docs/docs/dotnet-api-docs.md b/docs/docs/dotnet-api-docs.md index 6d4e98e106a..eadb1a9c9d3 100644 --- a/docs/docs/dotnet-api-docs.md +++ b/docs/docs/dotnet-api-docs.md @@ -108,6 +108,18 @@ When the file extension is `.cs` or `.vb`, docfx uses the latest supported .NET } ``` +## Customization Options + +There are several options available for customizing .NET API pages that are tailored to your specific needs and preferences. To customize .NET API pages for DocFX, you can use the following options: + +- `memberLayout`: This option determines whether type members should be on the same page as containing type or as dedicated pages. Possible values are: + - `samePage`: Type members are on the same page as containing type. + - `separatePages`: Type members are on dedicated pages. + +- `namespaceLayout`: This option determines whether namespace node in TOC is a list or nested. Possible values are: + - `flattened`: Namespace node in TOC is a list. + - `nested`: Namespace node in TOC is nested. + ## Supported XML Tags Docfx supports [Recommended XML tags for C# documentation comments](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags). diff --git a/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/Microsoft.DocAsCode.Build.MemberLevelManagedReference.csproj b/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/Microsoft.DocAsCode.Build.MemberLevelManagedReference.csproj deleted file mode 100644 index c68877bf8b1..00000000000 --- a/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/Microsoft.DocAsCode.Build.MemberLevelManagedReference.csproj +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - - - - diff --git a/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/ManagedReference.extension.js b/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/ManagedReference.extension.js deleted file mode 100644 index 770c2938ec4..00000000000 --- a/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/ManagedReference.extension.js +++ /dev/null @@ -1,20 +0,0 @@ -// Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information. -var common = require('./ManagedReference.common.js'); - -exports.postTransform = function (model) { - var type = model.type.toLowerCase(); - var category = common.getCategory(type); - if (category == 'class') { - var typePropertyName = common.getTypePropertyName(type); - if (typePropertyName) { - model[typePropertyName] = true; - } - if (model.children && model.children.length > 0) { - model.isCollection = true; - common.groupChildren(model, 'class'); - } else { - model.isItem = true; - } - } - return model; -} \ No newline at end of file diff --git a/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/ManagedReference.overwrite.js b/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/ManagedReference.overwrite.js deleted file mode 100644 index 9e6f29e8866..00000000000 --- a/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/ManagedReference.overwrite.js +++ /dev/null @@ -1,10 +0,0 @@ -// Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information. -var common = require('./ManagedReference.common.js'); - -exports.getOptions = function (model) { - var ignoreChildrenBookmarks = model._splitReference && model.type && common.getCategory(model.type) === 'ns'; - - return { - "bookmarks": common.getBookmarks(model, ignoreChildrenBookmarks) - }; -} \ No newline at end of file diff --git a/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/toc.html.js b/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/toc.html.js deleted file mode 100644 index 2233aa614f0..00000000000 --- a/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/toc.html.js +++ /dev/null @@ -1,74 +0,0 @@ -// Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information. -exports.transform = function (model) { - var groupNames = { - "constructor": { key: "constructorsInSubtitle" }, - "field": { key: "fieldsInSubtitle" }, - "property": { key: "propertiesInSubtitle" }, - "method": { key: "methodsInSubtitle" }, - "event": { key: "eventsInSubtitle" }, - "operator": { key: "operatorsInSubtitle" }, - "eii": { key: "eiisInSubtitle" }, - }; - - groupChildren(model); - transformItem(model, 1); - return model; - - function groupChildren(item) { - if (!item || !item.items || item.items.length == 0) { - return; - } - var grouped = {}; - var items = []; - item.items.forEach(function (element) { - groupChildren(element); - if (element.type) { - var type = element.isEii ? "eii" : element.type.toLowerCase(); - if (!grouped.hasOwnProperty(type)) { - if (!groupNames.hasOwnProperty(type)) { - groupNames[type] = { - name: element.type - }; - console.log(type + " is not predefined type, use its type name as display name.") - } - grouped[type] = []; - } - grouped[type].push(element); - } else { - items.push(element); - } - }, this); - - // With order defined in groupNames - for (var key in groupNames) { - if (groupNames.hasOwnProperty(key) && grouped.hasOwnProperty(key)) { - items.push({ - name: model.__global[groupNames[key].key] || groupNames[key].name, - items: grouped[key] - }) - } - } - - item.items = items; - } - - function transformItem(item, level) { - // set to null in case mustache looks up - item.topicHref = item.topicHref || null; - item.tocHref = item.tocHref || null; - item.name = item.name || null; - - item.level = level; - - if (item.items && item.items.length > 0) { - item.leaf = false; - var length = item.items.length; - for (var i = 0; i < length; i++) { - transformItem(item.items[i], level + 1); - }; - } else { - item.items = []; - item.leaf = true; - } - } -} diff --git a/samples/extensions/README.md b/samples/extensions/README.md index c586f21d284..94902948989 100644 --- a/samples/extensions/README.md +++ b/samples/extensions/README.md @@ -1,6 +1,6 @@ # Customize docfx with extensions -This sample shows how to customize docfx with the `memberpage` extensions. It uses the `Microsoft.DocAsCode.App` package to build the project instead of using the global `docfx` commandline tool. To build the project, run the following command in this directory: +This sample shows how to use docfx as a library. It uses the `Microsoft.DocAsCode.App` package to build the project instead of using the global `docfx` commandline tool. To build the project, run the following command in this directory: ```bash dotnet run --project build diff --git a/samples/extensions/build/build.csproj b/samples/extensions/build/build.csproj index 46a3c37083d..b77cb2ed757 100644 --- a/samples/extensions/build/build.csproj +++ b/samples/extensions/build/build.csproj @@ -9,14 +9,12 @@ - diff --git a/samples/extensions/docfx.json b/samples/extensions/docfx.json index f4b612555ea..4aa0daa3d31 100644 --- a/samples/extensions/docfx.json +++ b/samples/extensions/docfx.json @@ -11,7 +11,8 @@ "dest": "api", "includePrivateMembers": true, "disableGitFeatures": false, - "disableDefaultFilter": false + "disableDefaultFilter": false, + "memberLayout": "separatePages" } ], "build": { @@ -33,7 +34,7 @@ "fileMetadataFiles": [], "template": [ "default", - "memberpage" + "modern" ], "postProcessors": [], "keepFileLink": false, diff --git a/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/SplitClassPageToMemberLevel.cs b/src/Microsoft.DocAsCode.Build.ManagedReference/SplitClassPageToMemberLevel.cs similarity index 99% rename from plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/SplitClassPageToMemberLevel.cs rename to src/Microsoft.DocAsCode.Build.ManagedReference/SplitClassPageToMemberLevel.cs index 90ead466e78..d38b7f97ef6 100644 --- a/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/SplitClassPageToMemberLevel.cs +++ b/src/Microsoft.DocAsCode.Build.ManagedReference/SplitClassPageToMemberLevel.cs @@ -154,7 +154,7 @@ private SplittedResult SplitModelToOverloadLevel(FileModel model, Dictionary s.Files).ToList(), References = expandedReferences?.Items.SelectMany(s => s.Files).ToList(), diff --git a/src/Microsoft.DocAsCode.Dotnet/ExtractMetadata/ExtractMetadataConfig.cs b/src/Microsoft.DocAsCode.Dotnet/ExtractMetadata/ExtractMetadataConfig.cs index 535b44e04bf..0daf59e993f 100644 --- a/src/Microsoft.DocAsCode.Dotnet/ExtractMetadata/ExtractMetadataConfig.cs +++ b/src/Microsoft.DocAsCode.Dotnet/ExtractMetadata/ExtractMetadataConfig.cs @@ -27,6 +27,8 @@ internal class ExtractMetadataConfig public NamespaceLayout NamespaceLayout { get; init; } + public MemberLayout MemberLayout { get; init; } + public Dictionary MSBuildProperties { get; init; } public bool AllowCompilationErrors { get; init; } diff --git a/src/Microsoft.DocAsCode.Dotnet/ExtractMetadata/ExtractMetadataWorker.cs b/src/Microsoft.DocAsCode.Dotnet/ExtractMetadata/ExtractMetadataWorker.cs index a3829aa053a..e55fb632533 100644 --- a/src/Microsoft.DocAsCode.Dotnet/ExtractMetadata/ExtractMetadataWorker.cs +++ b/src/Microsoft.DocAsCode.Dotnet/ExtractMetadata/ExtractMetadataWorker.cs @@ -222,7 +222,11 @@ private IEnumerable ResolveAndExportYamlMetadata( model.TocYamlViewModel.Type = MemberType.Toc; // TOC do not change - var tocViewModel = model.TocYamlViewModel.ToTocViewModel(); + var tocViewModel = new TocRootViewModel + { + Metadata = new() { ["memberLayout"] = _config.MemberLayout }, + Items = model.TocYamlViewModel.ToTocViewModel(), + }; string tocFilePath = Path.Combine(_config.OutputFolder, tocFileName); YamlUtility.Serialize(tocFilePath, tocViewModel, YamlMime.TableOfContent); @@ -240,6 +244,7 @@ private IEnumerable ResolveAndExportYamlMetadata( string itemFilePath = Path.Combine(_config.OutputFolder, outputFileName); var memberViewModel = memberModel.ToPageViewModel(); memberViewModel.ShouldSkipMarkup = _config.ShouldSkipMarkup; + memberViewModel.MemberLayout = _config.MemberLayout; YamlUtility.Serialize(itemFilePath, memberViewModel, YamlMime.ManagedReference); Logger.Log(LogLevel.Diagnostic, $"Metadata file for {memberModel.Name} is saved to {itemFilePath}."); AddMemberToIndexer(memberModel, outputFileName, indexer); diff --git a/src/Microsoft.DocAsCode.Dotnet/ExtractMetadata/NamespaceLayout.cs b/src/Microsoft.DocAsCode.Dotnet/ExtractMetadata/NamespaceLayout.cs deleted file mode 100644 index 175aa382809..00000000000 --- a/src/Microsoft.DocAsCode.Dotnet/ExtractMetadata/NamespaceLayout.cs +++ /dev/null @@ -1,17 +0,0 @@ -// Copyright (c) Microsoft. All rights reserved. -// Licensed under the MIT license. See LICENSE file in the project root for full license information. - -namespace Microsoft.DocAsCode.Dotnet; - -internal enum NamespaceLayout -{ - /// - /// Renders the namespaces as a single flat list - /// - Flattened, - - /// - /// Renders the namespaces in a nested tree form - /// - Nested, -} diff --git a/src/Microsoft.DocAsCode.Dotnet/ManagedReference/PageViewModel.cs b/src/Microsoft.DocAsCode.Dotnet/ManagedReference/PageViewModel.cs index db55f742ac9..f342e32d9b8 100644 --- a/src/Microsoft.DocAsCode.Dotnet/ManagedReference/PageViewModel.cs +++ b/src/Microsoft.DocAsCode.Dotnet/ManagedReference/PageViewModel.cs @@ -26,6 +26,10 @@ public class PageViewModel [JsonProperty("shouldSkipMarkup")] public bool ShouldSkipMarkup { get; set; } + [YamlMember(Alias = "memberLayout")] + [JsonProperty("memberLayout")] + public MemberLayout MemberLayout { get; set; } + [ExtensibleMember] [JsonExtensionData] public Dictionary Metadata { get; set; } = new Dictionary(); diff --git a/src/Microsoft.DocAsCode.Dotnet/MetadataJsonConfig.cs b/src/Microsoft.DocAsCode.Dotnet/MetadataJsonConfig.cs index fd8d75bb822..4572ae29270 100644 --- a/src/Microsoft.DocAsCode.Dotnet/MetadataJsonConfig.cs +++ b/src/Microsoft.DocAsCode.Dotnet/MetadataJsonConfig.cs @@ -1,8 +1,92 @@ // Copyright (c) Microsoft. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using Newtonsoft.Json; + namespace Microsoft.DocAsCode; +public enum MemberLayout +{ + /// + /// Place members in the same page as their containing type + /// + SamePage, + + /// + /// Place members in separate pages + /// + SeparatePages, +} + +internal enum NamespaceLayout +{ + /// + /// Renders the namespaces as a single flat list + /// + Flattened, + + /// + /// Renders the namespaces in a nested tree form + /// + Nested, +} + +internal class MetadataJsonItemConfig +{ + [JsonProperty("src")] + public FileMapping Source { get; set; } + + [JsonProperty("dest")] + public string Destination { get; set; } + + [JsonProperty("shouldSkipMarkup")] + public bool? ShouldSkipMarkup { get; set; } + + [JsonProperty("raw")] + public bool? Raw { get; set; } + + [JsonProperty("references")] + public FileMapping References { get; set; } + + [JsonProperty("filter")] + public string FilterConfigFile { get; set; } + + [JsonProperty("includePrivateMembers")] + public bool IncludePrivateMembers { get; set; } + + [JsonProperty("globalNamespaceId")] + public string GlobalNamespaceId { get; set; } + + /// + /// An optional set of MSBuild properties used when interpreting project files. These + /// are the same properties that are passed to msbuild via the /property:<n>=<v> + /// command line argument. + /// + [JsonProperty("properties")] + public Dictionary MSBuildProperties { get; set; } + + [JsonProperty("disableGitFeatures")] + public bool DisableGitFeatures { get; set; } + + [JsonProperty("codeSourceBasePath")] + public string CodeSourceBasePath { get; set; } + + [JsonProperty("disableDefaultFilter")] + public bool DisableDefaultFilter { get; set; } + + [JsonProperty("noRestore")] + public bool NoRestore { get; set; } + + [JsonProperty("namespaceLayout")] + public NamespaceLayout NamespaceLayout { get; set; } + + [JsonProperty("memberLayout")] + public MemberLayout MemberLayout { get; set; } + + [JsonProperty("allowCompilationErrors")] + public bool AllowCompilationErrors { get; set; } +} + internal class MetadataJsonConfig : List { public MetadataJsonConfig(IEnumerable configs) : base(configs) { } diff --git a/src/Microsoft.DocAsCode.Dotnet/MetadataJsonItemConfig.cs b/src/Microsoft.DocAsCode.Dotnet/MetadataJsonItemConfig.cs deleted file mode 100644 index 2b8da3e2914..00000000000 --- a/src/Microsoft.DocAsCode.Dotnet/MetadataJsonItemConfig.cs +++ /dev/null @@ -1,60 +0,0 @@ -// Copyright (c) Microsoft. All rights reserved. -// Licensed under the MIT license. See LICENSE file in the project root for full license information. - -using Microsoft.DocAsCode.Dotnet; -using Newtonsoft.Json; - -namespace Microsoft.DocAsCode; - -internal class MetadataJsonItemConfig -{ - [JsonProperty("src")] - public FileMapping Source { get; set; } - - [JsonProperty("dest")] - public string Destination { get; set; } - - [JsonProperty("shouldSkipMarkup")] - public bool? ShouldSkipMarkup { get; set; } - - [JsonProperty("raw")] - public bool? Raw { get; set; } - - [JsonProperty("references")] - public FileMapping References { get; set; } - - [JsonProperty("filter")] - public string FilterConfigFile { get; set; } - - [JsonProperty("includePrivateMembers")] - public bool IncludePrivateMembers { get; set; } - - [JsonProperty("globalNamespaceId")] - public string GlobalNamespaceId { get; set; } - - /// - /// An optional set of MSBuild properties used when interpreting project files. These - /// are the same properties that are passed to msbuild via the /property:<n>=<v> - /// command line argument. - /// - [JsonProperty("properties")] - public Dictionary MSBuildProperties { get; set; } - - [JsonProperty("disableGitFeatures")] - public bool DisableGitFeatures { get; set; } - - [JsonProperty("codeSourceBasePath")] - public string CodeSourceBasePath { get; set; } - - [JsonProperty("disableDefaultFilter")] - public bool DisableDefaultFilter { get; set; } - - [JsonProperty("noRestore")] - public bool NoRestore { get; set; } - - [JsonProperty("namespaceLayout")] - public NamespaceLayout NamespaceLayout{ get; set; } - - [JsonProperty("allowCompilationErrors")] - public bool AllowCompilationErrors { get; set; } -} diff --git a/templates/default/ManagedReference.html.primary.js b/templates/default/ManagedReference.html.primary.js index b1814b45d2d..e7a3da3c4d9 100644 --- a/templates/default/ManagedReference.html.primary.js +++ b/templates/default/ManagedReference.html.primary.js @@ -1,6 +1,6 @@ // Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information. -var mrefCommon = require('./ManagedReference.common.js'); +var common = require('./ManagedReference.common.js'); var extension = require('./ManagedReference.extension.js'); var overwrite = require('./ManagedReference.overwrite.js'); @@ -15,8 +15,8 @@ exports.transform = function (model) { model = extension.preTransform(model); } - if (mrefCommon && mrefCommon.transform) { - model = mrefCommon.transform(model); + if (common && common.transform) { + model = common.transform(model); } if (model.type.toLowerCase() === "enum") { model.isClass = false; @@ -25,6 +25,10 @@ exports.transform = function (model) { model._disableToc = model._disableToc || !model._tocPath || (model._navPath === model._tocPath); if (extension && extension.postTransform) { + if (model._splitReference) { + model = postTransformMemberPage(model); + } + model = extension.postTransform(model); } @@ -35,8 +39,27 @@ exports.getOptions = function (model) { if (overwrite && overwrite.getOptions) { return overwrite.getOptions(model); } + var ignoreChildrenBookmarks = model._splitReference && model.type && common.getCategory(model.type) === 'ns'; return { - "bookmarks": mrefCommon.getBookmarks(model) + "bookmarks": common.getBookmarks(model, ignoreChildrenBookmarks) }; +} + +function postTransformMemberPage(model) { + var type = model.type.toLowerCase(); + var category = common.getCategory(type); + if (category == 'class') { + var typePropertyName = common.getTypePropertyName(type); + if (typePropertyName) { + model[typePropertyName] = true; + } + if (model.children && model.children.length > 0) { + model.isCollection = true; + common.groupChildren(model, 'class'); + } else { + model.isItem = true; + } + } + return model; } \ No newline at end of file diff --git a/templates/default/ManagedReference.html.primary.tmpl b/templates/default/ManagedReference.html.primary.tmpl index b497774918c..fcee521a487 100644 --- a/templates/default/ManagedReference.html.primary.tmpl +++ b/templates/default/ManagedReference.html.primary.tmpl @@ -4,9 +4,18 @@ {{#isNamespace}} {{>partials/namespace}} {{/isNamespace}} + +{{#_splitReference}} +{{#isClass}} + {{>partials/class.memberpage}} +{{/isClass}} +{{/_splitReference}} +{{^_splitReference}} {{#isClass}} {{>partials/class}} {{/isClass}} +{{/_splitReference}} + {{#isEnum}} {{>partials/enum}} {{/isEnum}} diff --git a/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/partials/class.tmpl.partial b/templates/default/partials/class.memberpage.tmpl.partial similarity index 100% rename from plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/partials/class.tmpl.partial rename to templates/default/partials/class.memberpage.tmpl.partial diff --git a/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/partials/collection.tmpl.partial b/templates/default/partials/collection.tmpl.partial similarity index 100% rename from plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/partials/collection.tmpl.partial rename to templates/default/partials/collection.tmpl.partial diff --git a/templates/default/partials/customMREFContent.tmpl.partial b/templates/default/partials/customMREFContent.tmpl.partial index 67395b89305..886a41f0d1f 100644 --- a/templates/default/partials/customMREFContent.tmpl.partial +++ b/templates/default/partials/customMREFContent.tmpl.partial @@ -1,2 +1,10 @@ {{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} -{{!Add your own custom template for the content for ManagedReference here}} \ No newline at end of file +{{!Add your own custom template for the content for ManagedReference here}} +{{#_splitReference}} +{{#isCollection}} +{{>partials/collection}} +{{/isCollection}} +{{#isItem}} +{{>partials/item}} +{{/isItem}} +{{/_splitReference}} \ No newline at end of file diff --git a/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/partials/item.tmpl.partial b/templates/default/partials/item.tmpl.partial similarity index 100% rename from plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/partials/item.tmpl.partial rename to templates/default/partials/item.tmpl.partial diff --git a/templates/default/toc.html.js b/templates/default/toc.html.js index 8761d781fca..97fd37bc461 100644 --- a/templates/default/toc.html.js +++ b/templates/default/toc.html.js @@ -7,10 +7,14 @@ exports.transform = function (model) { model = extension.preTransform(model); } - transformItem(model, 1); - if (model.items && model.items.length > 0) model.leaf = false; - model.title = "Table of Content"; - model._disableToc = true; + if (model.memberLayout === 'SeparatePages') { + model = transformMemberPage(model); + } else { + transformItem(model, 1); + if (model.items && model.items.length > 0) model.leaf = false; + model.title = "Table of Content"; + model._disableToc = true; + } if (extension && extension.postTransform) { model = extension.postTransform(model); @@ -36,3 +40,77 @@ exports.transform = function (model) { } } } + +function transformMemberPage(model) { + var groupNames = { + "constructor": { key: "constructorsInSubtitle" }, + "field": { key: "fieldsInSubtitle" }, + "property": { key: "propertiesInSubtitle" }, + "method": { key: "methodsInSubtitle" }, + "event": { key: "eventsInSubtitle" }, + "operator": { key: "operatorsInSubtitle" }, + "eii": { key: "eiisInSubtitle" }, + }; + + groupChildren(model); + transformItem(model, 1); + return model; + + function groupChildren(item) { + if (!item || !item.items || item.items.length == 0) { + return; + } + var grouped = {}; + var items = []; + item.items.forEach(function (element) { + groupChildren(element); + if (element.type) { + var type = element.isEii ? "eii" : element.type.toLowerCase(); + if (!grouped.hasOwnProperty(type)) { + if (!groupNames.hasOwnProperty(type)) { + groupNames[type] = { + name: element.type + }; + console.log(type + " is not predefined type, use its type name as display name.") + } + grouped[type] = []; + } + grouped[type].push(element); + } else { + items.push(element); + } + }, this); + + // With order defined in groupNames + for (var key in groupNames) { + if (groupNames.hasOwnProperty(key) && grouped.hasOwnProperty(key)) { + items.push({ + name: model.__global[groupNames[key].key] || groupNames[key].name, + items: grouped[key] + }) + } + } + + item.items = items; + } + + function transformItem(item, level) { + // set to null in case mustache looks up + item.topicHref = item.topicHref || null; + item.tocHref = item.tocHref || null; + item.name = item.name || null; + + item.level = level; + + if (item.items && item.items.length > 0) { + item.leaf = false; + var length = item.items.length; + for (var i = 0; i < length; i++) { + transformItem(item.items[i], level + 1); + }; + } else { + item.items = []; + item.leaf = true; + } + } +} diff --git a/templates/modern/partials/class.header.tmpl.partial b/templates/modern/partials/class.header.tmpl.partial index c2031faea07..cf015518c82 100644 --- a/templates/modern/partials/class.header.tmpl.partial +++ b/templates/modern/partials/class.header.tmpl.partial @@ -13,9 +13,11 @@
{{{summary}}}
{{{conceptual}}}
+{{#syntax.content.0.value}}
{{syntax.content.0.value}}
+{{/syntax.content.0.value}} {{#syntax.parameters.0}}

{{__global.parameters}}

@@ -32,7 +34,7 @@ {{#syntax.return}}

{{__global.returns}}

-
type.specName.0.value
+
{{{type.specName.0.value}}}
{{{description}}}
{{/syntax.return}} diff --git a/templates/modern/partials/class.memberpage.tmpl.partial b/templates/modern/partials/class.memberpage.tmpl.partial new file mode 100644 index 00000000000..b698fbbce7a --- /dev/null +++ b/templates/modern/partials/class.memberpage.tmpl.partial @@ -0,0 +1,31 @@ +{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} + +{{>partials/class.header}} + +{{#children}} +

{{>partials/classSubtitle}}

+ +{{#children}} +
+
+
{{{summary}}}
+
+{{/children}} + +{{/children}} + +{{#seealso.0}} +

{{__global.seealso}}

+
+{{/seealso.0}} +{{#seealso}} + {{#isCref}} +
{{{type.specName.0.value}}}
+ {{/isCref}} + {{^isCref}} +
{{{url}}}
+ {{/isCref}} +{{/seealso}} +{{#seealso.0}} +
+{{/seealso.0}} diff --git a/templates/modern/partials/class.tmpl.partial b/templates/modern/partials/class.tmpl.partial index 265d8cbf14d..4721238c797 100644 --- a/templates/modern/partials/class.tmpl.partial +++ b/templates/modern/partials/class.tmpl.partial @@ -3,7 +3,11 @@ {{>partials/class.header}} {{#children}} + +{{^_splitReference}}

{{>partials/classSubtitle}}

+{{/_splitReference}} + {{#children}} {{#overload}} diff --git a/templates/modern/partials/collection.tmpl.partial b/templates/modern/partials/collection.tmpl.partial new file mode 100644 index 00000000000..2aaa10d3d59 --- /dev/null +++ b/templates/modern/partials/collection.tmpl.partial @@ -0,0 +1,3 @@ +{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} + +{{>partials/class}} diff --git a/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/partials/customMREFContent.tmpl.partial b/templates/modern/partials/customMREFContent.tmpl.partial similarity index 68% rename from plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/partials/customMREFContent.tmpl.partial rename to templates/modern/partials/customMREFContent.tmpl.partial index 95c0538b6ae..886a41f0d1f 100644 --- a/plugins/Microsoft.DocAsCode.Build.MemberLevelManagedReference/templates/memberpage/partials/customMREFContent.tmpl.partial +++ b/templates/modern/partials/customMREFContent.tmpl.partial @@ -1,7 +1,10 @@ {{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Add your own custom template for the content for ManagedReference here}} +{{#_splitReference}} {{#isCollection}} {{>partials/collection}} {{/isCollection}} {{#isItem}} {{>partials/item}} {{/isItem}} +{{/_splitReference}} \ No newline at end of file diff --git a/templates/modern/partials/item.tmpl.partial b/templates/modern/partials/item.tmpl.partial new file mode 100644 index 00000000000..ecce961b5b9 --- /dev/null +++ b/templates/modern/partials/item.tmpl.partial @@ -0,0 +1,3 @@ +{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} + +{{>partials/class.header}} \ No newline at end of file diff --git a/templates/modern/toc.json.js b/templates/modern/toc.json.js index 346762e4d6e..1a979d6eaff 100644 --- a/templates/modern/toc.json.js +++ b/templates/modern/toc.json.js @@ -2,6 +2,10 @@ exports.transform = function (model) { + if (model.memberLayout === 'SeparatePages') { + model = transformMemberPage(model); + } + for (var key in model) { if (key[0] === '_') { delete model[key] @@ -12,3 +16,77 @@ exports.transform = function (model) { content: JSON.stringify(model) }; } + +function transformMemberPage(model) { + var groupNames = { + "constructor": { key: "constructorsInSubtitle" }, + "field": { key: "fieldsInSubtitle" }, + "property": { key: "propertiesInSubtitle" }, + "method": { key: "methodsInSubtitle" }, + "event": { key: "eventsInSubtitle" }, + "operator": { key: "operatorsInSubtitle" }, + "eii": { key: "eiisInSubtitle" }, + }; + + groupChildren(model); + transformItem(model, 1); + return model; + + function groupChildren(item) { + if (!item || !item.items || item.items.length == 0) { + return; + } + var grouped = {}; + var items = []; + item.items.forEach(function (element) { + groupChildren(element); + if (element.type) { + var type = element.isEii ? "eii" : element.type.toLowerCase(); + if (!grouped.hasOwnProperty(type)) { + if (!groupNames.hasOwnProperty(type)) { + groupNames[type] = { + name: element.type + }; + console.log(type + " is not predefined type, use its type name as display name.") + } + grouped[type] = []; + } + grouped[type].push(element); + } else { + items.push(element); + } + }, this); + + // With order defined in groupNames + for (var key in groupNames) { + if (groupNames.hasOwnProperty(key) && grouped.hasOwnProperty(key)) { + items.push({ + name: model.__global[groupNames[key].key] || groupNames[key].name, + items: grouped[key] + }) + } + } + + item.items = items; + } + + function transformItem(item, level) { + // set to null in case mustache looks up + item.topicHref = item.topicHref || null; + item.tocHref = item.tocHref || null; + item.name = item.name || null; + + item.level = level; + + if (item.items && item.items.length > 0) { + item.leaf = false; + var length = item.items.length; + for (var i = 0; i < length; i++) { + transformItem(item.items[i], level + 1); + }; + } else { + item.items = []; + item.leaf = true; + } + } +} diff --git a/templates/statictoc/ManagedReference.html.primary.js b/templates/statictoc/ManagedReference.html.primary.js index aba3f24044f..566f99f23f9 100644 --- a/templates/statictoc/ManagedReference.html.primary.js +++ b/templates/statictoc/ManagedReference.html.primary.js @@ -1,16 +1,23 @@ // Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information. -var mrefCommon = require('./ManagedReference.common.js'); -var extension = require('./ManagedReference.extension.js') +var common = require('./ManagedReference.common.js'); +var extension = require('./ManagedReference.extension.js'); +var overwrite = require('./ManagedReference.overwrite.js'); var util = require('./statictoc.util.js'); exports.transform = function (model) { + model.yamlmime = "ManagedReference"; + + if (overwrite && overwrite.transform) { + return overwrite.transform(model); + } + if (extension && extension.preTransform) { model = extension.preTransform(model); } - if (mrefCommon && mrefCommon.transform) { - model = mrefCommon.transform(model); + if (common && common.transform) { + model = common.transform(model); } if (model.type.toLowerCase() === "enum") { model.isClass = false; @@ -20,13 +27,41 @@ exports.transform = function (model) { model = util.setToc(model); if (extension && extension.postTransform) { + if (model._splitReference) { + model = postTransformMemberPage(model); + } + model = extension.postTransform(model); } + return model; } exports.getOptions = function (model) { + if (overwrite && overwrite.getOptions) { + return overwrite.getOptions(model); + } + var ignoreChildrenBookmarks = model._splitReference && model.type && common.getCategory(model.type) === 'ns'; + return { - "bookmarks": mrefCommon.getBookmarks(model) + "bookmarks": common.getBookmarks(model, ignoreChildrenBookmarks) }; -} \ No newline at end of file +} + +function postTransformMemberPage(model) { + var type = model.type.toLowerCase(); + var category = common.getCategory(type); + if (category == 'class') { + var typePropertyName = common.getTypePropertyName(type); + if (typePropertyName) { + model[typePropertyName] = true; + } + if (model.children && model.children.length > 0) { + model.isCollection = true; + common.groupChildren(model, 'class'); + } else { + model.isItem = true; + } + } + return model; +} diff --git a/test/Microsoft.DocAsCode.Build.Engine.Tests/Microsoft.DocAsCode.Build.Engine.Tests.csproj b/test/Microsoft.DocAsCode.Build.Engine.Tests/Microsoft.DocAsCode.Build.Engine.Tests.csproj index 58489fe342c..db6d8c48916 100644 --- a/test/Microsoft.DocAsCode.Build.Engine.Tests/Microsoft.DocAsCode.Build.Engine.Tests.csproj +++ b/test/Microsoft.DocAsCode.Build.Engine.Tests/Microsoft.DocAsCode.Build.Engine.Tests.csproj @@ -9,7 +9,6 @@ - diff --git a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests.csproj b/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests.csproj deleted file mode 100644 index f150a911dd4..00000000000 --- a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests.csproj +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - - diff --git a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/SplitClassPageToMemberLevelTest.cs b/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/SplitClassPageToMemberLevelTest.cs deleted file mode 100644 index 894c7fd1633..00000000000 --- a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/SplitClassPageToMemberLevelTest.cs +++ /dev/null @@ -1,316 +0,0 @@ -// Copyright (c) Microsoft. All rights reserved. -// Licensed under the MIT license. See LICENSE file in the project root for full license information. - -using System.Collections.Immutable; - -using Microsoft.DocAsCode.Build.Engine; -using Microsoft.DocAsCode.Build.ManagedReference.BuildOutputs; -using Microsoft.DocAsCode.Build.TableOfContents; -using Microsoft.DocAsCode.Common; -using Microsoft.DocAsCode.DataContracts.Common; -using Microsoft.DocAsCode.DataContracts.ManagedReference; -using Microsoft.DocAsCode.Plugins; -using Microsoft.DocAsCode.Tests.Common; - -using Newtonsoft.Json.Linq; -using Xunit; - -namespace Microsoft.DocAsCode.Build.ManagedReference.Tests; - -public class SplitClassPageToMemberLevelTest : TestBase -{ - private string _outputFolder; - private string _inputFolder; - private ApplyTemplateSettings _applyTemplateSettings; - private TemplateManager _templateManager; - - private const string RawModelFileExtension = ".raw.json"; - private const string MrefDirectory = "mref"; - - public SplitClassPageToMemberLevelTest() - { - _outputFolder = GetRandomFolder(); - _inputFolder = GetRandomFolder(); - _applyTemplateSettings = new ApplyTemplateSettings(_inputFolder, _outputFolder) - { - RawModelExportSettings = { Export = true }, - TransformDocument = true, - }; - - _templateManager = new TemplateManager(null, null, new List { "template" }, null, "TestData/"); - } - - [Fact] - public void ProcessMrefShouldSucceed() - { - var files = new FileCollection(Directory.GetCurrentDirectory()); - files.Add(DocumentType.Article, new[] { "TestData/mref/CatLibrary.Cat`2.yml" }, "TestData/"); - BuildDocument(files); - { - var outputRawModelPath = GetRawModelFilePath("CatLibrary.Cat`2.yml"); - Assert.True(File.Exists(outputRawModelPath)); - var model = JsonUtility.Deserialize(outputRawModelPath); - Assert.NotNull(model); - - Assert.Equal("Hello world!", model.Metadata["meta"]); - Assert.Equal(true, model.Metadata["_splitReference"]); - Assert.Equal(true, model.Metadata["_splitFrom"]); - Assert.Equal(20, model.Children.Count); - } - { - var outputRawModelPath = GetRawModelFilePath("CatLibrary.Cat-2.-ctor.yml"); - Assert.True(File.Exists(outputRawModelPath)); - var model = JsonUtility.Deserialize(outputRawModelPath); - Assert.NotNull(model); - - Assert.Equal("Hello world!", model.Metadata["meta"]); - Assert.Equal(true, model.Metadata["_splitReference"]); - Assert.False(model.Metadata.ContainsKey("_splitFrom")); - Assert.Equal(MemberType.Constructor, model.Type); - Assert.Equal(3, model.Children.Count); - } - } - - [Fact] - public void ProcessMrefEnumShouldSucceed() - { - var files = new FileCollection(Directory.GetCurrentDirectory()); - files.Add(DocumentType.Article, new[] { "TestData/mref/Microsoft.DocAsCode.Build.SchemaDriven.MergeType.yml" }, "TestData/"); - BuildDocument(files); - { - var outputRawModelPath = GetRawModelFilePath("Microsoft.DocAsCode.Build.SchemaDriven.MergeType.yml"); - Assert.True(File.Exists(outputRawModelPath)); - var model = JsonUtility.Deserialize(outputRawModelPath); - Assert.NotNull(model); - - Assert.Equal("Hello world!", model.Metadata["meta"]); - Assert.False(model.Metadata.TryGetValue("_splitReference", out var split)); - Assert.False(model.Metadata.TryGetValue("_splitFrom", out var from)); - Assert.Equal(4, model.Children.Count); - } - { - var xrefmap = YamlUtility.Deserialize(Path.Combine(_outputFolder, "xrefmap.yml")); - Assert.Equal(5, xrefmap.References.Count); - } - } - - [Fact] - public void ProcessMrefWithTocShouldSucceed() - { - var files = new FileCollection(Directory.GetCurrentDirectory()); - files.Add(DocumentType.Article, new[] { "TestData/mref/CatLibrary.Cat`2.yml" }, "TestData/"); - files.Add(DocumentType.Article, new[] { "TestData/mref/toc.yml" }, "TestData/"); - BuildDocument(files); - { - var outputRawModelPath = GetRawModelFilePath("CatLibrary.Cat`2.yml"); - Assert.True(File.Exists(outputRawModelPath)); - var model = JsonUtility.Deserialize(outputRawModelPath); - Assert.NotNull(model); - - Assert.Equal("Hello world!", model.Metadata["meta"]); - Assert.Equal(true, model.Metadata["_splitReference"]); - Assert.Equal(20, model.Children.Count); - } - { - var outputRawModelPath = GetRawModelFilePath("CatLibrary.Cat-2.-ctor.yml"); - Assert.True(File.Exists(outputRawModelPath)); - var model = JsonUtility.Deserialize(outputRawModelPath); - Assert.NotNull(model); - - Assert.Equal("Hello world!", model.Metadata["meta"]); - Assert.Equal(true, model.Metadata["_splitReference"]); - Assert.Equal(MemberType.Constructor, model.Type); - Assert.Equal(3, model.Children.Count); - Assert.Equal(new List { "net2", "net46" }, model.Platform); - Assert.Equal("

Overload summary

\n", model.Summary); - Assert.Equal("

Overload remarks

\n", model.Remarks); - Assert.Equal(new List - { - "

Overload example 1

\n", - "

Overload example 2

\n" - }, model.Examples); - Assert.Equal("Not defined Property", model.Metadata["not-defined"]); - Assert.NotNull(model.Source); - - Assert.Equal("net46", JArray.FromObject(model.Children[0].Metadata[Constants.MetadataName.Version])[0].ToString()); - Assert.Equal("net2", JArray.FromObject(model.Children[1].Metadata[Constants.MetadataName.Version])[0].ToString()); - } - { - var outputRawModelPath = GetRawModelFilePath("toc.yml"); - Assert.True(File.Exists(outputRawModelPath)); - var model = JsonUtility.Deserialize(outputRawModelPath); - Assert.NotNull(model); - Assert.Single(model.Items); - Assert.Equal("CatLibrary.Cat%602.html", model.Items[0].TopicHref); - Assert.Equal(16, model.Items[0].Items.Count); - Assert.Equal("CatLibrary.Cat-2.op_Addition.html", model.Items[0].Items[0].TopicHref); - Assert.Equal("Addition", model.Items[0].Items[0].Name); - Assert.Equal("CatLibrary.Cat-2.op_Subtraction.html", model.Items[0].Items[15].TopicHref); - Assert.Equal("Subtraction", model.Items[0].Items[15].Name); - - var ctor = model.Items[0].Items.FirstOrDefault(s => s.Name == "Cat"); - Assert.NotNull(ctor); - Assert.Equal("CatLibrary.Cat`2.#ctor*", ctor.TopicUid); - Assert.Equal("Constructor", ctor.Metadata["type"].ToString()); - Assert.Equal(new List { "net2", "net46" }, JArray.FromObject(ctor.Metadata[Constants.PropertyName.Platform]).Select(s => s.ToString()).ToList()); - Assert.Equal(new List { "net2", "net46" }, JArray.FromObject(ctor.Metadata[Constants.MetadataName.Version]).Select(s => s.ToString()).ToList()); - } - { - var manifestFile = Path.GetFullPath(Path.Combine(_outputFolder, "manifest.json")); - var manifest = JsonUtility.Deserialize(manifestFile); - Assert.Equal(17, manifest.Files.Count); - - // NOTE: split output files have the same source file path - var groups = manifest.Files.GroupBy(s => s.SourceRelativePath).ToList().OrderByDescending(s => s.Count()).ToList(); - Assert.Single(groups); - } - } - - [Fact] - public void ProcessMrefWithLongPathShouldSucceed() - { - var files = new FileCollection(Directory.GetCurrentDirectory()); - files.Add(DocumentType.Article, new[] { "TestData/mref/System.Activities.Presentation.Model.ModelItemDictionary.yml" }, "TestData/"); - files.Add(DocumentType.Article, new[] { "TestData/mref/ModelItemDictionary/toc.yml" }, "TestData/"); - BuildDocument(files); - { - var outputRawModelPath = GetRawModelFilePath("System.Activities.Presentation.Model.ModelItemDictionary.yml"); - Assert.True(File.Exists(outputRawModelPath)); - var model = JsonUtility.Deserialize(outputRawModelPath); - Assert.NotNull(model); - - Assert.Equal("Hello world!", model.Metadata["meta"]); - Assert.Equal(43, model.Children.Count); - } - { - var outputRawModelPath = GetRawModelFilePath("System.Activities.Presentation.Model.ModelItemDictionary.Add.yml"); - Assert.True(File.Exists(outputRawModelPath)); - var model = JsonUtility.Deserialize(outputRawModelPath); - Assert.NotNull(model); - - Assert.Equal("Hello world!", model.Metadata["meta"]); - Assert.Equal(MemberType.Method, model.Type); - Assert.Equal(2, model.Children.Count); - Assert.Equal(new List { "net-11", "net-20", "netcore-10" }, model.Platform); - } - { - var outputRawModelPath = GetRawModelFilePath("System.Activities.Presentation.Model.ModelItemDictionary.Add_1.yml"); - Assert.True(File.Exists(outputRawModelPath)); - var model = JsonUtility.Deserialize(outputRawModelPath); - Assert.NotNull(model); - - Assert.Equal("Hello world!", model.Metadata["meta"]); - Assert.Equal(MemberType.Method, model.Type); - Assert.Single(model.Children); - Assert.Equal(new List { "net-11", "net-20", "netcore-10" }, model.Platform); - Assert.True(model.IsExplicitInterfaceImplementation); - } - { - var outputRawModelPath = GetRawModelFilePath("ModelItemDictionary/toc.yml"); - Assert.True(File.Exists(outputRawModelPath)); - var model = JsonUtility.Deserialize(outputRawModelPath); - Assert.NotNull(model); - Assert.Single(model.Items); - Assert.Equal("../System.Activities.Presentation.Model.ModelItemDictionary.html", model.Items[0].TopicHref); - Assert.Equal(38, model.Items[0].Items.Count); - - Assert.Equal("../System.Activities.Presentation.Model.ModelItemDictionary.Add.html", model.Items[0].Items[0].TopicHref); - Assert.Equal("Add", model.Items[0].Items[0].Name); - - var eiiItem = model.Items[0].Items[20]; - Assert.Equal(5, eiiItem.Metadata.Count); - Assert.True(eiiItem.Metadata["isEii"] as bool?); - } - } - - [Fact(Skip = "Fix this on ubuntu")] - public void CheckDuplicateFileName() - { - var files = new FileCollection(Directory.GetCurrentDirectory()); - files.Add(DocumentType.Article, new[] { "TestData/mref/com.microsoft.azure.management.sql.SqlServer.FirewallRules.yml" }, "TestData/"); - files.Add(DocumentType.Article, new[] { "TestData/mref/com.microsoft.azure.management.sql.SqlServer.yml" }, "TestData/"); - files.Add(DocumentType.Article, new[] { "TestData/mref/com.microsoft.azure.management.sql.yml" }, "TestData/"); - files.Add(DocumentType.Article, new[] { "TestData/mref/sql/toc.yml" }, "TestData/"); - BuildDocument(files); - - var ignoreCase = PathUtility.IsPathCaseInsensitive(); - { - var outputRawModelPath = GetRawModelFilePath("com.microsoft.azure.management.sql.SqlServer.firewallRules(Method).yml"); - Assert.True(File.Exists(outputRawModelPath)); - var model = JsonUtility.Deserialize(outputRawModelPath); - Assert.NotNull(model); - - Assert.Equal("mref/com.microsoft.azure.management.sql.SqlServer.firewallRules(Method).html", model.Metadata["_path"].ToString(), ignoreCase); - Assert.Equal("TestData/mref/com.microsoft.azure.management.sql.SqlServer.firewallRules(Method).yml", model.Metadata["_key"].ToString(), ignoreCase); - } - { - var outputRawModelPath = GetRawModelFilePath("com.microsoft.azure.management.sql.SqlServer.FirewallRules(Interface).yml"); - Assert.True(File.Exists(outputRawModelPath)); - var model = JsonUtility.Deserialize(outputRawModelPath); - Assert.NotNull(model); - - Assert.Equal("mref/com.microsoft.azure.management.sql.SqlServer.FirewallRules(Interface).html", model.Metadata["_path"].ToString(), ignoreCase); - Assert.Equal("TestData/mref/com.microsoft.azure.management.sql.SqlServer.FirewallRules(Interface).yml", model.Metadata["_key"].ToString(), ignoreCase); - } - { - var outputRawModelPath = GetRawModelFilePath("com.microsoft.azure.management.sql.SqlServer.firewallRules(Interface)_1.yml"); - Assert.True(File.Exists(outputRawModelPath)); - var model = JsonUtility.Deserialize(outputRawModelPath); - Assert.NotNull(model); - - Assert.Equal("mref/com.microsoft.azure.management.sql.SqlServer.firewallRules(Interface)_1.html", model.Metadata["_path"].ToString(), ignoreCase); - Assert.Equal("TestData/mref/com.microsoft.azure.management.sql.SqlServer.firewallRules(Interface)_1.yml", model.Metadata["_key"].ToString(), ignoreCase); - } - { - var outputRawModelPath = GetRawModelFilePath("sql/toc.yml"); - Assert.True(File.Exists(outputRawModelPath)); - var model = JsonUtility.Deserialize(outputRawModelPath); - Assert.NotNull(model); - - var topicHref = new List - { - model.Items[0].Items[0].Items[0].TopicHref, - model.Items[0].Items[1].TopicHref, - model.Items[0].Items[2].TopicHref - }; - Assert.Contains("../com.microsoft.azure.management.sql.SqlServer.firewallRules(Method).html", topicHref, FilePathComparer.OSPlatformSensitiveStringComparer); - Assert.Contains("../com.microsoft.azure.management.sql.SqlServer.FirewallRules(Interface).html", topicHref, FilePathComparer.OSPlatformSensitiveStringComparer); - Assert.Contains("../com.microsoft.azure.management.sql.SqlServer.firewallRules(Interface)_1.html", topicHref, FilePathComparer.OSPlatformSensitiveStringComparer); - } - } - - private void BuildDocument(FileCollection files) - { - var parameters = new DocumentBuildParameters - { - Files = files, - OutputBaseDir = _outputFolder, - ApplyTemplateSettings = _applyTemplateSettings, - Metadata = new Dictionary - { - ["meta"] = "Hello world!", - }.ToImmutableDictionary(), - TemplateManager = _templateManager - }; - - using var builder = new DocumentBuilder(LoadAssemblies(), ImmutableArray.Empty); - builder.Build(parameters); - } - - private static IEnumerable LoadAssemblies() - { - yield return typeof(ManagedReferenceDocumentProcessor).Assembly; - yield return typeof(SplitClassPageToMemberLevel).Assembly; - yield return typeof(TocDocumentProcessor).Assembly; - } - - private string GetRawModelFilePath(string fileName) - { - return Path.GetFullPath(Path.Combine(_outputFolder, MrefDirectory, Path.ChangeExtension(fileName, RawModelFileExtension))); - } - - private string GetOutputFilePath(string fileName) - { - return Path.GetFullPath(Path.Combine(_outputFolder, Path.ChangeExtension(fileName, "html"))); - } -} diff --git a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/CatLibrary.Cat`2.yml b/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/CatLibrary.Cat`2.yml deleted file mode 100644 index 0a6a393464a..00000000000 --- a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/CatLibrary.Cat`2.yml +++ /dev/null @@ -1,2001 +0,0 @@ -### YamlMime:ManagedReference -items: -- uid: CatLibrary.Cat`2 - commentId: T:CatLibrary.Cat`2 - id: Cat`2 - parent: CatLibrary - children: - - CatLibrary.Cat`2.#ctor - - CatLibrary.Cat`2.#ctor(`0) - - CatLibrary.Cat`2.#ctor(System.String,System.Int32@,System.String,System.Boolean) - - CatLibrary.Cat`2.Age - - CatLibrary.Cat`2.CalculateFood(System.DateTime) - - CatLibrary.Cat`2.CatLibrary#IAnimal#Eat - - CatLibrary.Cat`2.CatLibrary#IAnimal#Eat(System.String) - - CatLibrary.Cat`2.CatLibrary#IAnimal#Eat``1(``0) - - CatLibrary.Cat`2.CatLibrary#IAnimal#Item(System.Int32) - - CatLibrary.Cat`2.CatLibrary#ICat#eat - - CatLibrary.Cat`2.Equals(System.Object) - - CatLibrary.Cat`2.GetTailLength(System.Int32*,System.Object[]) - - CatLibrary.Cat`2.isHealthy - - CatLibrary.Cat`2.Item(System.String) - - CatLibrary.Cat`2.Jump(`0,`1,System.Boolean@) - - CatLibrary.Cat`2.Name - - CatLibrary.Cat`2.op_Addition(CatLibrary.Cat{`0,`1},System.Int32) - - CatLibrary.Cat`2.op_Explicit(CatLibrary.Cat{`0,`1})~CatLibrary.Tom - - CatLibrary.Cat`2.op_Subtraction(CatLibrary.Cat{`0,`1},System.Int32) - - CatLibrary.Cat`2.ownEat - langs: - - csharp - - vb - name: Cat - nameWithType: Cat - fullName: CatLibrary.Cat - type: Class - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: Cat - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 112 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\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" - remarks: "\n

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

\n\n" - example: - - "\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)();\n    int catNumber = new int();\n    unsafe\n    {\n        a.GetFeetLength(catNumber);\n    }
\n

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

\n" - syntax: - content: >- - [Serializable] - - public class Cat : ICat, IAnimal where T : class, new ()where K : struct - content.vb: >- - - - Public Class Cat(Of T As {Class, New}, K As Structure) - Implements ICat, IAnimal - typeParameters: - - id: T - description: This type should be class and can new instance. - - id: K - description: This type is a struct type, class type can't be used for this parameter. - inheritance: - - System.Object - implements: - - CatLibrary.ICat - - CatLibrary.IAnimal - inheritedMembers: - - System.Object.ToString - - System.Object.Equals(System.Object,System.Object) - - System.Object.ReferenceEquals(System.Object,System.Object) - - System.Object.GetHashCode - - System.Object.GetType - - System.Object.MemberwiseClone - extensionMethods: - - CatLibrary.ICat.CatLibrary.ICatExtension.Sleep(System.Int64) - - CatLibrary.ICat.CatLibrary.ICatExtension.Play(System.String) - attributes: - - type: System.SerializableAttribute - ctor: System.SerializableAttribute.#ctor - arguments: [] - nameWithType.vb: Cat(Of T, K) - fullName.vb: CatLibrary.Cat(Of T, K) - name.vb: Cat(Of T, K) -- uid: CatLibrary.Cat`2.#ctor - commentId: M:CatLibrary.Cat`2.#ctor - id: '#ctor' - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - platform: - - net46 - version: - - net46 - name: Cat() - nameWithType: Cat.Cat() - fullName: CatLibrary.Cat.Cat() - type: Constructor - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: .ctor - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 121 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nDefault constructor.\n" - example: [] - syntax: - content: public Cat() - content.vb: Public Sub New - overload: CatLibrary.Cat`2.#ctor* - nameWithType.vb: Cat(Of T, K).Cat() - fullName.vb: CatLibrary.Cat(Of T, K).Cat() -- uid: CatLibrary.Cat`2.#ctor(`0) - commentId: M:CatLibrary.Cat`2.#ctor(`0) - id: '#ctor(`0)' - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - platform: - - net2 - version: - - net2 - name: Cat(T) - nameWithType: Cat.Cat(T) - fullName: CatLibrary.Cat.Cat(T) - type: Constructor - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: .ctor - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 127 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nConstructor with one generic parameter.\n" - example: [] - syntax: - content: public Cat(T ownType) - content.vb: Public Sub New(ownType As T) - parameters: - - id: ownType - type: '{T}' - description: This parameter type defined by class. - overload: CatLibrary.Cat`2.#ctor* - nameWithType.vb: Cat(Of T, K).Cat(T) - fullName.vb: CatLibrary.Cat(Of T, K).Cat(T) -- uid: CatLibrary.Cat`2.#ctor(System.String,System.Int32@,System.String,System.Boolean) - commentId: M:CatLibrary.Cat`2.#ctor(System.String,System.Int32@,System.String,System.Boolean) - id: '#ctor(System.String,System.Int32@,System.String,System.Boolean)' - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - name: Cat(String, out Int32, String, Boolean) - nameWithType: Cat.Cat(String, out Int32, String, Boolean) - fullName: CatLibrary.Cat.Cat(System.String, out System.Int32, System.String, System.Boolean) - type: Constructor - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: .ctor - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 136 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nIt's a complex constructor. The parameter will have some attributes.\n" - example: [] - syntax: - content: public Cat(string nickName, out int age, string realName, bool isHealthy) - content.vb: Public Sub New(nickName As String, ByRef age As Integer, realName As String, isHealthy As Boolean) - parameters: - - id: nickName - type: System.String - description: it's string type. - - id: age - type: System.Int32 - description: It's an out and ref parameter. - - id: realName - type: System.String - description: It's an out paramter. - - id: isHealthy - type: System.Boolean - description: It's an in parameter. - overload: CatLibrary.Cat`2.#ctor* - nameWithType.vb: Cat(Of T, K).Cat(String, ByRef Int32, String, Boolean) - fullName.vb: CatLibrary.Cat(Of T, K).Cat(System.String, ByRef System.Int32, System.String, System.Boolean) - name.vb: Cat(String, ByRef Int32, String, Boolean) -- uid: CatLibrary.Cat`2.CalculateFood(System.DateTime) - commentId: M:CatLibrary.Cat`2.CalculateFood(System.DateTime) - id: CalculateFood(System.DateTime) - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - name: CalculateFood(DateTime) - nameWithType: Cat.CalculateFood(DateTime) - fullName: CatLibrary.Cat.CalculateFood(System.DateTime) - type: Method - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: CalculateFood - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 144 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nIt's a method with complex return type.\n" - example: [] - syntax: - content: public Dictionary> CalculateFood(DateTime date) - content.vb: Public Function CalculateFood(date As Date) As Dictionary(Of String, List(Of Integer)) - parameters: - - id: date - type: System.DateTime - description: Date time to now. - return: - type: System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.Int32}} - description: It's a relationship map of different kind food. - overload: CatLibrary.Cat`2.CalculateFood* - nameWithType.vb: Cat(Of T, K).CalculateFood(DateTime) - fullName.vb: CatLibrary.Cat(Of T, K).CalculateFood(System.DateTime) -- uid: CatLibrary.Cat`2.Jump(`0,`1,System.Boolean@) - commentId: M:CatLibrary.Cat`2.Jump(`0,`1,System.Boolean@) - id: Jump(`0,`1,System.Boolean@) - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - name: Jump(T, K, ref Boolean) - nameWithType: Cat.Jump(T, K, ref Boolean) - fullName: CatLibrary.Cat.Jump(T, K, ref System.Boolean) - type: Method - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: Jump - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 153 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nThis method have attribute above it.\n" - example: [] - syntax: - content: >- - [Conditional("Debug")] - - public void Jump(T ownType, K anotherOwnType, ref bool cheat) - content.vb: >- - - - Public Sub Jump(ownType As T, anotherOwnType As K, ByRef cheat As Boolean) - parameters: - - id: ownType - type: '{T}' - description: Type come from class define. - - id: anotherOwnType - type: '{K}' - description: Type come from class define. - - id: cheat - type: System.Boolean - description: Hint whether this cat has cheat mode. - overload: CatLibrary.Cat`2.Jump* - exceptions: - - type: System.ArgumentException - commentId: T:System.ArgumentException - description: This is an argument exception - attributes: - - type: System.Diagnostics.ConditionalAttribute - ctor: System.Diagnostics.ConditionalAttribute.#ctor(System.String) - arguments: - - type: System.String - value: Debug - nameWithType.vb: Cat(Of T, K).Jump(T, K, ByRef Boolean) - fullName.vb: CatLibrary.Cat(Of T, K).Jump(T, K, ByRef System.Boolean) - name.vb: Jump(T, K, ByRef Boolean) -- uid: CatLibrary.Cat`2.Equals(System.Object) - commentId: M:CatLibrary.Cat`2.Equals(System.Object) - id: Equals(System.Object) - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - name: Equals(Object) - nameWithType: Cat.Equals(Object) - fullName: CatLibrary.Cat.Equals(System.Object) - type: Method - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: Equals - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 164 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nOverride the method of Object.Equals(object obj).\n" - example: [] - syntax: - content: public override bool Equals(object obj) - content.vb: Public Overrides Function Equals(obj As Object) As Boolean - parameters: - - id: obj - type: System.Object - description: Can pass any class type. - return: - type: System.Boolean - description: The return value tell you whehter the compare operation is successful. - overridden: System.Object.Equals(System.Object) - overload: CatLibrary.Cat`2.Equals* - nameWithType.vb: Cat(Of T, K).Equals(Object) - fullName.vb: CatLibrary.Cat(Of T, K).Equals(System.Object) -- uid: CatLibrary.Cat`2.GetTailLength(System.Int32*,System.Object[]) - commentId: M:CatLibrary.Cat`2.GetTailLength(System.Int32*,System.Object[]) - id: GetTailLength(System.Int32*,System.Object[]) - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - name: GetTailLength(Int32*, Object[]) - nameWithType: Cat.GetTailLength(Int32*, Object[]) - fullName: CatLibrary.Cat.GetTailLength(System.Int32*, System.Object[]) - type: Method - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: GetTailLength - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 172 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nIt's an unsafe method.\n" - example: [] - syntax: - content: public long GetTailLength(int *catName, params object[] parameters) - content.vb: Public Function GetTailLength(catName As Integer *, ParamArray parameters As Object()) As Long - parameters: - - id: catName - type: System.Int32* - description: Thie represent for cat name length. - - id: parameters - type: System.Object[] - description: Optional parameters. - return: - type: System.Int64 - description: Return cat tail's length. - overload: CatLibrary.Cat`2.GetTailLength* - nameWithType.vb: Cat(Of T, K).GetTailLength(Int32*, Object()) - fullName.vb: CatLibrary.Cat(Of T, K).GetTailLength(System.Int32*, System.Object()) - name.vb: GetTailLength(Int32*, Object()) -- uid: CatLibrary.Cat`2.op_Addition(CatLibrary.Cat{`0,`1},System.Int32) - commentId: M:CatLibrary.Cat`2.op_Addition(CatLibrary.Cat{`0,`1},System.Int32) - id: op_Addition(CatLibrary.Cat{`0,`1},System.Int32) - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - name: Addition(Cat, Int32) - nameWithType: Cat.Addition(Cat, Int32) - fullName: CatLibrary.Cat.Addition(CatLibrary.Cat, System.Int32) - type: Operator - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: op_Addition - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 181 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nAddition operator of this class.\n" - example: [] - syntax: - content: public static int operator +(Cat lsr, int rsr) - content.vb: Public Shared Operator +(lsr As Cat(Of T, K), rsr As Integer) As Integer - parameters: - - id: lsr - type: CatLibrary.Cat`2 - description: '...' - - id: rsr - type: System.Int32 - description: ~~~ - return: - type: System.Int32 - description: Result with int type. - overload: CatLibrary.Cat`2.op_Addition* - nameWithType.vb: Cat(Of T, K).Addition(Cat(Of T, K), Int32) - fullName.vb: CatLibrary.Cat(Of T, K).Addition(CatLibrary.Cat(Of T, K), System.Int32) - name.vb: Addition(Cat(Of T, K), Int32) -- uid: CatLibrary.Cat`2.op_Subtraction(CatLibrary.Cat{`0,`1},System.Int32) - commentId: M:CatLibrary.Cat`2.op_Subtraction(CatLibrary.Cat{`0,`1},System.Int32) - id: op_Subtraction(CatLibrary.Cat{`0,`1},System.Int32) - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - name: Subtraction(Cat, Int32) - nameWithType: Cat.Subtraction(Cat, Int32) - fullName: CatLibrary.Cat.Subtraction(CatLibrary.Cat, System.Int32) - type: Operator - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: op_Subtraction - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 186 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nSimilar with operaotr +, refer to that topic.\n" - example: [] - syntax: - content: public static int operator -(Cat lsr, int rsr) - content.vb: Public Shared Operator -(lsr As Cat(Of T, K), rsr As Integer) As Integer - parameters: - - id: lsr - type: CatLibrary.Cat`2 - - id: rsr - type: System.Int32 - return: - type: System.Int32 - overload: CatLibrary.Cat`2.op_Subtraction* - nameWithType.vb: Cat(Of T, K).Subtraction(Cat(Of T, K), Int32) - fullName.vb: CatLibrary.Cat(Of T, K).Subtraction(CatLibrary.Cat(Of T, K), System.Int32) - name.vb: Subtraction(Cat(Of T, K), Int32) -- uid: CatLibrary.Cat`2.op_Explicit(CatLibrary.Cat{`0,`1})~CatLibrary.Tom - commentId: M:CatLibrary.Cat`2.op_Explicit(CatLibrary.Cat{`0,`1})~CatLibrary.Tom - id: op_Explicit(CatLibrary.Cat{`0,`1})~CatLibrary.Tom - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - name: Explicit(Cat to Tom) - nameWithType: Cat.Explicit(Cat to Tom) - fullName: CatLibrary.Cat.Explicit(CatLibrary.Cat to CatLibrary.Tom) - type: Operator - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: op_Explicit - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 194 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nExpilicit operator of this class.\n

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

\n" - example: [] - syntax: - content: public static explicit operator Tom(Cat src) - content.vb: Public Shared Narrowing Operator CType(src As Cat(Of T, K)) As Tom - parameters: - - id: src - type: CatLibrary.Cat`2 - description: Instance of this class. - return: - type: CatLibrary.Tom - description: Advanced class type of cat. - overload: CatLibrary.Cat`2.op_Explicit* - nameWithType.vb: Cat(Of T, K).Narrowing(Cat(Of T, K) to Tom) - fullName.vb: CatLibrary.Cat(Of T, K).Narrowing(CatLibrary.Cat(Of T, K) to CatLibrary.Tom) - name.vb: Narrowing(Cat(Of T, K) to Tom) -- uid: CatLibrary.Cat`2.Item(System.String) - commentId: P:CatLibrary.Cat`2.Item(System.String) - id: Item(System.String) - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - name: Item[String] - nameWithType: Cat.Item[String] - fullName: CatLibrary.Cat.Item[System.String] - type: Property - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: this[] - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 202 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nThis is index property of Cat. You can see that the visibility is different between get and set method.\n" - example: [] - syntax: - content: public int this[string a] { protected get; set; } - content.vb: Public Property Item(a As String) As Integer - parameters: - - id: a - type: System.String - description: Cat's name. - return: - type: System.Int32 - description: Cat's number. - overload: CatLibrary.Cat`2.Item* - nameWithType.vb: Cat(Of T, K).Item(String) - fullName.vb: CatLibrary.Cat(Of T, K).Item(System.String) - name.vb: Item(String) -- uid: CatLibrary.Cat`2.Age - commentId: P:CatLibrary.Cat`2.Age - id: Age - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - name: Age - nameWithType: Cat.Age - fullName: CatLibrary.Cat.Age - type: Property - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: Age - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 211 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nHint cat's age.\n" - example: [] - syntax: - content: protected int Age { get; set; } - content.vb: Protected Property Age As Integer - parameters: [] - return: - type: System.Int32 - overload: CatLibrary.Cat`2.Age* - nameWithType.vb: Cat(Of T, K).Age - fullName.vb: CatLibrary.Cat(Of T, K).Age -- uid: CatLibrary.Cat`2.ownEat - commentId: E:CatLibrary.Cat`2.ownEat - id: ownEat - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - name: ownEat - nameWithType: Cat.ownEat - fullName: CatLibrary.Cat.ownEat - type: Event - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: ownEat - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 221 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nEat event of this cat\n" - example: [] - syntax: - content: public event EventHandler ownEat - content.vb: Public Event ownEat As EventHandler - return: - type: System.EventHandler - nameWithType.vb: Cat(Of T, K).ownEat - fullName.vb: CatLibrary.Cat(Of T, K).ownEat -- uid: CatLibrary.Cat`2.isHealthy - commentId: F:CatLibrary.Cat`2.isHealthy - id: isHealthy - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - name: isHealthy - nameWithType: Cat.isHealthy - fullName: CatLibrary.Cat.isHealthy - type: Field - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: isHealthy - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 229 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nField with attribute.\n" - example: [] - syntax: - content: >- - [ContextStatic] - - [NonSerialized] - - public bool isHealthy - content.vb: >- - - - - - Public isHealthy As Boolean - return: - type: System.Boolean - attributes: - - type: System.ContextStaticAttribute - ctor: System.ContextStaticAttribute.#ctor - arguments: [] - - type: System.NonSerializedAttribute - ctor: System.NonSerializedAttribute.#ctor - arguments: [] - nameWithType.vb: Cat(Of T, K).isHealthy - fullName.vb: CatLibrary.Cat(Of T, K).isHealthy -- uid: CatLibrary.Cat`2.CatLibrary#IAnimal#Eat - commentId: M:CatLibrary.Cat`2.CatLibrary#IAnimal#Eat - id: CatLibrary#IAnimal#Eat - isEii: true - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - name: IAnimal.Eat() - nameWithType: Cat.IAnimal.Eat() - fullName: CatLibrary.Cat.CatLibrary.IAnimal.Eat() - type: Method - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: CatLibrary.IAnimal.Eat - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 235 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nEII method.\n" - example: [] - syntax: - content: void IAnimal.Eat() - content.vb: Sub CatLibrary.IAnimal.Eat Implements IAnimal.Eat - overload: CatLibrary.Cat`2.CatLibrary#IAnimal#Eat* - implements: - - CatLibrary.IAnimal.Eat - nameWithType.vb: Cat(Of T, K).CatLibrary.IAnimal.Eat() - fullName.vb: CatLibrary.Cat(Of T, K).CatLibrary.IAnimal.Eat() - name.vb: CatLibrary.IAnimal.Eat() -- uid: CatLibrary.Cat`2.CatLibrary#IAnimal#Eat``1(``0) - commentId: M:CatLibrary.Cat`2.CatLibrary#IAnimal#Eat``1(``0) - id: CatLibrary#IAnimal#Eat``1(``0) - isEii: true - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - name: IAnimal.Eat(Tool) - nameWithType: Cat.IAnimal.Eat(Tool) - fullName: CatLibrary.Cat.CatLibrary.IAnimal.Eat(Tool) - type: Method - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: CatLibrary.IAnimal.Eat - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 241 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nEII template method.\n" - example: [] - syntax: - content: 'void IAnimal.Eat(Tool a)where Tool : class' - content.vb: Sub CatLibrary.IAnimal.Eat(Of Tool As Class)(a As Tool) Implements IAnimal.Eat - parameters: - - id: a - type: '{Tool}' - description: Tool name. - typeParameters: - - id: Tool - description: Tool for eat. - overload: CatLibrary.Cat`2.CatLibrary#IAnimal#Eat* - implements: - - CatLibrary.IAnimal.Eat``1({Tool}) - nameWithType.vb: Cat(Of T, K).CatLibrary.IAnimal.Eat(Of Tool)(Tool) - fullName.vb: CatLibrary.Cat(Of T, K).CatLibrary.IAnimal.Eat(Of Tool)(Tool) - name.vb: CatLibrary.IAnimal.Eat(Of Tool)(Tool) -- uid: CatLibrary.Cat`2.CatLibrary#IAnimal#Eat(System.String) - commentId: M:CatLibrary.Cat`2.CatLibrary#IAnimal#Eat(System.String) - id: CatLibrary#IAnimal#Eat(System.String) - isEii: true - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - name: IAnimal.Eat(String) - nameWithType: Cat.IAnimal.Eat(String) - fullName: CatLibrary.Cat.CatLibrary.IAnimal.Eat(System.String) - type: Method - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: CatLibrary.IAnimal.Eat - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 247 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nImplementation of Eat(food)\n" - example: [] - syntax: - content: void IAnimal.Eat(string food) - content.vb: Sub CatLibrary.IAnimal.Eat(food As String) Implements IAnimal.Eat - parameters: - - id: food - type: System.String - description: Food to eat - overload: CatLibrary.Cat`2.CatLibrary#IAnimal#Eat* - implements: - - CatLibrary.IAnimal.Eat(System.String) - nameWithType.vb: Cat(Of T, K).CatLibrary.IAnimal.Eat(String) - fullName.vb: CatLibrary.Cat(Of T, K).CatLibrary.IAnimal.Eat(System.String) - name.vb: CatLibrary.IAnimal.Eat(String) -- uid: CatLibrary.Cat`2.Name - commentId: P:CatLibrary.Cat`2.Name - id: Name - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - name: Name - nameWithType: Cat.Name - fullName: CatLibrary.Cat.Name - type: Property - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: Name - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 253 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nEII property.\n" - example: [] - syntax: - content: public string Name { get; } - content.vb: Public ReadOnly Property Name As String - parameters: [] - return: - type: System.String - overload: CatLibrary.Cat`2.Name* - implements: - - CatLibrary.IAnimal.Name - nameWithType.vb: Cat(Of T, K).Name - fullName.vb: CatLibrary.Cat(Of T, K).Name -- uid: CatLibrary.Cat`2.CatLibrary#IAnimal#Item(System.Int32) - commentId: P:CatLibrary.Cat`2.CatLibrary#IAnimal#Item(System.Int32) - id: CatLibrary#IAnimal#Item(System.Int32) - isEii: true - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - name: IAnimal.Item[Int32] - nameWithType: Cat.IAnimal.Item[Int32] - fullName: CatLibrary.Cat.CatLibrary.IAnimal.Item[System.Int32] - type: Property - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: CatLibrary.IAnimal.this[] - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 260 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nEII index.\n" - example: [] - syntax: - content: string IAnimal.this[int a] { get; } - content.vb: ReadOnly WriteOnly Property CatLibrary.IAnimal.Item(a As Integer) As String Implements IAnimal.this - parameters: - - id: a - type: System.Int32 - description: Cat's number. - return: - type: System.String - description: Cat's name. - overload: CatLibrary.Cat`2.CatLibrary#IAnimal#Item* - implements: - - CatLibrary.IAnimal.Item(System.Int32) - nameWithType.vb: Cat(Of T, K).CatLibrary.IAnimal.Item(Int32) - fullName.vb: CatLibrary.Cat(Of T, K).CatLibrary.IAnimal.Item(System.Int32) - name.vb: CatLibrary.IAnimal.Item(Int32) -- uid: CatLibrary.Cat`2.CatLibrary#ICat#eat - commentId: E:CatLibrary.Cat`2.CatLibrary#ICat#eat - id: CatLibrary#ICat#eat - isEii: true - parent: CatLibrary.Cat`2 - langs: - - csharp - - vb - name: ICat.eat - nameWithType: Cat.ICat.eat - fullName: CatLibrary.Cat.CatLibrary.ICat.eat - type: Event - source: - remote: - path: src/SampleClass1/CatLibrary/Class1.cs - branch: master - repo: https://github.com/docascode/docfx-seed.git - id: CatLibrary.ICat.eat - path: src/SampleClass1/CatLibrary/Class1.cs - startLine: 266 - assemblies: - - CatLibrary - namespace: CatLibrary - summary: "\nEII event.\n" - example: [] - syntax: - content: event EventHandler ICat.eat - content.vb: Event CatLibrary.ICat.eat As EventHandler Implements ICat.eat - return: - type: System.EventHandler - implements: - - CatLibrary.ICat.eat - nameWithType.vb: Cat(Of T, K).CatLibrary.ICat.eat - fullName.vb: CatLibrary.Cat(Of T, K).CatLibrary.ICat.eat - name.vb: CatLibrary.ICat.eat -references: -- uid: CatLibrary.ICatExtension - commentId: T:CatLibrary.ICatExtension - parent: CatLibrary - isExternal: false - name: ICatExtension - nameWithType: ICatExtension - fullName: CatLibrary.ICatExtension -- uid: CatLibrary - commentId: N:CatLibrary - isExternal: false - name: CatLibrary - nameWithType: CatLibrary - fullName: CatLibrary -- uid: System.Object - commentId: T:System.Object - parent: System - isExternal: true - name: Object - nameWithType: Object - fullName: System.Object -- uid: CatLibrary.ICat - commentId: T:CatLibrary.ICat - parent: CatLibrary - isExternal: false - name: ICat - nameWithType: ICat - fullName: CatLibrary.ICat -- uid: CatLibrary.IAnimal - commentId: T:CatLibrary.IAnimal - parent: CatLibrary - isExternal: false - name: IAnimal - nameWithType: IAnimal - fullName: CatLibrary.IAnimal -- uid: System.Object.ToString - commentId: M:System.Object.ToString - parent: System.Object - isExternal: true - name: ToString() - nameWithType: Object.ToString() - fullName: System.Object.ToString() - spec.csharp: - - uid: System.Object.ToString - name: ToString - nameWithType: Object.ToString - fullName: System.Object.ToString - isExternal: true - - name: ( - nameWithType: ( - fullName: ( - - name: ) - nameWithType: ) - fullName: ) - spec.vb: - - uid: System.Object.ToString - name: ToString - nameWithType: Object.ToString - fullName: System.Object.ToString - isExternal: true - - name: ( - nameWithType: ( - fullName: ( - - name: ) - nameWithType: ) - fullName: ) -- uid: System.Object.Equals(System.Object,System.Object) - commentId: M:System.Object.Equals(System.Object,System.Object) - parent: System.Object - isExternal: true - name: Equals(Object, Object) - nameWithType: Object.Equals(Object, Object) - fullName: System.Object.Equals(System.Object, System.Object) - spec.csharp: - - uid: System.Object.Equals(System.Object,System.Object) - name: Equals - nameWithType: Object.Equals - fullName: System.Object.Equals - isExternal: true - - name: ( - nameWithType: ( - fullName: ( - - uid: System.Object - name: Object - nameWithType: Object - fullName: System.Object - isExternal: true - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - uid: System.Object - name: Object - nameWithType: Object - fullName: System.Object - isExternal: true - - name: ) - nameWithType: ) - fullName: ) - spec.vb: - - uid: System.Object.Equals(System.Object,System.Object) - name: Equals - nameWithType: Object.Equals - fullName: System.Object.Equals - isExternal: true - - name: ( - nameWithType: ( - fullName: ( - - uid: System.Object - name: Object - nameWithType: Object - fullName: System.Object - isExternal: true - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - uid: System.Object - name: Object - nameWithType: Object - fullName: System.Object - isExternal: true - - name: ) - nameWithType: ) - fullName: ) -- uid: System.Object.ReferenceEquals(System.Object,System.Object) - commentId: M:System.Object.ReferenceEquals(System.Object,System.Object) - parent: System.Object - isExternal: true - name: ReferenceEquals(Object, Object) - nameWithType: Object.ReferenceEquals(Object, Object) - fullName: System.Object.ReferenceEquals(System.Object, System.Object) - spec.csharp: - - uid: System.Object.ReferenceEquals(System.Object,System.Object) - name: ReferenceEquals - nameWithType: Object.ReferenceEquals - fullName: System.Object.ReferenceEquals - isExternal: true - - name: ( - nameWithType: ( - fullName: ( - - uid: System.Object - name: Object - nameWithType: Object - fullName: System.Object - isExternal: true - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - uid: System.Object - name: Object - nameWithType: Object - fullName: System.Object - isExternal: true - - name: ) - nameWithType: ) - fullName: ) - spec.vb: - - uid: System.Object.ReferenceEquals(System.Object,System.Object) - name: ReferenceEquals - nameWithType: Object.ReferenceEquals - fullName: System.Object.ReferenceEquals - isExternal: true - - name: ( - nameWithType: ( - fullName: ( - - uid: System.Object - name: Object - nameWithType: Object - fullName: System.Object - isExternal: true - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - uid: System.Object - name: Object - nameWithType: Object - fullName: System.Object - isExternal: true - - name: ) - nameWithType: ) - fullName: ) -- uid: System.Object.GetHashCode - commentId: M:System.Object.GetHashCode - parent: System.Object - isExternal: true - name: GetHashCode() - nameWithType: Object.GetHashCode() - fullName: System.Object.GetHashCode() - spec.csharp: - - uid: System.Object.GetHashCode - name: GetHashCode - nameWithType: Object.GetHashCode - fullName: System.Object.GetHashCode - isExternal: true - - name: ( - nameWithType: ( - fullName: ( - - name: ) - nameWithType: ) - fullName: ) - spec.vb: - - uid: System.Object.GetHashCode - name: GetHashCode - nameWithType: Object.GetHashCode - fullName: System.Object.GetHashCode - isExternal: true - - name: ( - nameWithType: ( - fullName: ( - - name: ) - nameWithType: ) - fullName: ) -- uid: System.Object.GetType - commentId: M:System.Object.GetType - parent: System.Object - isExternal: true - name: GetType() - nameWithType: Object.GetType() - fullName: System.Object.GetType() - spec.csharp: - - uid: System.Object.GetType - name: GetType - nameWithType: Object.GetType - fullName: System.Object.GetType - isExternal: true - - name: ( - nameWithType: ( - fullName: ( - - name: ) - nameWithType: ) - fullName: ) - spec.vb: - - uid: System.Object.GetType - name: GetType - nameWithType: Object.GetType - fullName: System.Object.GetType - isExternal: true - - name: ( - nameWithType: ( - fullName: ( - - name: ) - nameWithType: ) - fullName: ) -- uid: System.Object.MemberwiseClone - commentId: M:System.Object.MemberwiseClone - parent: System.Object - isExternal: true - name: MemberwiseClone() - nameWithType: Object.MemberwiseClone() - fullName: System.Object.MemberwiseClone() - spec.csharp: - - uid: System.Object.MemberwiseClone - name: MemberwiseClone - nameWithType: Object.MemberwiseClone - fullName: System.Object.MemberwiseClone - isExternal: true - - name: ( - nameWithType: ( - fullName: ( - - name: ) - nameWithType: ) - fullName: ) - spec.vb: - - uid: System.Object.MemberwiseClone - name: MemberwiseClone - nameWithType: Object.MemberwiseClone - fullName: System.Object.MemberwiseClone - isExternal: true - - name: ( - nameWithType: ( - fullName: ( - - name: ) - nameWithType: ) - fullName: ) -- uid: CatLibrary.ICat.CatLibrary.ICatExtension.Sleep(System.Int64) - commentId: M:CatLibrary.ICatExtension.Sleep(CatLibrary.ICat,System.Int64) - parent: CatLibrary.ICatExtension - definition: CatLibrary.ICatExtension.Sleep(CatLibrary.ICat,System.Int64) - name: Sleep(Int64) - nameWithType: ICatExtension.Sleep(Int64) - fullName: CatLibrary.ICatExtension.Sleep(System.Int64) - spec.csharp: - - uid: CatLibrary.ICatExtension.Sleep(System.Int64) - name: Sleep - nameWithType: ICatExtension.Sleep - fullName: CatLibrary.ICatExtension.Sleep - - name: ( - nameWithType: ( - fullName: ( - - uid: System.Int64 - name: Int64 - nameWithType: Int64 - fullName: System.Int64 - isExternal: true - - name: ) - nameWithType: ) - fullName: ) - spec.vb: - - uid: CatLibrary.ICatExtension.Sleep(System.Int64) - name: Sleep - nameWithType: ICatExtension.Sleep - fullName: CatLibrary.ICatExtension.Sleep - - name: ( - nameWithType: ( - fullName: ( - - uid: System.Int64 - name: Int64 - nameWithType: Int64 - fullName: System.Int64 - isExternal: true - - name: ) - nameWithType: ) - fullName: ) -- uid: CatLibrary.ICat.CatLibrary.ICatExtension.Play(System.String) - commentId: M:CatLibrary.ICatExtension.Play(CatLibrary.ICat,System.String) - parent: CatLibrary.ICatExtension - definition: CatLibrary.ICatExtension.Play(CatLibrary.ICat,System.String) - name: Play(String) - nameWithType: ICatExtension.Play(String) - fullName: CatLibrary.ICatExtension.Play(System.String) - spec.csharp: - - uid: CatLibrary.ICatExtension.Play(System.String) - name: Play - nameWithType: ICatExtension.Play - fullName: CatLibrary.ICatExtension.Play - - name: ( - nameWithType: ( - fullName: ( - - uid: System.String - name: String - nameWithType: String - fullName: System.String - isExternal: true - - name: ) - nameWithType: ) - fullName: ) - spec.vb: - - uid: CatLibrary.ICatExtension.Play(System.String) - name: Play - nameWithType: ICatExtension.Play - fullName: CatLibrary.ICatExtension.Play - - name: ( - nameWithType: ( - fullName: ( - - uid: System.String - name: String - nameWithType: String - fullName: System.String - isExternal: true - - name: ) - nameWithType: ) - fullName: ) -- uid: System - commentId: N:System - isExternal: false - name: System - nameWithType: System - fullName: System -- uid: CatLibrary.ICatExtension.Sleep(CatLibrary.ICat,System.Int64) - commentId: M:CatLibrary.ICatExtension.Sleep(CatLibrary.ICat,System.Int64) - isExternal: true - name: Sleep(ICat, Int64) - nameWithType: ICatExtension.Sleep(ICat, Int64) - fullName: CatLibrary.ICatExtension.Sleep(CatLibrary.ICat, System.Int64) - spec.csharp: - - uid: CatLibrary.ICatExtension.Sleep(CatLibrary.ICat,System.Int64) - name: Sleep - nameWithType: ICatExtension.Sleep - fullName: CatLibrary.ICatExtension.Sleep - - name: ( - nameWithType: ( - fullName: ( - - uid: CatLibrary.ICat - name: ICat - nameWithType: ICat - fullName: CatLibrary.ICat - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - uid: System.Int64 - name: Int64 - nameWithType: Int64 - fullName: System.Int64 - isExternal: true - - name: ) - nameWithType: ) - fullName: ) - spec.vb: - - uid: CatLibrary.ICatExtension.Sleep(CatLibrary.ICat,System.Int64) - name: Sleep - nameWithType: ICatExtension.Sleep - fullName: CatLibrary.ICatExtension.Sleep - - name: ( - nameWithType: ( - fullName: ( - - uid: CatLibrary.ICat - name: ICat - nameWithType: ICat - fullName: CatLibrary.ICat - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - uid: System.Int64 - name: Int64 - nameWithType: Int64 - fullName: System.Int64 - isExternal: true - - name: ) - nameWithType: ) - fullName: ) -- uid: CatLibrary.ICatExtension.Play(CatLibrary.ICat,System.String) - commentId: M:CatLibrary.ICatExtension.Play(CatLibrary.ICat,System.String) - isExternal: true - name: Play(ICat, String) - nameWithType: ICatExtension.Play(ICat, String) - fullName: CatLibrary.ICatExtension.Play(CatLibrary.ICat, System.String) - spec.csharp: - - uid: CatLibrary.ICatExtension.Play(CatLibrary.ICat,System.String) - name: Play - nameWithType: ICatExtension.Play - fullName: CatLibrary.ICatExtension.Play - - name: ( - nameWithType: ( - fullName: ( - - uid: CatLibrary.ICat - name: ICat - nameWithType: ICat - fullName: CatLibrary.ICat - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - uid: System.String - name: String - nameWithType: String - fullName: System.String - isExternal: true - - name: ) - nameWithType: ) - fullName: ) - spec.vb: - - uid: CatLibrary.ICatExtension.Play(CatLibrary.ICat,System.String) - name: Play - nameWithType: ICatExtension.Play - fullName: CatLibrary.ICatExtension.Play - - name: ( - nameWithType: ( - fullName: ( - - uid: CatLibrary.ICat - name: ICat - nameWithType: ICat - fullName: CatLibrary.ICat - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - uid: System.String - name: String - nameWithType: String - fullName: System.String - isExternal: true - - name: ) - nameWithType: ) - fullName: ) -- uid: CatLibrary.Cat`2.#ctor* - commentId: Overload:CatLibrary.Cat`2.#ctor - isExternal: false - name: Cat - nameWithType: Cat.Cat - fullName: CatLibrary.Cat.Cat - nameWithType.vb: Cat(Of T, K).Cat - fullName.vb: CatLibrary.Cat(Of T, K).Cat - summary: Overload summary - remarks: Overload *remarks* - example: - - Overload example 1 - - Overload **example 2** - not-defined: Not defined Property - namespace: Namespace cannot be defined -- uid: '{T}' - commentId: '!:T' - definition: T - name: T - nameWithType: T - fullName: T -- uid: T - isExternal: false - name: T - nameWithType: T - fullName: T -- uid: System.String - commentId: T:System.String - parent: System - isExternal: true - name: String - nameWithType: String - fullName: System.String -- uid: System.Int32 - commentId: T:System.Int32 - parent: System - isExternal: true - name: Int32 - nameWithType: Int32 - fullName: System.Int32 -- uid: System.Boolean - commentId: T:System.Boolean - parent: System - isExternal: true - name: Boolean - nameWithType: Boolean - fullName: System.Boolean -- uid: CatLibrary.Cat`2.CalculateFood* - commentId: Overload:CatLibrary.Cat`2.CalculateFood - isExternal: false - name: CalculateFood - nameWithType: Cat.CalculateFood - fullName: CatLibrary.Cat.CalculateFood - nameWithType.vb: Cat(Of T, K).CalculateFood - fullName.vb: CatLibrary.Cat(Of T, K).CalculateFood -- uid: System.DateTime - commentId: T:System.DateTime - parent: System - isExternal: true - name: DateTime - nameWithType: DateTime - fullName: System.DateTime -- uid: System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.Int32}} - commentId: T:System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.Int32}} - parent: System.Collections.Generic - definition: System.Collections.Generic.Dictionary`2 - name: Dictionary> - nameWithType: Dictionary> - fullName: System.Collections.Generic.Dictionary> - nameWithType.vb: Dictionary(Of String, List(Of Int32)) - fullName.vb: System.Collections.Generic.Dictionary(Of System.String, System.Collections.Generic.List(Of System.Int32)) - name.vb: Dictionary(Of String, List(Of Int32)) - spec.csharp: - - uid: System.Collections.Generic.Dictionary`2 - name: Dictionary - nameWithType: Dictionary - fullName: System.Collections.Generic.Dictionary - isExternal: true - - name: < - nameWithType: < - fullName: < - - uid: System.String - name: String - nameWithType: String - fullName: System.String - isExternal: true - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - uid: System.Collections.Generic.List`1 - name: List - nameWithType: List - fullName: System.Collections.Generic.List - isExternal: true - - name: < - nameWithType: < - fullName: < - - uid: System.Int32 - name: Int32 - nameWithType: Int32 - fullName: System.Int32 - isExternal: true - - name: '>' - nameWithType: '>' - fullName: '>' - - name: '>' - nameWithType: '>' - fullName: '>' - spec.vb: - - uid: System.Collections.Generic.Dictionary`2 - name: Dictionary - nameWithType: Dictionary - fullName: System.Collections.Generic.Dictionary - isExternal: true - - name: '(Of ' - nameWithType: '(Of ' - fullName: '(Of ' - - uid: System.String - name: String - nameWithType: String - fullName: System.String - isExternal: true - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - uid: System.Collections.Generic.List`1 - name: List - nameWithType: List - fullName: System.Collections.Generic.List - isExternal: true - - name: '(Of ' - nameWithType: '(Of ' - fullName: '(Of ' - - uid: System.Int32 - name: Int32 - nameWithType: Int32 - fullName: System.Int32 - isExternal: true - - name: ) - nameWithType: ) - fullName: ) - - name: ) - nameWithType: ) - fullName: ) -- uid: System.Collections.Generic.Dictionary`2 - commentId: T:System.Collections.Generic.Dictionary`2 - isExternal: true - name: Dictionary - nameWithType: Dictionary - fullName: System.Collections.Generic.Dictionary - nameWithType.vb: Dictionary(Of TKey, TValue) - fullName.vb: System.Collections.Generic.Dictionary(Of TKey, TValue) - name.vb: Dictionary(Of TKey, TValue) - spec.csharp: - - uid: System.Collections.Generic.Dictionary`2 - name: Dictionary - nameWithType: Dictionary - fullName: System.Collections.Generic.Dictionary - isExternal: true - - name: < - nameWithType: < - fullName: < - - name: TKey - nameWithType: TKey - fullName: TKey - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - name: TValue - nameWithType: TValue - fullName: TValue - - name: '>' - nameWithType: '>' - fullName: '>' - spec.vb: - - uid: System.Collections.Generic.Dictionary`2 - name: Dictionary - nameWithType: Dictionary - fullName: System.Collections.Generic.Dictionary - isExternal: true - - name: '(Of ' - nameWithType: '(Of ' - fullName: '(Of ' - - name: TKey - nameWithType: TKey - fullName: TKey - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - name: TValue - nameWithType: TValue - fullName: TValue - - name: ) - nameWithType: ) - fullName: ) -- uid: System.Collections.Generic - commentId: N:System.Collections.Generic - isExternal: false - name: System.Collections.Generic - nameWithType: System.Collections.Generic - fullName: System.Collections.Generic -- uid: CatLibrary.Cat`2.Jump* - commentId: Overload:CatLibrary.Cat`2.Jump - isExternal: false - name: Jump - nameWithType: Cat.Jump - fullName: CatLibrary.Cat.Jump - nameWithType.vb: Cat(Of T, K).Jump - fullName.vb: CatLibrary.Cat(Of T, K).Jump -- uid: System.ArgumentException - commentId: T:System.ArgumentException -- uid: '{K}' - commentId: '!:K' - definition: K - name: K - nameWithType: K - fullName: K -- uid: K - isExternal: false - name: K - nameWithType: K - fullName: K -- uid: System.Object.Equals(System.Object) - commentId: M:System.Object.Equals(System.Object) - parent: System.Object - isExternal: true - name: Equals(Object) - nameWithType: Object.Equals(Object) - fullName: System.Object.Equals(System.Object) - spec.csharp: - - uid: System.Object.Equals(System.Object) - name: Equals - nameWithType: Object.Equals - fullName: System.Object.Equals - isExternal: true - - name: ( - nameWithType: ( - fullName: ( - - uid: System.Object - name: Object - nameWithType: Object - fullName: System.Object - isExternal: true - - name: ) - nameWithType: ) - fullName: ) - spec.vb: - - uid: System.Object.Equals(System.Object) - name: Equals - nameWithType: Object.Equals - fullName: System.Object.Equals - isExternal: true - - name: ( - nameWithType: ( - fullName: ( - - uid: System.Object - name: Object - nameWithType: Object - fullName: System.Object - isExternal: true - - name: ) - nameWithType: ) - fullName: ) -- uid: CatLibrary.Cat`2.Equals* - commentId: Overload:CatLibrary.Cat`2.Equals - isExternal: false - name: Equals - nameWithType: Cat.Equals - fullName: CatLibrary.Cat.Equals - nameWithType.vb: Cat(Of T, K).Equals - fullName.vb: CatLibrary.Cat(Of T, K).Equals -- uid: CatLibrary.Cat`2.GetTailLength* - commentId: Overload:CatLibrary.Cat`2.GetTailLength - isExternal: false - name: GetTailLength - nameWithType: Cat.GetTailLength - fullName: CatLibrary.Cat.GetTailLength - nameWithType.vb: Cat(Of T, K).GetTailLength - fullName.vb: CatLibrary.Cat(Of T, K).GetTailLength -- uid: System.Int32* - name: Int32* - nameWithType: Int32* - fullName: System.Int32* - spec.csharp: - - uid: System.Int32 - name: Int32 - nameWithType: Int32 - fullName: System.Int32 - isExternal: true - - name: '*' - nameWithType: '*' - fullName: '*' - spec.vb: - - uid: System.Int32 - name: Int32 - nameWithType: Int32 - fullName: System.Int32 - isExternal: true - - name: '*' - nameWithType: '*' - fullName: '*' -- uid: System.Object[] - name: Object[] - nameWithType: Object[] - fullName: System.Object[] - nameWithType.vb: Object() - fullName.vb: System.Object() - name.vb: Object() - spec.csharp: - - uid: System.Object - name: Object - nameWithType: Object - fullName: System.Object - isExternal: true - - name: '[]' - nameWithType: '[]' - fullName: '[]' - spec.vb: - - uid: System.Object - name: Object - nameWithType: Object - fullName: System.Object - isExternal: true - - name: () - nameWithType: () - fullName: () -- uid: System.Int64 - commentId: T:System.Int64 - parent: System - isExternal: true - name: Int64 - nameWithType: Int64 - fullName: System.Int64 -- uid: CatLibrary.Cat`2.op_Addition* - commentId: Overload:CatLibrary.Cat`2.op_Addition - isExternal: false - name: Addition - nameWithType: Cat.Addition - fullName: CatLibrary.Cat.Addition - nameWithType.vb: Cat(Of T, K).Addition - fullName.vb: CatLibrary.Cat(Of T, K).Addition -- uid: CatLibrary.Cat`2 - commentId: T:CatLibrary.Cat`2 - parent: CatLibrary - isExternal: false - name: Cat - nameWithType: Cat - fullName: CatLibrary.Cat - nameWithType.vb: Cat(Of T, K) - fullName.vb: CatLibrary.Cat(Of T, K) - name.vb: Cat(Of T, K) - spec.csharp: - - uid: CatLibrary.Cat`2 - name: Cat - nameWithType: Cat - fullName: CatLibrary.Cat - - name: < - nameWithType: < - fullName: < - - name: T - nameWithType: T - fullName: T - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - name: K - nameWithType: K - fullName: K - - name: '>' - nameWithType: '>' - fullName: '>' - spec.vb: - - uid: CatLibrary.Cat`2 - name: Cat - nameWithType: Cat - fullName: CatLibrary.Cat - - name: '(Of ' - nameWithType: '(Of ' - fullName: '(Of ' - - name: T - nameWithType: T - fullName: T - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - name: K - nameWithType: K - fullName: K - - name: ) - nameWithType: ) - fullName: ) -- uid: CatLibrary.Cat`2.op_Subtraction* - commentId: Overload:CatLibrary.Cat`2.op_Subtraction - isExternal: false - name: Subtraction - nameWithType: Cat.Subtraction - fullName: CatLibrary.Cat.Subtraction - nameWithType.vb: Cat(Of T, K).Subtraction - fullName.vb: CatLibrary.Cat(Of T, K).Subtraction -- uid: CatLibrary.Cat`2.op_Explicit* - commentId: Overload:CatLibrary.Cat`2.op_Explicit - isExternal: false - name: Explicit - nameWithType: Cat.Explicit - fullName: CatLibrary.Cat.Explicit - nameWithType.vb: Cat(Of T, K).Narrowing - fullName.vb: CatLibrary.Cat(Of T, K).Narrowing - name.vb: Narrowing -- uid: CatLibrary.Tom - commentId: T:CatLibrary.Tom - parent: CatLibrary - isExternal: false - name: Tom - nameWithType: Tom - fullName: CatLibrary.Tom -- uid: CatLibrary.Cat`2.Item* - commentId: Overload:CatLibrary.Cat`2.Item - isExternal: false - name: Item - nameWithType: Cat.Item - fullName: CatLibrary.Cat.Item - nameWithType.vb: Cat(Of T, K).Item - fullName.vb: CatLibrary.Cat(Of T, K).Item -- uid: CatLibrary.Cat`2.Age* - commentId: Overload:CatLibrary.Cat`2.Age - isExternal: false - name: Age - nameWithType: Cat.Age - fullName: CatLibrary.Cat.Age - nameWithType.vb: Cat(Of T, K).Age - fullName.vb: CatLibrary.Cat(Of T, K).Age -- uid: System.EventHandler - commentId: T:System.EventHandler - parent: System - isExternal: true - name: EventHandler - nameWithType: EventHandler - fullName: System.EventHandler -- uid: CatLibrary.Cat`2.CatLibrary#IAnimal#Eat* - commentId: Overload:CatLibrary.Cat`2.CatLibrary#IAnimal#Eat - isExternal: false - name: IAnimal.Eat - nameWithType: Cat.IAnimal.Eat - fullName: CatLibrary.Cat.CatLibrary.IAnimal.Eat - nameWithType.vb: Cat(Of T, K).CatLibrary.IAnimal.Eat - fullName.vb: CatLibrary.Cat(Of T, K).CatLibrary.IAnimal.Eat - name.vb: CatLibrary.IAnimal.Eat -- uid: CatLibrary.IAnimal.Eat - commentId: M:CatLibrary.IAnimal.Eat - parent: CatLibrary.IAnimal - isExternal: false - name: Eat() - nameWithType: IAnimal.Eat() - fullName: CatLibrary.IAnimal.Eat() - spec.csharp: - - uid: CatLibrary.IAnimal.Eat - name: Eat - nameWithType: IAnimal.Eat - fullName: CatLibrary.IAnimal.Eat - - name: ( - nameWithType: ( - fullName: ( - - name: ) - nameWithType: ) - fullName: ) - spec.vb: - - uid: CatLibrary.IAnimal.Eat - name: Eat - nameWithType: IAnimal.Eat - fullName: CatLibrary.IAnimal.Eat - - name: ( - nameWithType: ( - fullName: ( - - name: ) - nameWithType: ) - fullName: ) -- uid: CatLibrary.IAnimal.Eat``1({Tool}) - commentId: M:CatLibrary.IAnimal.Eat``1(``0) - parent: CatLibrary.IAnimal - definition: CatLibrary.IAnimal.Eat``1(``0) - name: Eat(Tool) - nameWithType: IAnimal.Eat(Tool) - fullName: CatLibrary.IAnimal.Eat(Tool) - nameWithType.vb: IAnimal.Eat(Of Tool)(Tool) - fullName.vb: CatLibrary.IAnimal.Eat(Of Tool)(Tool) - name.vb: Eat(Of Tool)(Tool) - spec.csharp: - - uid: CatLibrary.IAnimal.Eat``1(``0) - name: Eat - nameWithType: IAnimal.Eat - fullName: CatLibrary.IAnimal.Eat - - name: ( - nameWithType: ( - fullName: ( - - name: Tool - nameWithType: Tool - fullName: Tool - - name: ) - nameWithType: ) - fullName: ) - spec.vb: - - uid: CatLibrary.IAnimal.Eat``1(``0) - name: Eat(Of Tool) - nameWithType: IAnimal.Eat(Of Tool) - fullName: CatLibrary.IAnimal.Eat(Of Tool) - - name: ( - nameWithType: ( - fullName: ( - - name: Tool - nameWithType: Tool - fullName: Tool - - name: ) - nameWithType: ) - fullName: ) -- uid: '{Tool}' - commentId: '!:Tool' - definition: Tool - name: Tool - nameWithType: Tool - fullName: Tool -- uid: CatLibrary.IAnimal.Eat``1(``0) - commentId: M:CatLibrary.IAnimal.Eat``1(``0) - isExternal: false - name: Eat(Tool) - nameWithType: IAnimal.Eat(Tool) - fullName: CatLibrary.IAnimal.Eat(Tool) - nameWithType.vb: IAnimal.Eat(Of Tool)(Tool) - fullName.vb: CatLibrary.IAnimal.Eat(Of Tool)(Tool) - name.vb: Eat(Of Tool)(Tool) - spec.csharp: - - uid: CatLibrary.IAnimal.Eat``1(``0) - name: Eat - nameWithType: IAnimal.Eat - fullName: CatLibrary.IAnimal.Eat - - name: ( - nameWithType: ( - fullName: ( - - name: Tool - nameWithType: Tool - fullName: Tool - - name: ) - nameWithType: ) - fullName: ) - spec.vb: - - uid: CatLibrary.IAnimal.Eat``1(``0) - name: Eat(Of Tool) - nameWithType: IAnimal.Eat(Of Tool) - fullName: CatLibrary.IAnimal.Eat(Of Tool) - - name: ( - nameWithType: ( - fullName: ( - - name: Tool - nameWithType: Tool - fullName: Tool - - name: ) - nameWithType: ) - fullName: ) -- uid: Tool - isExternal: false - name: Tool - nameWithType: Tool - fullName: Tool -- uid: CatLibrary.IAnimal.Eat(System.String) - commentId: M:CatLibrary.IAnimal.Eat(System.String) - parent: CatLibrary.IAnimal - isExternal: true - name: Eat(String) - nameWithType: IAnimal.Eat(String) - fullName: CatLibrary.IAnimal.Eat(System.String) - spec.csharp: - - uid: CatLibrary.IAnimal.Eat(System.String) - name: Eat - nameWithType: IAnimal.Eat - fullName: CatLibrary.IAnimal.Eat - - name: ( - nameWithType: ( - fullName: ( - - uid: System.String - name: String - nameWithType: String - fullName: System.String - isExternal: true - - name: ) - nameWithType: ) - fullName: ) - spec.vb: - - uid: CatLibrary.IAnimal.Eat(System.String) - name: Eat - nameWithType: IAnimal.Eat - fullName: CatLibrary.IAnimal.Eat - - name: ( - nameWithType: ( - fullName: ( - - uid: System.String - name: String - nameWithType: String - fullName: System.String - isExternal: true - - name: ) - nameWithType: ) - fullName: ) -- uid: CatLibrary.Cat`2.Name* - commentId: Overload:CatLibrary.Cat`2.Name - isExternal: false - name: Name - nameWithType: Cat.Name - fullName: CatLibrary.Cat.Name - nameWithType.vb: Cat(Of T, K).Name - fullName.vb: CatLibrary.Cat(Of T, K).Name -- uid: CatLibrary.IAnimal.Name - commentId: P:CatLibrary.IAnimal.Name - parent: CatLibrary.IAnimal - isExternal: false - name: Name - nameWithType: IAnimal.Name - fullName: CatLibrary.IAnimal.Name -- uid: CatLibrary.Cat`2.CatLibrary#IAnimal#Item* - commentId: Overload:CatLibrary.Cat`2.CatLibrary#IAnimal#Item - isExternal: false - name: IAnimal.Item - nameWithType: Cat.IAnimal.Item - fullName: CatLibrary.Cat.CatLibrary.IAnimal.Item - nameWithType.vb: Cat(Of T, K).CatLibrary.IAnimal.Item - fullName.vb: CatLibrary.Cat(Of T, K).CatLibrary.IAnimal.Item - name.vb: CatLibrary.IAnimal.Item -- uid: CatLibrary.IAnimal.Item(System.Int32) - commentId: P:CatLibrary.IAnimal.Item(System.Int32) - parent: CatLibrary.IAnimal - isExternal: true - name: Item[Int32] - nameWithType: IAnimal.Item[Int32] - fullName: CatLibrary.IAnimal.Item[System.Int32] - nameWithType.vb: IAnimal.Item(Int32) - fullName.vb: CatLibrary.IAnimal.Item(System.Int32) - name.vb: Item(Int32) - spec.csharp: - - uid: CatLibrary.IAnimal.Item(System.Int32) - name: Item - nameWithType: IAnimal.Item - fullName: CatLibrary.IAnimal.Item - - name: '[' - nameWithType: '[' - fullName: '[' - - uid: System.Int32 - name: Int32 - nameWithType: Int32 - fullName: System.Int32 - isExternal: true - - name: ']' - nameWithType: ']' - fullName: ']' - spec.vb: - - uid: CatLibrary.IAnimal.Item(System.Int32) - name: Item - nameWithType: IAnimal.Item - fullName: CatLibrary.IAnimal.Item - - name: ( - nameWithType: ( - fullName: ( - - uid: System.Int32 - name: Int32 - nameWithType: Int32 - fullName: System.Int32 - isExternal: true - - name: ) - nameWithType: ) - fullName: ) -- uid: CatLibrary.ICat.eat - commentId: E:CatLibrary.ICat.eat - parent: CatLibrary.ICat - isExternal: false - name: eat - nameWithType: ICat.eat - fullName: CatLibrary.ICat.eat diff --git a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/Microsoft.DocAsCode.Build.SchemaDriven.MergeType.yml b/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/Microsoft.DocAsCode.Build.SchemaDriven.MergeType.yml deleted file mode 100644 index 77a79359265..00000000000 --- a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/Microsoft.DocAsCode.Build.SchemaDriven.MergeType.yml +++ /dev/null @@ -1,290 +0,0 @@ -### YamlMime:ManagedReference -items: -- uid: Microsoft.DocAsCode.Build.SchemaDriven.MergeType - commentId: T:Microsoft.DocAsCode.Build.SchemaDriven.MergeType - id: MergeType - parent: Microsoft.DocAsCode.Build.SchemaDriven - children: - - Microsoft.DocAsCode.Build.SchemaDriven.MergeType.Ignore - - Microsoft.DocAsCode.Build.SchemaDriven.MergeType.Key - - Microsoft.DocAsCode.Build.SchemaDriven.MergeType.Merge - - Microsoft.DocAsCode.Build.SchemaDriven.MergeType.Replace - langs: - - csharp - - vb - name: MergeType - nameWithType: MergeType - fullName: Microsoft.DocAsCode.Build.SchemaDriven.MergeType - type: Enum - source: - remote: - path: src/Microsoft.DocAsCode.Build.SchemaDriven/Models/MergeType.cs - branch: dev - repo: https://github.com/dotnet/docfx.git - id: MergeType - path: ../src/Microsoft.DocAsCode.Build.SchemaDriven/Models/MergeType.cs - startLine: 5 - assemblies: - - Microsoft.DocAsCode.Build.SchemaDriven - namespace: Microsoft.DocAsCode.Build.SchemaDriven - syntax: - content: public enum MergeType - content.vb: Public Enum MergeType - extensionMethods: - - System.Object.Microsoft.DocAsCode.Common.JsonUtility.ToJsonString(Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializer) -- uid: Microsoft.DocAsCode.Build.SchemaDriven.MergeType.Merge - commentId: F:Microsoft.DocAsCode.Build.SchemaDriven.MergeType.Merge - id: Merge - parent: Microsoft.DocAsCode.Build.SchemaDriven.MergeType - langs: - - csharp - - vb - name: Merge - nameWithType: MergeType.Merge - fullName: Microsoft.DocAsCode.Build.SchemaDriven.MergeType.Merge - type: Field - source: - remote: - path: src/Microsoft.DocAsCode.Build.SchemaDriven/Models/MergeType.cs - branch: dev - repo: https://github.com/dotnet/docfx.git - id: Merge - path: ../src/Microsoft.DocAsCode.Build.SchemaDriven/Models/MergeType.cs - startLine: 7 - assemblies: - - Microsoft.DocAsCode.Build.SchemaDriven - namespace: Microsoft.DocAsCode.Build.SchemaDriven - syntax: - content: Merge = 0 - return: - type: Microsoft.DocAsCode.Build.SchemaDriven.MergeType -- uid: Microsoft.DocAsCode.Build.SchemaDriven.MergeType.Key - commentId: F:Microsoft.DocAsCode.Build.SchemaDriven.MergeType.Key - id: Key - parent: Microsoft.DocAsCode.Build.SchemaDriven.MergeType - langs: - - csharp - - vb - name: Key - nameWithType: MergeType.Key - fullName: Microsoft.DocAsCode.Build.SchemaDriven.MergeType.Key - type: Field - source: - remote: - path: src/Microsoft.DocAsCode.Build.SchemaDriven/Models/MergeType.cs - branch: dev - repo: https://github.com/dotnet/docfx.git - id: Key - path: ../src/Microsoft.DocAsCode.Build.SchemaDriven/Models/MergeType.cs - startLine: 8 - assemblies: - - Microsoft.DocAsCode.Build.SchemaDriven - namespace: Microsoft.DocAsCode.Build.SchemaDriven - syntax: - content: Key = 1 - return: - type: Microsoft.DocAsCode.Build.SchemaDriven.MergeType -- uid: Microsoft.DocAsCode.Build.SchemaDriven.MergeType.Replace - commentId: F:Microsoft.DocAsCode.Build.SchemaDriven.MergeType.Replace - id: Replace - parent: Microsoft.DocAsCode.Build.SchemaDriven.MergeType - langs: - - csharp - - vb - name: Replace - nameWithType: MergeType.Replace - fullName: Microsoft.DocAsCode.Build.SchemaDriven.MergeType.Replace - type: Field - source: - remote: - path: src/Microsoft.DocAsCode.Build.SchemaDriven/Models/MergeType.cs - branch: dev - repo: https://github.com/dotnet/docfx.git - id: Replace - path: ../src/Microsoft.DocAsCode.Build.SchemaDriven/Models/MergeType.cs - startLine: 9 - assemblies: - - Microsoft.DocAsCode.Build.SchemaDriven - namespace: Microsoft.DocAsCode.Build.SchemaDriven - syntax: - content: Replace = 2 - return: - type: Microsoft.DocAsCode.Build.SchemaDriven.MergeType -- uid: Microsoft.DocAsCode.Build.SchemaDriven.MergeType.Ignore - commentId: F:Microsoft.DocAsCode.Build.SchemaDriven.MergeType.Ignore - id: Ignore - parent: Microsoft.DocAsCode.Build.SchemaDriven.MergeType - langs: - - csharp - - vb - name: Ignore - nameWithType: MergeType.Ignore - fullName: Microsoft.DocAsCode.Build.SchemaDriven.MergeType.Ignore - type: Field - source: - remote: - path: src/Microsoft.DocAsCode.Build.SchemaDriven/Models/MergeType.cs - branch: dev - repo: https://github.com/dotnet/docfx.git - id: Ignore - path: ../src/Microsoft.DocAsCode.Build.SchemaDriven/Models/MergeType.cs - startLine: 10 - assemblies: - - Microsoft.DocAsCode.Build.SchemaDriven - namespace: Microsoft.DocAsCode.Build.SchemaDriven - syntax: - content: Ignore = 3 - return: - type: Microsoft.DocAsCode.Build.SchemaDriven.MergeType -references: -- uid: Microsoft.DocAsCode.Build.SchemaDriven - commentId: N:Microsoft.DocAsCode.Build.SchemaDriven - isExternal: false - name: Microsoft.DocAsCode.Build.SchemaDriven - nameWithType: Microsoft.DocAsCode.Build.SchemaDriven - fullName: Microsoft.DocAsCode.Build.SchemaDriven -- uid: System.Object.Microsoft.DocAsCode.Common.JsonUtility.ToJsonString(Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializer) - commentId: M:Microsoft.DocAsCode.Common.JsonUtility.ToJsonString(System.Object,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializer) - parent: Microsoft.DocAsCode.Common.JsonUtility - definition: Microsoft.DocAsCode.Common.JsonUtility.ToJsonString(System.Object,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializer) - name: ToJsonString(Formatting, JsonSerializer) - nameWithType: JsonUtility.ToJsonString(Formatting, JsonSerializer) - fullName: Microsoft.DocAsCode.Common.JsonUtility.ToJsonString(Newtonsoft.Json.Formatting, Newtonsoft.Json.JsonSerializer) - spec.csharp: - - uid: Microsoft.DocAsCode.Common.JsonUtility.ToJsonString(Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializer) - name: ToJsonString - nameWithType: JsonUtility.ToJsonString - fullName: Microsoft.DocAsCode.Common.JsonUtility.ToJsonString - - name: ( - nameWithType: ( - fullName: ( - - uid: Newtonsoft.Json.Formatting - name: Formatting - nameWithType: Formatting - fullName: Newtonsoft.Json.Formatting - isExternal: true - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - uid: Newtonsoft.Json.JsonSerializer - name: JsonSerializer - nameWithType: JsonSerializer - fullName: Newtonsoft.Json.JsonSerializer - isExternal: true - - name: ) - nameWithType: ) - fullName: ) - spec.vb: - - uid: Microsoft.DocAsCode.Common.JsonUtility.ToJsonString(Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializer) - name: ToJsonString - nameWithType: JsonUtility.ToJsonString - fullName: Microsoft.DocAsCode.Common.JsonUtility.ToJsonString - - name: ( - nameWithType: ( - fullName: ( - - uid: Newtonsoft.Json.Formatting - name: Formatting - nameWithType: Formatting - fullName: Newtonsoft.Json.Formatting - isExternal: true - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - uid: Newtonsoft.Json.JsonSerializer - name: JsonSerializer - nameWithType: JsonSerializer - fullName: Newtonsoft.Json.JsonSerializer - isExternal: true - - name: ) - nameWithType: ) - fullName: ) -- uid: Microsoft.DocAsCode.Common.JsonUtility.ToJsonString(System.Object,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializer) - commentId: M:Microsoft.DocAsCode.Common.JsonUtility.ToJsonString(System.Object,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializer) - isExternal: true - name: ToJsonString(Object, Formatting, JsonSerializer) - nameWithType: JsonUtility.ToJsonString(Object, Formatting, JsonSerializer) - fullName: Microsoft.DocAsCode.Common.JsonUtility.ToJsonString(System.Object, Newtonsoft.Json.Formatting, Newtonsoft.Json.JsonSerializer) - spec.csharp: - - uid: Microsoft.DocAsCode.Common.JsonUtility.ToJsonString(System.Object,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializer) - name: ToJsonString - nameWithType: JsonUtility.ToJsonString - fullName: Microsoft.DocAsCode.Common.JsonUtility.ToJsonString - - name: ( - nameWithType: ( - fullName: ( - - uid: System.Object - name: Object - nameWithType: Object - fullName: System.Object - isExternal: true - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - uid: Newtonsoft.Json.Formatting - name: Formatting - nameWithType: Formatting - fullName: Newtonsoft.Json.Formatting - isExternal: true - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - uid: Newtonsoft.Json.JsonSerializer - name: JsonSerializer - nameWithType: JsonSerializer - fullName: Newtonsoft.Json.JsonSerializer - isExternal: true - - name: ) - nameWithType: ) - fullName: ) - spec.vb: - - uid: Microsoft.DocAsCode.Common.JsonUtility.ToJsonString(System.Object,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializer) - name: ToJsonString - nameWithType: JsonUtility.ToJsonString - fullName: Microsoft.DocAsCode.Common.JsonUtility.ToJsonString - - name: ( - nameWithType: ( - fullName: ( - - uid: System.Object - name: Object - nameWithType: Object - fullName: System.Object - isExternal: true - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - uid: Newtonsoft.Json.Formatting - name: Formatting - nameWithType: Formatting - fullName: Newtonsoft.Json.Formatting - isExternal: true - - name: ', ' - nameWithType: ', ' - fullName: ', ' - - uid: Newtonsoft.Json.JsonSerializer - name: JsonSerializer - nameWithType: JsonSerializer - fullName: Newtonsoft.Json.JsonSerializer - isExternal: true - - name: ) - nameWithType: ) - fullName: ) -- uid: Microsoft.DocAsCode.Common.JsonUtility - commentId: T:Microsoft.DocAsCode.Common.JsonUtility - parent: Microsoft.DocAsCode.Common - isExternal: false - name: JsonUtility - nameWithType: JsonUtility - fullName: Microsoft.DocAsCode.Common.JsonUtility -- uid: Microsoft.DocAsCode.Common - commentId: N:Microsoft.DocAsCode.Common - isExternal: false - name: Microsoft.DocAsCode.Common - nameWithType: Microsoft.DocAsCode.Common - fullName: Microsoft.DocAsCode.Common -- uid: Microsoft.DocAsCode.Build.SchemaDriven.MergeType - commentId: T:Microsoft.DocAsCode.Build.SchemaDriven.MergeType - parent: Microsoft.DocAsCode.Build.SchemaDriven - isExternal: false - name: MergeType - nameWithType: MergeType - fullName: Microsoft.DocAsCode.Build.SchemaDriven.MergeType diff --git a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/ModelItemDictionary/toc.yml b/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/ModelItemDictionary/toc.yml deleted file mode 100644 index 5da33fb5dce..00000000000 --- a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/ModelItemDictionary/toc.yml +++ /dev/null @@ -1,3 +0,0 @@ -### YamlMime:ManagedReference -- name: System.Activities.Presentation.Model.ModelItemDictionary - uid: System.Activities.Presentation.Model.ModelItemDictionary \ No newline at end of file diff --git a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/System.Activities.Presentation.Model.ModelItemDictionary.yml b/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/System.Activities.Presentation.Model.ModelItemDictionary.yml deleted file mode 100644 index b3c1fc5acc9..00000000000 --- a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/System.Activities.Presentation.Model.ModelItemDictionary.yml +++ /dev/null @@ -1,1890 +0,0 @@ -### YamlMime:ManagedReference -items: -- uid: System.Activities.Presentation.Model.ModelItemDictionary - id: ModelItemDictionary - children: - - System.Activities.Presentation.Model.ModelItemDictionary.#ctor - - System.Activities.Presentation.Model.ModelItemDictionary.Add(System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem) - - System.Activities.Presentation.Model.ModelItemDictionary.Add(System.Object,System.Object) - - System.Activities.Presentation.Model.ModelItemDictionary.Clear - - System.Activities.Presentation.Model.ModelItemDictionary.CollectionChanged - - System.Activities.Presentation.Model.ModelItemDictionary.Contains(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}) - - System.Activities.Presentation.Model.ModelItemDictionary.ContainsKey(System.Activities.Presentation.Model.ModelItem) - - System.Activities.Presentation.Model.ModelItemDictionary.ContainsKey(System.Object) - - System.Activities.Presentation.Model.ModelItemDictionary.CopyTo(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}[],System.Int32) - - System.Activities.Presentation.Model.ModelItemDictionary.Count - - System.Activities.Presentation.Model.ModelItemDictionary.GetEnumerator - - System.Activities.Presentation.Model.ModelItemDictionary.IsFixedSize - - System.Activities.Presentation.Model.ModelItemDictionary.IsReadOnly - - System.Activities.Presentation.Model.ModelItemDictionary.IsSynchronized - - System.Activities.Presentation.Model.ModelItemDictionary.Item(System.Activities.Presentation.Model.ModelItem) - - System.Activities.Presentation.Model.ModelItemDictionary.Item(System.Object) - - System.Activities.Presentation.Model.ModelItemDictionary.KeyProperty - - System.Activities.Presentation.Model.ModelItemDictionary.Keys - - System.Activities.Presentation.Model.ModelItemDictionary.Remove(System.Activities.Presentation.Model.ModelItem) - - System.Activities.Presentation.Model.ModelItemDictionary.Remove(System.Object) - - System.Activities.Presentation.Model.ModelItemDictionary.SyncRoot - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#Activities#Presentation#Model#ModelItem,System#Activities#Presentation#Model#ModelItem}}#Add(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}) - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#Activities#Presentation#Model#ModelItem,System#Activities#Presentation#Model#ModelItem}}#Contains(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}) - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#Activities#Presentation#Model#ModelItem,System#Activities#Presentation#Model#ModelItem}}#CopyTo(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}[],System.Int32) - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#Activities#Presentation#Model#ModelItem,System#Activities#Presentation#Model#ModelItem}}#Remove(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}) - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32) - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#Count - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#IsSynchronized - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#SyncRoot - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Add(System.Object,System.Object) - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Clear - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Contains(System.Object) - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#GetEnumerator - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#IsFixedSize - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#IsReadOnly - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Item(System.Object) - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Keys - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Remove(System.Object) - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Values - - System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IEnumerable#GetEnumerator - - System.Activities.Presentation.Model.ModelItemDictionary.TryGetValue(System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem@) - - System.Activities.Presentation.Model.ModelItemDictionary.TryGetValue(System.Object,System.Activities.Presentation.Model.ModelItem@) - - System.Activities.Presentation.Model.ModelItemDictionary.Values - langs: - - csharp - name: ModelItemDictionary - nameWithType: ModelItemDictionary - fullName: System.Activities.Presentation.Model.ModelItemDictionary - type: Class - summary: Derives from and implements support for a dictionary of key/value pairs. - syntax: - content: 'public abstract class ModelItemDictionary : System.Activities.Presentation.Model.ModelItem, System.Collections.Generic.ICollection>, System.Collections.Generic.IDictionary, System.Collections.Generic.IEnumerable>, System.Collections.IDictionary, System.Collections.Specialized.INotifyCollectionChanged' - inheritance: - - System.Object - - System.Activities.Presentation.Model.ModelItem - implements: - - System.Collections.Generic.ICollection> - - System.Collections.Generic.IDictionary - - System.Collections.Generic.IEnumerable> - - System.Collections.IDictionary - - System.Collections.Specialized.INotifyCollectionChanged - inheritedMembers: - - System.Activities.Presentation.Model.ModelItem.Attributes - - System.Activities.Presentation.Model.ModelItem.BeginEdit - - System.Activities.Presentation.Model.ModelItem.BeginEdit(System.Boolean) - - System.Activities.Presentation.Model.ModelItem.BeginEdit(System.String) - - System.Activities.Presentation.Model.ModelItem.BeginEdit(System.String,System.Boolean) - - System.Activities.Presentation.Model.ModelItem.Content - - System.Activities.Presentation.Model.ModelItem.GetCurrentValue - - System.Activities.Presentation.Model.ModelItem.ItemType - - System.Activities.Presentation.Model.ModelItem.Name - - System.Activities.Presentation.Model.ModelItem.Parent - - System.Activities.Presentation.Model.ModelItem.Parents - - System.Activities.Presentation.Model.ModelItem.Properties - - System.Activities.Presentation.Model.ModelItem.PropertyChanged - - System.Activities.Presentation.Model.ModelItem.Root - - System.Activities.Presentation.Model.ModelItem.Source - - System.Activities.Presentation.Model.ModelItem.Sources - - System.Activities.Presentation.Model.ModelItem.ToString - - System.Activities.Presentation.Model.ModelItem.View - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.#ctor - id: '#ctor' - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: ModelItemDictionary() - nameWithType: ModelItemDictionary.ModelItemDictionary() - fullName: System.Activities.Presentation.Model.ModelItemDictionary.ModelItemDictionary() - type: Constructor - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Creates a new . - syntax: - content: protected ModelItemDictionary (); - parameters: [] - overload: System.Activities.Presentation.Model.ModelItemDictionary.#ctor* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Add(System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem) - id: Add(System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem) - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: Add(ModelItem,ModelItem) - nameWithType: ModelItemDictionary.Add(ModelItem,ModelItem) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Add(ModelItem,ModelItem) - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Adds the value to the dictionary under the given key. - syntax: - content: public abstract void Add (System.Activities.Presentation.Model.ModelItem key, System.Activities.Presentation.Model.ModelItem value); - parameters: - - id: key - type: System.Activities.Presentation.Model.ModelItem - description: The that represents the key in the key/value pair to be added. - - id: value - type: System.Activities.Presentation.Model.ModelItem - description: The that represents the value in the key/value pair to be added. - overload: System.Activities.Presentation.Model.ModelItemDictionary.Add* - exceptions: - - type: System.InvalidOperationException - commentId: T:System.InvalidOperationException - description: If the is read-only. - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Add(System.Object,System.Object) - id: Add(System.Object,System.Object) - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: Add(Object,Object) - nameWithType: ModelItemDictionary.Add(Object,Object) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Add(Object,Object) - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Adds the value to the dictionary under the given key. This method wraps the key and value in a set of objects. - syntax: - content: public abstract System.Activities.Presentation.Model.ModelItem Add (object key, object value); - parameters: - - id: key - type: System.Object - description: The key in the key/value pair to be added. - - id: value - type: System.Object - description: The value in the key/value pair to be added. - return: - type: System.Activities.Presentation.Model.ModelItem - description: To be added. - overload: System.Activities.Presentation.Model.ModelItemDictionary.Add* - exceptions: - - type: System.ArgumentNullException - commentId: T:System.ArgumentNullException - description: If key or value is . - - type: System.InvalidOperationException - commentId: T:System.InvalidOperationException - description: If the is read-only. - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Clear - id: Clear - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: Clear() - nameWithType: ModelItemDictionary.Clear() - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Clear() - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Clears the contents of the dictionary. - syntax: - content: public abstract void Clear (); - parameters: [] - overload: System.Activities.Presentation.Model.ModelItemDictionary.Clear* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.CollectionChanged - id: CollectionChanged - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: CollectionChanged - nameWithType: ModelItemDictionary.CollectionChanged - fullName: System.Activities.Presentation.Model.ModelItemDictionary.CollectionChanged - type: Event - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Raised when the contents of this collection change. - syntax: - content: public abstract event System.Collections.Specialized.NotifyCollectionChangedEventHandler CollectionChanged; - return: - type: System.Collections.Specialized.NotifyCollectionChangedEventHandler - description: To be added. - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Contains(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}) - id: Contains(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}) - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: Contains(KeyValuePair) - nameWithType: ModelItemDictionary.Contains(KeyValuePair) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Contains(KeyValuePair) - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Determines whether the dictionary contains the given key/value pair. - syntax: - content: protected virtual bool Contains (System.Collections.Generic.KeyValuePair item); - parameters: - - id: item - type: System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem} - description: The key/value pair to find. - return: - type: System.Boolean - description: To be added. - overload: System.Activities.Presentation.Model.ModelItemDictionary.Contains* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.ContainsKey(System.Activities.Presentation.Model.ModelItem) - id: ContainsKey(System.Activities.Presentation.Model.ModelItem) - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: ContainsKey(ModelItem) - nameWithType: ModelItemDictionary.ContainsKey(ModelItem) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.ContainsKey(ModelItem) - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Determines whether the dictionary contains the given key. - syntax: - content: public abstract bool ContainsKey (System.Activities.Presentation.Model.ModelItem key); - parameters: - - id: key - type: System.Activities.Presentation.Model.ModelItem - description: The key to find. - return: - type: System.Boolean - description: To be added. - overload: System.Activities.Presentation.Model.ModelItemDictionary.ContainsKey* - exceptions: - - type: System.ArgumentNullException - commentId: T:System.ArgumentNullException - description: If key is . - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.ContainsKey(System.Object) - id: ContainsKey(System.Object) - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: ContainsKey(Object) - nameWithType: ModelItemDictionary.ContainsKey(Object) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.ContainsKey(Object) - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Determines whether the dictionary contains the given key. - syntax: - content: public abstract bool ContainsKey (object key); - parameters: - - id: key - type: System.Object - description: The key to find. - return: - type: System.Boolean - description: To be added. - overload: System.Activities.Presentation.Model.ModelItemDictionary.ContainsKey* - exceptions: - - type: System.ArgumentNullException - commentId: T:System.ArgumentNullException - description: If key is . - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.CopyTo(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}[],System.Int32) - id: CopyTo(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}[],System.Int32) - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: CopyTo(KeyValuePair,Int32) - nameWithType: ModelItemDictionary.CopyTo(KeyValuePair,Int32) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.CopyTo(KeyValuePair,Int32) - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Copies an array of key/value pairs into the given dictionary. - syntax: - content: protected virtual void CopyTo (System.Collections.Generic.KeyValuePair[] array, int arrayIndex); - parameters: - - id: array - type: System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}[] - description: The array of key/value pairs to copy. - - id: arrayIndex - type: System.Int32 - description: The zero-based index in the current dictionary at which copying begins. - overload: System.Activities.Presentation.Model.ModelItemDictionary.CopyTo* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Count - id: Count - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: Count - nameWithType: ModelItemDictionary.Count - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Count - type: Property - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Returns the count of items in the dictionary. - syntax: - content: public abstract int Count { get; } - return: - type: System.Int32 - description: Returns <xref:System.Int32>. - overload: System.Activities.Presentation.Model.ModelItemDictionary.Count* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.GetEnumerator - id: GetEnumerator - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: GetEnumerator() - nameWithType: ModelItemDictionary.GetEnumerator() - fullName: System.Activities.Presentation.Model.ModelItemDictionary.GetEnumerator() - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Returns an enumerator for the items in the dictionary. - syntax: - content: public abstract System.Collections.Generic.IEnumerator> GetEnumerator (); - parameters: [] - return: - type: System.Collections.Generic.IEnumerator{System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}} - description: To be added. - overload: System.Activities.Presentation.Model.ModelItemDictionary.GetEnumerator* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.IsFixedSize - id: IsFixedSize - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: IsFixedSize - nameWithType: ModelItemDictionary.IsFixedSize - fullName: System.Activities.Presentation.Model.ModelItemDictionary.IsFixedSize - type: Property - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Determines whether the dictionary is a fixed size. - syntax: - content: protected virtual bool IsFixedSize { get; } - return: - type: System.Boolean - description: if the dictionary is a fixed size; otherwise, . The default implementation returns if the dictionary is read-only. - overload: System.Activities.Presentation.Model.ModelItemDictionary.IsFixedSize* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.IsReadOnly - id: IsReadOnly - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: IsReadOnly - nameWithType: ModelItemDictionary.IsReadOnly - fullName: System.Activities.Presentation.Model.ModelItemDictionary.IsReadOnly - type: Property - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Determines whether the dictionary cannot be modified. - syntax: - content: public abstract bool IsReadOnly { get; } - return: - type: System.Boolean - description: if the dictionary cannot be modified; otherwise, . - overload: System.Activities.Presentation.Model.ModelItemDictionary.IsReadOnly* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.IsSynchronized - id: IsSynchronized - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: IsSynchronized - nameWithType: ModelItemDictionary.IsSynchronized - fullName: System.Activities.Presentation.Model.ModelItemDictionary.IsSynchronized - type: Property - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Gets a value that indicates whether access to the dictionary is synchronized (thread safe). - syntax: - content: protected virtual bool IsSynchronized { get; } - return: - type: System.Boolean - description: if access to the dictionary is synchronized (thread safe); otherwise, . The default implementation returns . - overload: System.Activities.Presentation.Model.ModelItemDictionary.IsSynchronized* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Item(System.Activities.Presentation.Model.ModelItem) - id: Item(System.Activities.Presentation.Model.ModelItem) - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: Item(ModelItem) - nameWithType: ModelItemDictionary.Item(ModelItem) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Item(ModelItem) - type: Property - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Gets or sets the item at the specified key. - remarks: If there is no item for the given key, this method returns `null`. - syntax: - content: public abstract System.Activities.Presentation.Model.ModelItem this[System.Activities.Presentation.Model.ModelItem key] { get; set; } - parameters: - - id: key - type: System.Activities.Presentation.Model.ModelItem - description: The specified key of the item. - return: - type: System.Activities.Presentation.Model.ModelItem - description: Returns . - overload: System.Activities.Presentation.Model.ModelItemDictionary.Item* - exceptions: - - type: System.ArgumentNullException - commentId: T:System.ArgumentNullException - description: If key or the value is . - - type: System.InvalidOperationException - commentId: T:System.InvalidOperationException - description: If the dictionary is read-only and you set a new value. - - type: System.Collections.Generic.KeyNotFoundException - commentId: T:System.Collections.Generic.KeyNotFoundException - description: If key is not in the dictionary. - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Item(System.Object) - id: Item(System.Object) - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: Item(Object) - nameWithType: ModelItemDictionary.Item(Object) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Item(Object) - type: Property - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Gets or sets the item at the specified key. - remarks: If there is no item for the given key, this method returns `null`. - syntax: - content: public abstract System.Activities.Presentation.Model.ModelItem this[object key] { get; set; } - parameters: - - id: key - type: System.Object - description: The specified key of the item. - return: - type: System.Activities.Presentation.Model.ModelItem - description: Returns . - overload: System.Activities.Presentation.Model.ModelItemDictionary.Item* - exceptions: - - type: System.ArgumentNullException - commentId: T:System.ArgumentNullException - description: If key or the value is . - - type: System.InvalidOperationException - commentId: T:System.InvalidOperationException - description: If the dictionary is read-only and you set a new value. - - type: System.Collections.Generic.KeyNotFoundException - commentId: T:System.Collections.Generic.KeyNotFoundException - description: If key is not in the dictionary. - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.KeyProperty - id: KeyProperty - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: KeyProperty - nameWithType: ModelItemDictionary.KeyProperty - fullName: System.Activities.Presentation.Model.ModelItemDictionary.KeyProperty - type: Field - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: The that represents the key in the key/value pair that is added to all items in the dictionary. The data type of the is . - syntax: - content: public static readonly System.Windows.DependencyProperty KeyProperty; - return: - type: System.Windows.DependencyProperty - description: To be added. - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Keys - id: Keys - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: Keys - nameWithType: ModelItemDictionary.Keys - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Keys - type: Property - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Gets the keys of the collection. The keys are guaranteed to be in the same order as the values. The resulting collection is read-only. - syntax: - content: public abstract System.Collections.Generic.ICollection Keys { get; } - return: - type: System.Collections.Generic.ICollection{System.Activities.Presentation.Model.ModelItem} - description: Returns <xref:System.Collections.Generic.ICollection%601>. - overload: System.Activities.Presentation.Model.ModelItemDictionary.Keys* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Remove(System.Activities.Presentation.Model.ModelItem) - id: Remove(System.Activities.Presentation.Model.ModelItem) - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: Remove(ModelItem) - nameWithType: ModelItemDictionary.Remove(ModelItem) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Remove(ModelItem) - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Removes the item with the specified key from the dictionary. - remarks: This method does nothing if the item does not exist in the collection. - syntax: - content: public abstract bool Remove (System.Activities.Presentation.Model.ModelItem key); - parameters: - - id: key - type: System.Activities.Presentation.Model.ModelItem - description: The key of the element to remove. - return: - type: System.Boolean - description: To be added. - overload: System.Activities.Presentation.Model.ModelItemDictionary.Remove* - exceptions: - - type: System.ArgumentNullException - commentId: T:System.ArgumentNullException - description: If the key is . - - type: System.InvalidOperationException - commentId: T:System.InvalidOperationException - description: If the dictionary is read-only. - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Remove(System.Object) - id: Remove(System.Object) - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: Remove(Object) - nameWithType: ModelItemDictionary.Remove(Object) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Remove(Object) - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Removes the item from the dictionary. - remarks: This method does nothing if the item does not exist in the collection. - syntax: - content: public abstract bool Remove (object key); - parameters: - - id: key - type: System.Object - description: The item to remove using the key as the search criterion. - return: - type: System.Boolean - description: To be added. - overload: System.Activities.Presentation.Model.ModelItemDictionary.Remove* - exceptions: - - type: System.ArgumentNullException - commentId: T:System.ArgumentNullException - description: If the key is . - - type: System.InvalidOperationException - commentId: T:System.InvalidOperationException - description: If the dictionary is read-only. - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.SyncRoot - id: SyncRoot - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: SyncRoot - nameWithType: ModelItemDictionary.SyncRoot - fullName: System.Activities.Presentation.Model.ModelItemDictionary.SyncRoot - type: Property - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Gets an object that can be used to synchronize access to this collection. - remarks: The default implementation returns “this.? - syntax: - content: protected virtual object SyncRoot { get; } - return: - type: System.Object - description: Returns <xref:System.Object>. - overload: System.Activities.Presentation.Model.ModelItemDictionary.SyncRoot* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#Activities#Presentation#Model#ModelItem,System#Activities#Presentation#Model#ModelItem}}#Add(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}) - id: System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#Activities#Presentation#Model#ModelItem,System#Activities#Presentation#Model#ModelItem}}#Add(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}) - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.Generic.ICollection(KeyValuePair) - nameWithType: ModelItemDictionary.System.Collections.Generic.ICollection(KeyValuePair) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.Generic.ICollection(KeyValuePair) - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - syntax: - content: void ICollection>.Add (System.Collections.Generic.KeyValuePair item); - parameters: - - id: item - type: System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem} - description: To be added. - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection>#Add* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#Activities#Presentation#Model#ModelItem,System#Activities#Presentation#Model#ModelItem}}#Contains(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}) - id: System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#Activities#Presentation#Model#ModelItem,System#Activities#Presentation#Model#ModelItem}}#Contains(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}) - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.Generic.ICollection(KeyValuePair) - nameWithType: ModelItemDictionary.System.Collections.Generic.ICollection(KeyValuePair) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.Generic.ICollection(KeyValuePair) - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - syntax: - content: bool ICollection>.Contains (System.Collections.Generic.KeyValuePair item); - parameters: - - id: item - type: System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem} - description: To be added. - return: - type: System.Boolean - description: To be added. - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection>#Contains* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#Activities#Presentation#Model#ModelItem,System#Activities#Presentation#Model#ModelItem}}#CopyTo(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}[],System.Int32) - id: System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#Activities#Presentation#Model#ModelItem,System#Activities#Presentation#Model#ModelItem}}#CopyTo(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}[],System.Int32) - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.Generic.ICollection(KeyValuePair,Int32) - nameWithType: ModelItemDictionary.System.Collections.Generic.ICollection(KeyValuePair,Int32) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.Generic.ICollection(KeyValuePair,Int32) - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - syntax: - content: void ICollection>.CopyTo (System.Collections.Generic.KeyValuePair[] array, int arrayIndex); - parameters: - - id: array - type: System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}[] - description: To be added. - - id: arrayIndex - type: System.Int32 - description: To be added. - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection>#CopyTo* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#Activities#Presentation#Model#ModelItem,System#Activities#Presentation#Model#ModelItem}}#Remove(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}) - id: System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#Activities#Presentation#Model#ModelItem,System#Activities#Presentation#Model#ModelItem}}#Remove(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}) - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.Generic.ICollection(KeyValuePair) - nameWithType: ModelItemDictionary.System.Collections.Generic.ICollection(KeyValuePair) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.Generic.ICollection(KeyValuePair) - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - syntax: - content: bool ICollection>.Remove (System.Collections.Generic.KeyValuePair item); - parameters: - - id: item - type: System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem} - description: To be added. - return: - type: System.Boolean - description: To be added. - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection>#Remove* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32) - id: System#Collections#ICollection#CopyTo(System.Array,System.Int32) - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.ICollection.CopyTo(Array,Int32) - nameWithType: ModelItemDictionary.System.Collections.ICollection.CopyTo(Array,Int32) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.ICollection.CopyTo(Array,Int32) - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Copies the elements of the <xref:System.Collections.ICollection> to an array, starting at a particular array index. - syntax: - content: void ICollection.CopyTo (Array array, int index); - parameters: - - id: array - type: System.Array - description: The one-dimensional array that is the destination of the elements copied from . The array must have zero-based indexing - - id: index - type: System.Int32 - description: The zero-based index in `array` at which copying begins. - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#CopyTo* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#Count - id: System#Collections#ICollection#Count - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.ICollection.Count - nameWithType: ModelItemDictionary.System.Collections.ICollection.Count - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.ICollection.Count - type: Property - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Gets the number of elements contained in the <xref:System.Collections.ICollection>. - syntax: - content: int System.Collections.ICollection.Count { get; } - return: - type: System.Int32 - description: The number of elements contained in the <xref:System.Collections.ICollection>. - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#Count* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#IsSynchronized - id: System#Collections#ICollection#IsSynchronized - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.ICollection.IsSynchronized - nameWithType: ModelItemDictionary.System.Collections.ICollection.IsSynchronized - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.ICollection.IsSynchronized - type: Property - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Gets a value that indicates whether access to the <xref:System.Collections.ICollection> is synchronized (thread safe). - syntax: - content: bool System.Collections.ICollection.IsSynchronized { get; } - return: - type: System.Boolean - description: if access to the <xref:System.Collections.ICollection> is synchronized (thread safe); otherwise, . - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#IsSynchronized* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#SyncRoot - id: System#Collections#ICollection#SyncRoot - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.ICollection.SyncRoot - nameWithType: ModelItemDictionary.System.Collections.ICollection.SyncRoot - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.ICollection.SyncRoot - type: Property - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Gets an object that can be used to synchronize access to the <xref:System.Collections.ICollection>. - syntax: - content: object System.Collections.ICollection.SyncRoot { get; } - return: - type: System.Object - description: An object that can be used to synchronize access to the <xref:System.Collections.ICollection>. - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#SyncRoot* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Add(System.Object,System.Object) - id: System#Collections#IDictionary#Add(System.Object,System.Object) - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.IDictionary.Add(Object,Object) - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Add(Object,Object) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.Add(Object,Object) - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Adds an element with the provided key and value to the <xref:System.Collections.IDictionary> object. - syntax: - content: void IDictionary.Add (object key, object value); - parameters: - - id: key - type: System.Object - description: The object to use as the key of the element to add. - - id: value - type: System.Object - description: The object to use as the value of the element to add. - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Add* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Clear - id: System#Collections#IDictionary#Clear - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.IDictionary.Clear() - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Clear() - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.Clear() - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Removes all elements from the <xref:System.Collections.IDictionary> object. - syntax: - content: void IDictionary.Clear (); - parameters: [] - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Clear* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Contains(System.Object) - id: System#Collections#IDictionary#Contains(System.Object) - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.IDictionary.Contains(Object) - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Contains(Object) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.Contains(Object) - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Determines whether the <xref:System.Collections.IDictionary> object contains an element with the specified key. - syntax: - content: bool IDictionary.Contains (object key); - parameters: - - id: key - type: System.Object - description: The key to locate in the object. - return: - type: System.Boolean - description: To be added. - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Contains* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#GetEnumerator - id: System#Collections#IDictionary#GetEnumerator - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.IDictionary.GetEnumerator() - nameWithType: ModelItemDictionary.System.Collections.IDictionary.GetEnumerator() - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.GetEnumerator() - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Returns the <xref:System.Collections.IDictionaryEnumerator> object for the <xref:System.Collections.IDictionary> object. - syntax: - content: System.Collections.IDictionaryEnumerator IDictionary.GetEnumerator (); - parameters: [] - return: - type: System.Collections.IDictionaryEnumerator - description: To be added. - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#GetEnumerator* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#IsFixedSize - id: System#Collections#IDictionary#IsFixedSize - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.IDictionary.IsFixedSize - nameWithType: ModelItemDictionary.System.Collections.IDictionary.IsFixedSize - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.IsFixedSize - type: Property - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Gets a value that indicates whether the <xref:System.Collections.IDictionary> object has a fixed size. - syntax: - content: bool System.Collections.IDictionary.IsFixedSize { get; } - return: - type: System.Boolean - description: if the <xref:System.Collections.IDictionary> object has a fixed size; otherwise, . - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#IsFixedSize* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#IsReadOnly - id: System#Collections#IDictionary#IsReadOnly - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.IDictionary.IsReadOnly - nameWithType: ModelItemDictionary.System.Collections.IDictionary.IsReadOnly - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.IsReadOnly - type: Property - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Gets a value that indicates whether the <xref:System.Collections.IDictionary> object is read-only. - syntax: - content: bool System.Collections.IDictionary.IsReadOnly { get; } - return: - type: System.Boolean - description: if the <xref:System.Collections.IDictionary> object is read-only; otherwise, . - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#IsReadOnly* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Item(System.Object) - id: System#Collections#IDictionary#Item(System.Object) - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.IDictionary.Item(Object) - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Item(Object) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.Item(Object) - type: Property - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Gets or sets the element with the specified key. - syntax: - content: object System.Collections.IDictionary.Item[object key] { get; set; } - parameters: - - id: key - type: System.Object - description: The key of the element to get or set. - return: - type: System.Object - description: The element with the specified key. - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Item* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Keys - id: System#Collections#IDictionary#Keys - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.IDictionary.Keys - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Keys - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.Keys - type: Property - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Gets an <xref:System.Collections.ICollection> object that contains the keys of the <xref:System.Collections.IDictionary> object. - syntax: - content: System.Collections.ICollection System.Collections.IDictionary.Keys { get; } - return: - type: System.Collections.ICollection - description: An <xref:System.Collections.ICollection> object that contains the keys of the <xref:System.Collections.IDictionary> object. - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Keys* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Remove(System.Object) - id: System#Collections#IDictionary#Remove(System.Object) - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.IDictionary.Remove(Object) - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Remove(Object) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.Remove(Object) - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Removes the element with the specified key from the <xref:System.Collections.IDictionary>. - remarks: If the object does not contain an element with the specified key, the remains unchanged. No exception is thrown. - syntax: - content: void IDictionary.Remove (object key); - parameters: - - id: key - type: System.Object - description: The key of the element to remove. - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Remove* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Values - id: System#Collections#IDictionary#Values - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.IDictionary.Values - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Values - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.Values - type: Property - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Gets an <xref:System.Collections.ICollection> object that contains the values in the <xref:System.Collections.IDictionary> object. - syntax: - content: System.Collections.ICollection System.Collections.IDictionary.Values { get; } - return: - type: System.Collections.ICollection - description: An <xref:System.Collections.ICollection> object that contains the values in the <xref:System.Collections.IDictionary> object. - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Values* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IEnumerable#GetEnumerator - id: System#Collections#IEnumerable#GetEnumerator - isEii: true - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: System.Collections.IEnumerable.GetEnumerator() - nameWithType: ModelItemDictionary.System.Collections.IEnumerable.GetEnumerator() - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IEnumerable.GetEnumerator() - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Returns an enumerator that iterates through a collection. - syntax: - content: System.Collections.IEnumerator IEnumerable.GetEnumerator (); - parameters: [] - return: - type: System.Collections.IEnumerator - description: To be added. - overload: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IEnumerable#GetEnumerator* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.TryGetValue(System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem@) - id: TryGetValue(System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem@) - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: TryGetValue(ModelItem,ModelItem) - nameWithType: ModelItemDictionary.TryGetValue(ModelItem,ModelItem) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.TryGetValue(ModelItem,ModelItem) - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Retrieves the value for the given key, if possible. - syntax: - content: public abstract bool TryGetValue (System.Activities.Presentation.Model.ModelItem key, out System.Activities.Presentation.Model.ModelItem value); - parameters: - - id: key - type: System.Activities.Presentation.Model.ModelItem - description: The key associated with the value to retrieve. - - id: value - type: System.Activities.Presentation.Model.ModelItem - description: The value associated with the specified key. - return: - type: System.Boolean - description: To be added. - overload: System.Activities.Presentation.Model.ModelItemDictionary.TryGetValue* - exceptions: - - type: System.ArgumentNullException - commentId: T:System.ArgumentNullException - description: If key is . - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.TryGetValue(System.Object,System.Activities.Presentation.Model.ModelItem@) - id: TryGetValue(System.Object,System.Activities.Presentation.Model.ModelItem@) - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: TryGetValue(Object,ModelItem) - nameWithType: ModelItemDictionary.TryGetValue(Object,ModelItem) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.TryGetValue(Object,ModelItem) - type: Method - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Retrieves the value for the given key, if possible. - syntax: - content: public abstract bool TryGetValue (object key, out System.Activities.Presentation.Model.ModelItem value); - parameters: - - id: key - type: System.Object - description: The key associated with the value to retrieve. - - id: value - type: System.Activities.Presentation.Model.ModelItem - description: The value associated with the specified key. - return: - type: System.Boolean - description: To be added. - overload: System.Activities.Presentation.Model.ModelItemDictionary.TryGetValue* - exceptions: - - type: System.ArgumentNullException - commentId: T:System.ArgumentNullException - description: If key is . - platform: - - net-11 - - net-20 - - netcore-10 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Values - id: Values - parent: System.Activities.Presentation.Model.ModelItemDictionary - langs: - - csharp - name: Values - nameWithType: ModelItemDictionary.Values - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Values - type: Property - assemblies: - - System.Activities.Presentation - namespace: System.Activities.Presentation.Model - summary: Gets the values of the collection. - remarks: The values are guaranteed to be in the same order as the keys. The resulting collection is read-only. - syntax: - content: public abstract System.Collections.Generic.ICollection Values { get; } - return: - type: System.Collections.Generic.ICollection{System.Activities.Presentation.Model.ModelItem} - description: Returns <xref:System.Collections.Generic.ICollection%601>. - overload: System.Activities.Presentation.Model.ModelItemDictionary.Values* - exceptions: [] - platform: - - net-11 - - net-20 - - netcore-10 -references: -- uid: System.Activities.Presentation.Model.ModelItem - isExternal: false - name: System.Activities.Presentation.Model.ModelItem -- uid: System.Activities.Presentation.Model.ModelItemDictionary.#ctor - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: ModelItemDictionary() - nameWithType: ModelItemDictionary.ModelItemDictionary() - fullName: System.Activities.Presentation.Model.ModelItemDictionary.ModelItemDictionary() -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Add(System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Add(ModelItem,ModelItem) - nameWithType: ModelItemDictionary.Add(ModelItem,ModelItem) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Add(ModelItem,ModelItem) -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Add(System.Object,System.Object) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Add(Object,Object) - nameWithType: ModelItemDictionary.Add(Object,Object) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Add(Object,Object) -- uid: System.Object - parent: System - isExternal: true - name: Object - nameWithType: Object - fullName: System.Object -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Clear - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Clear() - nameWithType: ModelItemDictionary.Clear() - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Clear() -- uid: System.Activities.Presentation.Model.ModelItemDictionary.CollectionChanged - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: CollectionChanged - nameWithType: ModelItemDictionary.CollectionChanged - fullName: System.Activities.Presentation.Model.ModelItemDictionary.CollectionChanged -- uid: System.Collections.Specialized.NotifyCollectionChangedEventHandler - parent: System.Collections.Specialized - isExternal: true - name: NotifyCollectionChangedEventHandler - nameWithType: NotifyCollectionChangedEventHandler - fullName: System.Collections.Specialized.NotifyCollectionChangedEventHandler -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Contains(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Contains(KeyValuePair) - nameWithType: ModelItemDictionary.Contains(KeyValuePair) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Contains(KeyValuePair) -- uid: System.Boolean - parent: System - isExternal: true - name: Boolean - nameWithType: Boolean - fullName: System.Boolean -- uid: System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem} - parent: System.Collections.Generic - isExternal: true - name: KeyValuePair - nameWithType: KeyValuePair - fullName: System.Collections.Generic.KeyValuePair - spec.csharp: - - uid: System.Collections.Generic.KeyValuePair`2 - name: KeyValuePair - nameWithType: KeyValuePair - fullName: KeyValuePair - - name: < - nameWithType: < - fullName: < - - uid: System.Activities.Presentation.Model.ModelItem - name: ModelItem - nameWithType: ModelItem - fullName: ModelItem - - name: ',' - nameWithType: ',' - fullName: ',' - - uid: System.Activities.Presentation.Model.ModelItem - name: ModelItem - nameWithType: ModelItem - fullName: ModelItem - - name: '>' - nameWithType: '>' - fullName: '>' -- uid: System.Activities.Presentation.Model.ModelItemDictionary.ContainsKey(System.Activities.Presentation.Model.ModelItem) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: ContainsKey(ModelItem) - nameWithType: ModelItemDictionary.ContainsKey(ModelItem) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.ContainsKey(ModelItem) -- uid: System.Activities.Presentation.Model.ModelItemDictionary.ContainsKey(System.Object) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: ContainsKey(Object) - nameWithType: ModelItemDictionary.ContainsKey(Object) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.ContainsKey(Object) -- uid: System.Activities.Presentation.Model.ModelItemDictionary.CopyTo(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}[],System.Int32) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: CopyTo(KeyValuePair,Int32) - nameWithType: ModelItemDictionary.CopyTo(KeyValuePair,Int32) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.CopyTo(KeyValuePair,Int32) -- uid: System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}[] - parent: System.Collections.Generic - isExternal: true - name: KeyValuePair - nameWithType: KeyValuePair - fullName: System.Collections.Generic.KeyValuePair[] - spec.csharp: - - uid: System.Collections.Generic.KeyValuePair`2 - name: KeyValuePair - nameWithType: KeyValuePair - fullName: KeyValuePair[] - - name: < - nameWithType: < - fullName: < - - uid: System.Activities.Presentation.Model.ModelItem - name: ModelItem - nameWithType: ModelItem - fullName: ModelItem - - name: ',' - nameWithType: ',' - fullName: ',' - - uid: System.Activities.Presentation.Model.ModelItem - name: ModelItem - nameWithType: ModelItem - fullName: ModelItem - - name: '>' - nameWithType: '>' - fullName: '>' - - name: '[]' - nameWithType: '[]' - fullName: '[]' -- uid: System.Int32 - parent: System - isExternal: true - name: Int32 - nameWithType: Int32 - fullName: System.Int32 -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Count - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Count - nameWithType: ModelItemDictionary.Count - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Count -- uid: System.Activities.Presentation.Model.ModelItemDictionary.GetEnumerator - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: GetEnumerator() - nameWithType: ModelItemDictionary.GetEnumerator() - fullName: System.Activities.Presentation.Model.ModelItemDictionary.GetEnumerator() -- uid: System.Collections.Generic.IEnumerator{System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}} - parent: System.Collections.Generic - isExternal: true - name: IEnumerator> - nameWithType: IEnumerator> - fullName: System.Collections.Generic.IEnumerator> - spec.csharp: - - uid: System.Collections.Generic.IEnumerator`1 - name: IEnumerator - nameWithType: IEnumerator - fullName: IEnumerator> - - name: < - nameWithType: < - fullName: < - - uid: System.Collections.Generic.KeyValuePair`2 - name: KeyValuePair - nameWithType: KeyValuePair - fullName: KeyValuePair - - name: < - nameWithType: < - fullName: < - - uid: System.Activities.Presentation.Model.ModelItem - name: ModelItem - nameWithType: ModelItem - fullName: ModelItem - - name: ',' - nameWithType: ',' - fullName: ',' - - uid: System.Activities.Presentation.Model.ModelItem - name: ModelItem - nameWithType: ModelItem - fullName: ModelItem - - name: '>' - nameWithType: '>' - fullName: '>' - - name: '>' - nameWithType: '>' - fullName: '>' -- uid: System.Activities.Presentation.Model.ModelItemDictionary.IsFixedSize - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: IsFixedSize - nameWithType: ModelItemDictionary.IsFixedSize - fullName: System.Activities.Presentation.Model.ModelItemDictionary.IsFixedSize -- uid: System.Activities.Presentation.Model.ModelItemDictionary.IsReadOnly - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: IsReadOnly - nameWithType: ModelItemDictionary.IsReadOnly - fullName: System.Activities.Presentation.Model.ModelItemDictionary.IsReadOnly -- uid: System.Activities.Presentation.Model.ModelItemDictionary.IsSynchronized - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: IsSynchronized - nameWithType: ModelItemDictionary.IsSynchronized - fullName: System.Activities.Presentation.Model.ModelItemDictionary.IsSynchronized -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Item(System.Activities.Presentation.Model.ModelItem) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Item(ModelItem) - nameWithType: ModelItemDictionary.Item(ModelItem) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Item(ModelItem) -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Item(System.Object) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Item(Object) - nameWithType: ModelItemDictionary.Item(Object) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Item(Object) -- uid: System.Activities.Presentation.Model.ModelItemDictionary.KeyProperty - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: KeyProperty - nameWithType: ModelItemDictionary.KeyProperty - fullName: System.Activities.Presentation.Model.ModelItemDictionary.KeyProperty -- uid: System.Windows.DependencyProperty - parent: System.Windows - isExternal: false - name: DependencyProperty - nameWithType: DependencyProperty - fullName: System.Windows.DependencyProperty -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Keys - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Keys - nameWithType: ModelItemDictionary.Keys - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Keys -- uid: System.Collections.Generic.ICollection{System.Activities.Presentation.Model.ModelItem} - parent: System.Collections.Generic - isExternal: true - name: ICollection - nameWithType: ICollection - fullName: System.Collections.Generic.ICollection - spec.csharp: - - uid: System.Collections.Generic.ICollection`1 - name: ICollection - nameWithType: ICollection - fullName: ICollection - - name: < - nameWithType: < - fullName: < - - uid: System.Activities.Presentation.Model.ModelItem - name: ModelItem - nameWithType: ModelItem - fullName: ModelItem - - name: '>' - nameWithType: '>' - fullName: '>' -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Remove(System.Activities.Presentation.Model.ModelItem) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Remove(ModelItem) - nameWithType: ModelItemDictionary.Remove(ModelItem) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Remove(ModelItem) -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Remove(System.Object) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Remove(Object) - nameWithType: ModelItemDictionary.Remove(Object) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Remove(Object) -- uid: System.Activities.Presentation.Model.ModelItemDictionary.SyncRoot - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: SyncRoot - nameWithType: ModelItemDictionary.SyncRoot - fullName: System.Activities.Presentation.Model.ModelItemDictionary.SyncRoot -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#Activities#Presentation#Model#ModelItem,System#Activities#Presentation#Model#ModelItem}}#Add(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.Generic.ICollection(KeyValuePair) - nameWithType: ModelItemDictionary.System.Collections.Generic.ICollection(KeyValuePair) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.Generic.ICollection(KeyValuePair) -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#Activities#Presentation#Model#ModelItem,System#Activities#Presentation#Model#ModelItem}}#Contains(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.Generic.ICollection(KeyValuePair) - nameWithType: ModelItemDictionary.System.Collections.Generic.ICollection(KeyValuePair) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.Generic.ICollection(KeyValuePair) -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#Activities#Presentation#Model#ModelItem,System#Activities#Presentation#Model#ModelItem}}#CopyTo(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}[],System.Int32) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.Generic.ICollection(KeyValuePair,Int32) - nameWithType: ModelItemDictionary.System.Collections.Generic.ICollection(KeyValuePair,Int32) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.Generic.ICollection(KeyValuePair,Int32) -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#Activities#Presentation#Model#ModelItem,System#Activities#Presentation#Model#ModelItem}}#Remove(System.Collections.Generic.KeyValuePair{System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem}) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.Generic.ICollection(KeyValuePair) - nameWithType: ModelItemDictionary.System.Collections.Generic.ICollection(KeyValuePair) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.Generic.ICollection(KeyValuePair) -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.ICollection.CopyTo(Array,Int32) - nameWithType: ModelItemDictionary.System.Collections.ICollection.CopyTo(Array,Int32) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.ICollection.CopyTo(Array,Int32) -- uid: System.Array - parent: System - isExternal: true - name: Array - nameWithType: Array - fullName: System.Array -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#Count - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.ICollection.Count - nameWithType: ModelItemDictionary.System.Collections.ICollection.Count - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.ICollection.Count -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#IsSynchronized - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.ICollection.IsSynchronized - nameWithType: ModelItemDictionary.System.Collections.ICollection.IsSynchronized - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.ICollection.IsSynchronized -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#SyncRoot - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.ICollection.SyncRoot - nameWithType: ModelItemDictionary.System.Collections.ICollection.SyncRoot - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.ICollection.SyncRoot -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Add(System.Object,System.Object) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.Add(Object,Object) - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Add(Object,Object) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.Add(Object,Object) -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Clear - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.Clear() - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Clear() - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.Clear() -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Contains(System.Object) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.Contains(Object) - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Contains(Object) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.Contains(Object) -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#GetEnumerator - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.GetEnumerator() - nameWithType: ModelItemDictionary.System.Collections.IDictionary.GetEnumerator() - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.GetEnumerator() -- uid: System.Collections.IDictionaryEnumerator - parent: System.Collections - isExternal: true - name: IDictionaryEnumerator - nameWithType: IDictionaryEnumerator - fullName: System.Collections.IDictionaryEnumerator -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#IsFixedSize - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.IsFixedSize - nameWithType: ModelItemDictionary.System.Collections.IDictionary.IsFixedSize - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.IsFixedSize -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#IsReadOnly - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.IsReadOnly - nameWithType: ModelItemDictionary.System.Collections.IDictionary.IsReadOnly - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.IsReadOnly -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Item(System.Object) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.Item(Object) - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Item(Object) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.Item(Object) -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Keys - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.Keys - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Keys - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.Keys -- uid: System.Collections.ICollection - parent: System.Collections - isExternal: true - name: ICollection - nameWithType: ICollection - fullName: System.Collections.ICollection -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Remove(System.Object) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.Remove(Object) - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Remove(Object) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.Remove(Object) -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Values - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.Values - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Values - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IDictionary.Values -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IEnumerable#GetEnumerator - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IEnumerable.GetEnumerator() - nameWithType: ModelItemDictionary.System.Collections.IEnumerable.GetEnumerator() - fullName: System.Activities.Presentation.Model.ModelItemDictionary.System.Collections.IEnumerable.GetEnumerator() -- uid: System.Collections.IEnumerator - parent: System.Collections - isExternal: true - name: IEnumerator - nameWithType: IEnumerator - fullName: System.Collections.IEnumerator -- uid: System.Activities.Presentation.Model.ModelItemDictionary.TryGetValue(System.Activities.Presentation.Model.ModelItem,System.Activities.Presentation.Model.ModelItem@) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: TryGetValue(ModelItem,ModelItem) - nameWithType: ModelItemDictionary.TryGetValue(ModelItem,ModelItem) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.TryGetValue(ModelItem,ModelItem) -- uid: System.Activities.Presentation.Model.ModelItemDictionary.TryGetValue(System.Object,System.Activities.Presentation.Model.ModelItem@) - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: TryGetValue(Object,ModelItem) - nameWithType: ModelItemDictionary.TryGetValue(Object,ModelItem) - fullName: System.Activities.Presentation.Model.ModelItemDictionary.TryGetValue(Object,ModelItem) -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Values - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Values - nameWithType: ModelItemDictionary.Values - fullName: System.Activities.Presentation.Model.ModelItemDictionary.Values -- uid: System.Activities.Presentation.Model.ModelItemDictionary.#ctor* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: ModelItemDictionary - nameWithType: ModelItemDictionary.ModelItemDictionary -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Add* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Add - nameWithType: ModelItemDictionary.Add -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Clear* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Clear - nameWithType: ModelItemDictionary.Clear -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Contains* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Contains - nameWithType: ModelItemDictionary.Contains -- uid: System.Activities.Presentation.Model.ModelItemDictionary.ContainsKey* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: ContainsKey - nameWithType: ModelItemDictionary.ContainsKey -- uid: System.Activities.Presentation.Model.ModelItemDictionary.CopyTo* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: CopyTo - nameWithType: ModelItemDictionary.CopyTo -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Count* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Count - nameWithType: ModelItemDictionary.Count -- uid: System.Activities.Presentation.Model.ModelItemDictionary.GetEnumerator* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: GetEnumerator - nameWithType: ModelItemDictionary.GetEnumerator -- uid: System.Activities.Presentation.Model.ModelItemDictionary.IsFixedSize* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: IsFixedSize - nameWithType: ModelItemDictionary.IsFixedSize -- uid: System.Activities.Presentation.Model.ModelItemDictionary.IsReadOnly* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: IsReadOnly - nameWithType: ModelItemDictionary.IsReadOnly -- uid: System.Activities.Presentation.Model.ModelItemDictionary.IsSynchronized* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: IsSynchronized - nameWithType: ModelItemDictionary.IsSynchronized -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Item* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Item - nameWithType: ModelItemDictionary.Item -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Keys* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Keys - nameWithType: ModelItemDictionary.Keys -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Remove* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Remove - nameWithType: ModelItemDictionary.Remove -- uid: System.Activities.Presentation.Model.ModelItemDictionary.SyncRoot* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: SyncRoot - nameWithType: ModelItemDictionary.SyncRoot -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection>#Add* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.Generic.ICollection>.Add - nameWithType: ModelItemDictionary.System.Collections.Generic.ICollection>.Add -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection>#Contains* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.Generic.ICollection>.Contains - nameWithType: ModelItemDictionary.System.Collections.Generic.ICollection>.Contains -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection>#CopyTo* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.Generic.ICollection>.CopyTo - nameWithType: ModelItemDictionary.System.Collections.Generic.ICollection>.CopyTo -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#Generic#ICollection>#Remove* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.Generic.ICollection>.Remove - nameWithType: ModelItemDictionary.System.Collections.Generic.ICollection>.Remove -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#CopyTo* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.ICollection.CopyTo - nameWithType: ModelItemDictionary.System.Collections.ICollection.CopyTo -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#Count* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.ICollection.Count - nameWithType: ModelItemDictionary.System.Collections.ICollection.Count -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#IsSynchronized* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.ICollection.IsSynchronized - nameWithType: ModelItemDictionary.System.Collections.ICollection.IsSynchronized -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#ICollection#SyncRoot* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.ICollection.SyncRoot - nameWithType: ModelItemDictionary.System.Collections.ICollection.SyncRoot -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Add* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.Add - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Add -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Clear* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.Clear - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Clear -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Contains* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.Contains - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Contains -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#GetEnumerator* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.GetEnumerator - nameWithType: ModelItemDictionary.System.Collections.IDictionary.GetEnumerator -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#IsFixedSize* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.IsFixedSize - nameWithType: ModelItemDictionary.System.Collections.IDictionary.IsFixedSize -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#IsReadOnly* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.IsReadOnly - nameWithType: ModelItemDictionary.System.Collections.IDictionary.IsReadOnly -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Item* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.Item - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Item -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Keys* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.Keys - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Keys -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Remove* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.Remove - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Remove -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IDictionary#Values* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IDictionary.Values - nameWithType: ModelItemDictionary.System.Collections.IDictionary.Values -- uid: System.Activities.Presentation.Model.ModelItemDictionary.System#Collections#IEnumerable#GetEnumerator* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: System.Collections.IEnumerable.GetEnumerator - nameWithType: ModelItemDictionary.System.Collections.IEnumerable.GetEnumerator -- uid: System.Activities.Presentation.Model.ModelItemDictionary.TryGetValue* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: TryGetValue - nameWithType: ModelItemDictionary.TryGetValue -- uid: System.Activities.Presentation.Model.ModelItemDictionary.Values* - parent: System.Activities.Presentation.Model.ModelItemDictionary - isExternal: false - name: Values - nameWithType: ModelItemDictionary.Values diff --git a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/com.microsoft.azure.management.sql.SqlServer.FirewallRules.yml b/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/com.microsoft.azure.management.sql.SqlServer.FirewallRules.yml deleted file mode 100644 index 68a15bd4b56..00000000000 --- a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/com.microsoft.azure.management.sql.SqlServer.FirewallRules.yml +++ /dev/null @@ -1,68 +0,0 @@ -### YamlMime:ManagedReference -items: -- uid: com.microsoft.azure.management.sql.SqlServer.FirewallRules - id: FirewallRules - parent: com.microsoft.azure.management.sql - children: - - com.microsoft.azure.management.sql.SqlServer.FirewallRules.define(String) - href: com.microsoft.azure.management.sql.SqlServer.FirewallRules.yml - langs: - - java - name: SqlServer.FirewallRules - nameWithType: SqlServer.FirewallRules - fullName: com.microsoft.azure.management.sql.SqlServer.FirewallRules - type: Interface - source: - remote: &o0 - path: azure-mgmt-sql/src/main/java/com/microsoft/azure/management/sql/SqlServer.java - branch: v1.3.0 - repo: https://github.com/Azure/azure-sdk-for-java - path: azure-mgmt-sql/src/main/java/com/microsoft/azure/management/sql/SqlServer.java - startLine: 88 - package: com.microsoft.azure.management.sql - summary:

Entry point to firewall rules from the SQL Server.

- syntax: - content: public interface FirewallRules -- uid: com.microsoft.azure.management.sql.SqlServer.FirewallRules.define(String) - id: define(String) - parent: com.microsoft.azure.management.sql.SqlServer.FirewallRules - href: com.microsoft.azure.management.sql.SqlServer.FirewallRules.yml - langs: - - java - name: define(String firewallRuleName) - nameWithType: SqlServer.FirewallRules.define(String firewallRuleName) - fullName: com.microsoft.azure.management.sql.SqlServer.FirewallRules.define(String firewallRuleName) - overload: com.microsoft.azure.management.sql.SqlServer.FirewallRules.define* - type: Method - source: - remote: *o0 - path: azure-mgmt-sql/src/main/java/com/microsoft/azure/management/sql/SqlServer.java - startLine: 103 - package: com.microsoft.azure.management.sql - summary: >- -

Creates a new firewall rule in SQL Server.

- -

- syntax: - content: public SqlFirewallRule.DefinitionStages.Blank define(String firewallRuleName) - parameters: - - id: firewallRuleName - type: "26831127" - description:

name of the firewall rule to be created

- return: - type: 54d349c4 - description:

Returns a stage to specify arguments of the firewall rule

-references: -- uid: "26831127" - spec.java: - - name: String - fullName: String -- uid: 54d349c4 - spec.java: - - name: SqlFirewallRule.DefinitionStages.Blank - fullName: SqlFirewallRule.DefinitionStages.Blank -- uid: com.microsoft.azure.management.sql.SqlServer.FirewallRules.define* - name: define - nameWithType: SqlServer.FirewallRules.define - fullName: com.microsoft.azure.management.sql.SqlServer.FirewallRules.define - package: com.microsoft.azure.management.sql diff --git a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/com.microsoft.azure.management.sql.SqlServer.yml b/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/com.microsoft.azure.management.sql.SqlServer.yml deleted file mode 100644 index bdcb2e2423d..00000000000 --- a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/com.microsoft.azure.management.sql.SqlServer.yml +++ /dev/null @@ -1,66 +0,0 @@ -### YamlMime:ManagedReference -items: -- uid: com.microsoft.azure.management.sql.SqlServer - id: SqlServer - parent: com.microsoft.azure.management.sql - children: - - com.microsoft.azure.management.sql.SqlServer.firewallRules() - href: com.microsoft.azure.management.sql.SqlServer.yml - langs: - - java - name: SqlServer - nameWithType: SqlServer - fullName: com.microsoft.azure.management.sql.SqlServer - type: Interface - source: - remote: &o0 - path: azure-mgmt-sql/src/main/java/com/microsoft/azure/management/sql/SqlServer.java - branch: master - repo: https://github.com/Azure/azure-libraries-for-java - path: azure-mgmt-sql/src/main/java/com/microsoft/azure/management/sql/SqlServer.java - startLine: 29 - package: com.microsoft.azure.management.sql - summary:

An immutable client-side representation of an Azure SQL Server.

- syntax: - content: public interface SqlServer extends GroupableResource,Refreshable,Updatable,GroupableResource,Refreshable,Updatable -- uid: com.microsoft.azure.management.sql.SqlServer.firewallRules() - id: firewallRules() - parent: com.microsoft.azure.management.sql.SqlServer - href: com.microsoft.azure.management.sql.SqlServer.yml - langs: - - java - name: firewallRules() - nameWithType: SqlServer.firewallRules() - fullName: com.microsoft.azure.management.sql.SqlServer.firewallRules() - overload: com.microsoft.azure.management.sql.SqlServer.firewallRules* - type: Method - source: - remote: *o0 - path: azure-mgmt-sql/src/main/java/com/microsoft/azure/management/sql/SqlServer.java - startLine: 206 - package: com.microsoft.azure.management.sql - syntax: - content: public SqlFirewallRuleOperations.SqlFirewallRuleActionsDefinition firewallRules() - return: - type: 2e74d140 - description:

the entry point to manage SQL Firewall rules for this server

-references: -- uid: 2e74d140 - spec.java: - - name: SqlFirewallRuleOperations.SqlFirewallRuleActionsDefinition - fullName: SqlFirewallRuleOperations.SqlFirewallRuleActionsDefinition -- uid: com.microsoft.azure.management.sql.SqlServer.firewallRules* - name: firewallRules - nameWithType: SqlServer.firewallRules - fullName: com.microsoft.azure.management.sql.SqlServer.firewallRules - package: com.microsoft.azure.management.sql -- uid: com.microsoft.azure.management.sql.SqlServer.FirewallRules - parent: com.microsoft.azure.management.sql - href: com.microsoft.azure.management.sql.SqlServer.FirewallRules.yml - name: SqlServer.FirewallRules - nameWithType: SqlServer.FirewallRules - fullName: com.microsoft.azure.management.sql.SqlServer.FirewallRules - type: Interface - summary:

Entry point to firewall rules from the SQL Server.

- syntax: - content: public interface FirewallRules \ No newline at end of file diff --git a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/com.microsoft.azure.management.sql.yml b/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/com.microsoft.azure.management.sql.yml deleted file mode 100644 index d1ecf8a059b..00000000000 --- a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/com.microsoft.azure.management.sql.yml +++ /dev/null @@ -1,67 +0,0 @@ -### YamlMime:ManagedReference -items: -- uid: com.microsoft.azure.management.sql - id: sql - children: - - com.microsoft.azure.management.sql.SqlServer - - com.microsoft.azure.management.sql.SqlServer.FirewallRules - - com.microsoft.azure.management.sql.SqlServer.firewallRules - href: com.microsoft.azure.management.sql.yml - langs: - - java - name: com.microsoft.azure.management.sql - nameWithType: com.microsoft.azure.management.sql - fullName: com.microsoft.azure.management.sql - type: Namespace - source: - remote: - path: azure-mgmt-sql/src/main/java/com/microsoft/azure/management/sql/AuthenticationType.java - branch: master - repo: https://github.com/Azure/azure-libraries-for-java - path: azure-mgmt-sql/src/main/java/com/microsoft/azure/management/sql/AuthenticationType.java - startLine: 8 - summary:

This package contains the classes for SqlManagementClient. The Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.

- syntax: - content: package com.microsoft.azure.management.sql -- uid: com.microsoft.azure.management.sql.SqlServer.firewallRules - id: firewallRules - parent: com.microsoft.azure.management.sql - href: com.microsoft.azure.management.sql.yml - langs: - - java - name: SqlServer.firewallRules - nameWithType: SqlServer.firewallRules - fullName: com.microsoft.azure.management.sql.SqlServer.firewallRules - type: Interface - source: - remote: &o0 - path: azure-mgmt-sql/src/main/java/com/microsoft/azure/management/sql/AuthenticationType.java - branch: v1.3.0 - repo: https://github.com/Azure/azure-sdk-for-java - path: azure-mgmt-sql/src/main/java/com/microsoft/azure/management/sql/AuthenticationType.java - startLine: 88 - package: com.microsoft.azure.management.sql - summary:

duplicate interface

- syntax: - content: public interface FirewallRules -references: -- uid: com.microsoft.azure.management.sql.SqlServer - parent: com.microsoft.azure.management.sql - href: com.microsoft.azure.management.sql.SqlServer.yml - name: SqlServer - nameWithType: SqlServer - fullName: com.microsoft.azure.management.sql.SqlServer - type: Interface - summary:

An immutable client-side representation of an Azure SQL Server.

- syntax: - content: public interface SqlServer extends GroupableResource,Refreshable,Updatable,GroupableResource,Refreshable,Updatable -- uid: com.microsoft.azure.management.sql.SqlServer.FirewallRules - parent: com.microsoft.azure.management.sql - href: com.microsoft.azure.management.sql.SqlServer.FirewallRules.yml - name: SqlServer.FirewallRules - nameWithType: SqlServer.FirewallRules - fullName: com.microsoft.azure.management.sql.SqlServer.FirewallRules - type: Interface - summary:

Entry point to firewall rules from the SQL Server.

- syntax: - content: public interface FirewallRules \ No newline at end of file diff --git a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/sql/toc.yml b/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/sql/toc.yml deleted file mode 100644 index d1891ffa4fb..00000000000 --- a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/sql/toc.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TableOfContent -- uid: com.microsoft.azure.management.sql - name: com.microsoft.azure.management.sql - href: com.microsoft.azure.management.sql.yml - items: - - uid: com.microsoft.azure.management.sql.SqlServer - name: SqlServer - href: com.microsoft.azure.management.sql.SqlServer.yml - - uid: com.microsoft.azure.management.sql.SqlServer.FirewallRules - name: SqlServer.FirewallRules - href: com.microsoft.azure.management.sql.SqlServer.FirewallRules.yml \ No newline at end of file diff --git a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/toc.yml b/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/toc.yml deleted file mode 100644 index 567cc83b339..00000000000 --- a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/mref/toc.yml +++ /dev/null @@ -1,3 +0,0 @@ -### YamlMime:ManagedReference -- name: CatLibrary.Cat - uid: CatLibrary.Cat`2 \ No newline at end of file diff --git a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/template/ManagedReference.html.tmpl b/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/template/ManagedReference.html.tmpl deleted file mode 100644 index e72bd16d149..00000000000 --- a/test/Microsoft.DocAsCode.Build.ManagedReference.WithPlugins.Tests/TestData/template/ManagedReference.html.tmpl +++ /dev/null @@ -1 +0,0 @@ -{{{summary}}} \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/toc.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/toc.html.view.verified.json index 6a9c05fe97b..e96118bc848 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/toc.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/toc.html.view.verified.json @@ -293,6 +293,7 @@ "level": 2.0 } ], + "memberLayout": "SamePage", "_key": "api/toc.yml", "_lang": "csharp", "_path": "api/toc.html", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Extensions/api/toc.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Extensions/api/toc.html.view.verified.json index 540ae3b858d..700a12e0a0e 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Extensions/api/toc.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Extensions/api/toc.html.view.verified.json @@ -118,6 +118,7 @@ "leaf": false } ], + "memberLayout": "SeparatePages", "_key": "api/toc.yml", "_lang": "csharp", "_navKey": "~/toc.yml", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Extensions/api/toc.json.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Extensions/api/toc.json.view.verified.json new file mode 100644 index 00000000000..a39af9396af --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Extensions/api/toc.json.view.verified.json @@ -0,0 +1,3 @@ +{ + "content": "{\"items\":[{\"name\":\"MyExample\",\"href\":\"MyExample.html\",\"topicHref\":\"MyExample.html\",\"topicUid\":\"MyExample\",\"items\":[{\"name\":\"ExampleClass\",\"href\":\"MyExample.ExampleClass.html\",\"topicHref\":\"MyExample.ExampleClass.html\",\"topicUid\":\"MyExample.ExampleClass\",\"items\":[{\"name\":\"Constructors\",\"items\":[{\"name\":\"ExampleClass\",\"href\":\"MyExample.ExampleClass.-ctor.html\",\"topicHref\":\"MyExample.ExampleClass.-ctor.html\",\"topicUid\":\"MyExample.ExampleClass.#ctor*\",\"name.vb\":\"New\",\"fullName\":\"MyExample.ExampleClass.ExampleClass\",\"nameWithType\":\"ExampleClass.ExampleClass\",\"type\":\"Constructor\",\"isEii\":false,\"fullName.vb\":\"MyExample.ExampleClass.New\",\"nameWithType.vb\":\"ExampleClass.New\",\"tocHref\":null,\"level\":5,\"items\":[],\"leaf\":true}],\"topicHref\":null,\"tocHref\":null,\"level\":4,\"leaf\":false},{\"name\":\"Properties\",\"items\":[{\"name\":\"MyProperty\",\"href\":\"MyExample.ExampleClass.MyProperty.html\",\"topicHref\":\"MyExample.ExampleClass.MyProperty.html\",\"topicUid\":\"MyExample.ExampleClass.MyProperty*\",\"fullName\":\"MyExample.ExampleClass.MyProperty\",\"nameWithType\":\"ExampleClass.MyProperty\",\"type\":\"Property\",\"isEii\":false,\"tocHref\":null,\"level\":5,\"items\":[],\"leaf\":true}],\"topicHref\":null,\"tocHref\":null,\"level\":4,\"leaf\":false},{\"name\":\"Methods\",\"items\":[{\"name\":\"MyMethod\",\"href\":\"MyExample.ExampleClass.MyMethod.html\",\"topicHref\":\"MyExample.ExampleClass.MyMethod.html\",\"topicUid\":\"MyExample.ExampleClass.MyMethod*\",\"fullName\":\"MyExample.ExampleClass.MyMethod\",\"nameWithType\":\"ExampleClass.MyMethod\",\"type\":\"Method\",\"isEii\":false,\"tocHref\":null,\"level\":5,\"items\":[],\"leaf\":true}],\"topicHref\":null,\"tocHref\":null,\"level\":4,\"leaf\":false},{\"name\":\"Events\",\"items\":[{\"name\":\"MyEvent\",\"href\":\"MyExample.ExampleClass.MyEvent.html\",\"topicHref\":\"MyExample.ExampleClass.MyEvent.html\",\"topicUid\":\"MyExample.ExampleClass.MyEvent\",\"fullName\":\"MyExample.ExampleClass.MyEvent\",\"nameWithType\":\"ExampleClass.MyEvent\",\"type\":\"Event\",\"isEii\":false,\"tocHref\":null,\"level\":5,\"items\":[],\"leaf\":true}],\"topicHref\":null,\"tocHref\":null,\"level\":4,\"leaf\":false}],\"tocHref\":null,\"level\":3,\"leaf\":false}],\"tocHref\":null,\"level\":2,\"leaf\":false}],\"memberLayout\":\"SeparatePages\",\"topicHref\":null,\"tocHref\":null,\"name\":null,\"level\":1,\"leaf\":false}" +} \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Extensions/api/toc.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Extensions/api/toc.verified.json new file mode 100644 index 00000000000..a6e54a57364 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Extensions/api/toc.verified.json @@ -0,0 +1,2 @@ + +{"items":[{"name":"MyExample","href":"MyExample.html","topicHref":"MyExample.html","topicUid":"MyExample","items":[{"name":"ExampleClass","href":"MyExample.ExampleClass.html","topicHref":"MyExample.ExampleClass.html","topicUid":"MyExample.ExampleClass","items":[{"name":"Constructors","items":[{"name":"ExampleClass","href":"MyExample.ExampleClass.-ctor.html","topicHref":"MyExample.ExampleClass.-ctor.html","topicUid":"MyExample.ExampleClass.#ctor*","name.vb":"New","fullName":"MyExample.ExampleClass.ExampleClass","nameWithType":"ExampleClass.ExampleClass","type":"Constructor","isEii":false,"fullName.vb":"MyExample.ExampleClass.New","nameWithType.vb":"ExampleClass.New","tocHref":null,"level":5,"items":[],"leaf":true}],"topicHref":null,"tocHref":null,"level":4,"leaf":false},{"name":"Properties","items":[{"name":"MyProperty","href":"MyExample.ExampleClass.MyProperty.html","topicHref":"MyExample.ExampleClass.MyProperty.html","topicUid":"MyExample.ExampleClass.MyProperty*","fullName":"MyExample.ExampleClass.MyProperty","nameWithType":"ExampleClass.MyProperty","type":"Property","isEii":false,"tocHref":null,"level":5,"items":[],"leaf":true}],"topicHref":null,"tocHref":null,"level":4,"leaf":false},{"name":"Methods","items":[{"name":"MyMethod","href":"MyExample.ExampleClass.MyMethod.html","topicHref":"MyExample.ExampleClass.MyMethod.html","topicUid":"MyExample.ExampleClass.MyMethod*","fullName":"MyExample.ExampleClass.MyMethod","nameWithType":"ExampleClass.MyMethod","type":"Method","isEii":false,"tocHref":null,"level":5,"items":[],"leaf":true}],"topicHref":null,"tocHref":null,"level":4,"leaf":false},{"name":"Events","items":[{"name":"MyEvent","href":"MyExample.ExampleClass.MyEvent.html","topicHref":"MyExample.ExampleClass.MyEvent.html","topicUid":"MyExample.ExampleClass.MyEvent","fullName":"MyExample.ExampleClass.MyEvent","nameWithType":"ExampleClass.MyEvent","type":"Event","isEii":false,"tocHref":null,"level":5,"items":[],"leaf":true}],"topicHref":null,"tocHref":null,"level":4,"leaf":false}],"tocHref":null,"level":3,"leaf":false}],"tocHref":null,"level":2,"leaf":false}],"memberLayout":"SeparatePages","topicHref":null,"tocHref":null,"name":null,"level":1,"leaf":false} \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Extensions/toc.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Extensions/toc.html.view.verified.json index faf2ada8dba..8c343485c33 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Extensions/toc.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Extensions/toc.html.view.verified.json @@ -89,5 +89,7 @@ "tocHref": null, "name": null, "level": 1.0, - "leaf": false + "leaf": false, + "title": "Table of Content", + "_disableToc": true } \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Extensions/toc.json.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Extensions/toc.json.view.verified.json new file mode 100644 index 00000000000..8b578d02233 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Extensions/toc.json.view.verified.json @@ -0,0 +1,3 @@ +{ + "content": "{\"items\":[{\"name\":\"Api Documentation\",\"href\":\"api/MyExample.html\",\"tocHref\":\"api/toc.html\",\"topicHref\":\"api/MyExample.html\",\"topicUid\":\"MyExample\"}]}" +} \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Extensions/toc.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Extensions/toc.verified.json new file mode 100644 index 00000000000..772838dd4b3 --- /dev/null +++ b/test/docfx.Snapshot.Tests/SamplesTest.Extensions/toc.verified.json @@ -0,0 +1,2 @@ + +{"items":[{"name":"Api Documentation","href":"api/MyExample.html","tocHref":"api/toc.html","topicHref":"api/MyExample.html","topicUid":"MyExample"}]} \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.html.view.verified.json index 76147876d28..c8d7aa41980 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.html.view.verified.json @@ -319,6 +319,7 @@ "level": 2.0 } ], + "memberLayout": "SamePage", "_appName": "Seed", "_appTitle": "docfx seed website", "_enableSearch": true, diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.json.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.json.view.verified.json index d14dde56c27..3d7fe4a4152 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.json.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.json.view.verified.json @@ -1,3 +1,3 @@ { - "content": "{\"items\":[{\"name\":\"BuildFromAssembly\",\"href\":\"BuildFromAssembly.html\",\"topicHref\":\"BuildFromAssembly.html\",\"topicUid\":\"BuildFromAssembly\",\"items\":[{\"name\":\"Class1\",\"href\":\"BuildFromAssembly.Class1.html\",\"topicHref\":\"BuildFromAssembly.Class1.html\",\"topicUid\":\"BuildFromAssembly.Class1\"}]},{\"name\":\"BuildFromCSharpSourceCode\",\"href\":\"BuildFromCSharpSourceCode.html\",\"topicHref\":\"BuildFromCSharpSourceCode.html\",\"topicUid\":\"BuildFromCSharpSourceCode\",\"items\":[{\"name\":\"CSharp\",\"href\":\"BuildFromCSharpSourceCode.CSharp.html\",\"topicHref\":\"BuildFromCSharpSourceCode.CSharp.html\",\"topicUid\":\"BuildFromCSharpSourceCode.CSharp\"}]},{\"name\":\"BuildFromProject\",\"href\":\"BuildFromProject.html\",\"topicHref\":\"BuildFromProject.html\",\"topicUid\":\"BuildFromProject\",\"items\":[{\"name\":\"Class1\",\"href\":\"BuildFromProject.Class1.html\",\"topicHref\":\"BuildFromProject.Class1.html\",\"topicUid\":\"BuildFromProject.Class1\"},{\"name\":\"Class1.Test\",\"href\":\"BuildFromProject.Class1.Test-1.html\",\"topicHref\":\"BuildFromProject.Class1.Test-1.html\",\"topicUid\":\"BuildFromProject.Class1.Test`1\",\"name.vb\":\"Class1.Test(Of T)\"}]},{\"name\":\"BuildFromVBSourceCode\",\"href\":\"BuildFromVBSourceCode.html\",\"topicHref\":\"BuildFromVBSourceCode.html\",\"topicUid\":\"BuildFromVBSourceCode\",\"items\":[{\"name\":\"BaseClass1\",\"href\":\"BuildFromVBSourceCode.BaseClass1.html\",\"topicHref\":\"BuildFromVBSourceCode.BaseClass1.html\",\"topicUid\":\"BuildFromVBSourceCode.BaseClass1\"},{\"name\":\"Class1\",\"href\":\"BuildFromVBSourceCode.Class1.html\",\"topicHref\":\"BuildFromVBSourceCode.Class1.html\",\"topicUid\":\"BuildFromVBSourceCode.Class1\"}]},{\"name\":\"CatLibrary\",\"href\":\"CatLibrary.html\",\"topicHref\":\"CatLibrary.html\",\"topicUid\":\"CatLibrary\",\"items\":[{\"name\":\"Core\",\"href\":\"CatLibrary.Core.html\",\"topicHref\":\"CatLibrary.Core.html\",\"topicUid\":\"CatLibrary.Core\",\"items\":[{\"name\":\"ContainersRefType\",\"href\":\"CatLibrary.Core.ContainersRefType.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType\"},{\"name\":\"ContainersRefType.ColorType\",\"href\":\"CatLibrary.Core.ContainersRefType.ColorType.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ColorType.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ColorType\"},{\"name\":\"ContainersRefType.ContainersRefTypeChild\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild\"},{\"name\":\"ContainersRefType.ContainersRefTypeChildInterface\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface\"},{\"name\":\"ContainersRefType.ContainersRefTypeDelegate\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate\"},{\"name\":\"ExplicitLayoutClass\",\"href\":\"CatLibrary.Core.ExplicitLayoutClass.html\",\"topicHref\":\"CatLibrary.Core.ExplicitLayoutClass.html\",\"topicUid\":\"CatLibrary.Core.ExplicitLayoutClass\"}],\"name.csharp\":\"CatLibrary.Core\",\"name.vb\":\"CatLibrary.Core\"},{\"name\":\"Cat\",\"href\":\"CatLibrary.Cat-2.html\",\"topicHref\":\"CatLibrary.Cat-2.html\",\"topicUid\":\"CatLibrary.Cat`2\",\"name.vb\":\"Cat(Of T, K)\"},{\"name\":\"CatException\",\"href\":\"CatLibrary.CatException-1.html\",\"topicHref\":\"CatLibrary.CatException-1.html\",\"topicUid\":\"CatLibrary.CatException`1\",\"name.vb\":\"CatException(Of T)\"},{\"name\":\"Complex\",\"href\":\"CatLibrary.Complex-2.html\",\"topicHref\":\"CatLibrary.Complex-2.html\",\"topicUid\":\"CatLibrary.Complex`2\",\"name.vb\":\"Complex(Of T, J)\"},{\"name\":\"FakeDelegate\",\"href\":\"CatLibrary.FakeDelegate-1.html\",\"topicHref\":\"CatLibrary.FakeDelegate-1.html\",\"topicUid\":\"CatLibrary.FakeDelegate`1\",\"name.vb\":\"FakeDelegate(Of T)\"},{\"name\":\"IAnimal\",\"href\":\"CatLibrary.IAnimal.html\",\"topicHref\":\"CatLibrary.IAnimal.html\",\"topicUid\":\"CatLibrary.IAnimal\"},{\"name\":\"ICat\",\"href\":\"CatLibrary.ICat.html\",\"topicHref\":\"CatLibrary.ICat.html\",\"topicUid\":\"CatLibrary.ICat\"},{\"name\":\"ICatExtension\",\"href\":\"CatLibrary.ICatExtension.html\",\"topicHref\":\"CatLibrary.ICatExtension.html\",\"topicUid\":\"CatLibrary.ICatExtension\"},{\"name\":\"MRefDelegate\",\"href\":\"CatLibrary.MRefDelegate-3.html\",\"topicHref\":\"CatLibrary.MRefDelegate-3.html\",\"topicUid\":\"CatLibrary.MRefDelegate`3\",\"name.vb\":\"MRefDelegate(Of K, T, L)\"},{\"name\":\"MRefNormalDelegate\",\"href\":\"CatLibrary.MRefNormalDelegate.html\",\"topicHref\":\"CatLibrary.MRefNormalDelegate.html\",\"topicUid\":\"CatLibrary.MRefNormalDelegate\"},{\"name\":\"Tom\",\"href\":\"CatLibrary.Tom.html\",\"topicHref\":\"CatLibrary.Tom.html\",\"topicUid\":\"CatLibrary.Tom\"},{\"name\":\"TomFromBaseClass\",\"href\":\"CatLibrary.TomFromBaseClass.html\",\"topicHref\":\"CatLibrary.TomFromBaseClass.html\",\"topicUid\":\"CatLibrary.TomFromBaseClass\"}]},{\"name\":\"MRef.Demo.Enumeration\",\"href\":\"MRef.Demo.Enumeration.html\",\"topicHref\":\"MRef.Demo.Enumeration.html\",\"topicUid\":\"MRef.Demo.Enumeration\",\"items\":[{\"name\":\"ColorType\",\"href\":\"MRef.Demo.Enumeration.ColorType.html\",\"topicHref\":\"MRef.Demo.Enumeration.ColorType.html\",\"topicUid\":\"MRef.Demo.Enumeration.ColorType\"}]}]}" + "content": "{\"items\":[{\"name\":\"BuildFromAssembly\",\"href\":\"BuildFromAssembly.html\",\"topicHref\":\"BuildFromAssembly.html\",\"topicUid\":\"BuildFromAssembly\",\"items\":[{\"name\":\"Class1\",\"href\":\"BuildFromAssembly.Class1.html\",\"topicHref\":\"BuildFromAssembly.Class1.html\",\"topicUid\":\"BuildFromAssembly.Class1\"}]},{\"name\":\"BuildFromCSharpSourceCode\",\"href\":\"BuildFromCSharpSourceCode.html\",\"topicHref\":\"BuildFromCSharpSourceCode.html\",\"topicUid\":\"BuildFromCSharpSourceCode\",\"items\":[{\"name\":\"CSharp\",\"href\":\"BuildFromCSharpSourceCode.CSharp.html\",\"topicHref\":\"BuildFromCSharpSourceCode.CSharp.html\",\"topicUid\":\"BuildFromCSharpSourceCode.CSharp\"}]},{\"name\":\"BuildFromProject\",\"href\":\"BuildFromProject.html\",\"topicHref\":\"BuildFromProject.html\",\"topicUid\":\"BuildFromProject\",\"items\":[{\"name\":\"Class1\",\"href\":\"BuildFromProject.Class1.html\",\"topicHref\":\"BuildFromProject.Class1.html\",\"topicUid\":\"BuildFromProject.Class1\"},{\"name\":\"Class1.Test\",\"href\":\"BuildFromProject.Class1.Test-1.html\",\"topicHref\":\"BuildFromProject.Class1.Test-1.html\",\"topicUid\":\"BuildFromProject.Class1.Test`1\",\"name.vb\":\"Class1.Test(Of T)\"}]},{\"name\":\"BuildFromVBSourceCode\",\"href\":\"BuildFromVBSourceCode.html\",\"topicHref\":\"BuildFromVBSourceCode.html\",\"topicUid\":\"BuildFromVBSourceCode\",\"items\":[{\"name\":\"BaseClass1\",\"href\":\"BuildFromVBSourceCode.BaseClass1.html\",\"topicHref\":\"BuildFromVBSourceCode.BaseClass1.html\",\"topicUid\":\"BuildFromVBSourceCode.BaseClass1\"},{\"name\":\"Class1\",\"href\":\"BuildFromVBSourceCode.Class1.html\",\"topicHref\":\"BuildFromVBSourceCode.Class1.html\",\"topicUid\":\"BuildFromVBSourceCode.Class1\"}]},{\"name\":\"CatLibrary\",\"href\":\"CatLibrary.html\",\"topicHref\":\"CatLibrary.html\",\"topicUid\":\"CatLibrary\",\"items\":[{\"name\":\"Core\",\"href\":\"CatLibrary.Core.html\",\"topicHref\":\"CatLibrary.Core.html\",\"topicUid\":\"CatLibrary.Core\",\"items\":[{\"name\":\"ContainersRefType\",\"href\":\"CatLibrary.Core.ContainersRefType.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType\"},{\"name\":\"ContainersRefType.ColorType\",\"href\":\"CatLibrary.Core.ContainersRefType.ColorType.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ColorType.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ColorType\"},{\"name\":\"ContainersRefType.ContainersRefTypeChild\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChild\"},{\"name\":\"ContainersRefType.ContainersRefTypeChildInterface\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeChildInterface\"},{\"name\":\"ContainersRefType.ContainersRefTypeDelegate\",\"href\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\",\"topicHref\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html\",\"topicUid\":\"CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate\"},{\"name\":\"ExplicitLayoutClass\",\"href\":\"CatLibrary.Core.ExplicitLayoutClass.html\",\"topicHref\":\"CatLibrary.Core.ExplicitLayoutClass.html\",\"topicUid\":\"CatLibrary.Core.ExplicitLayoutClass\"}],\"name.csharp\":\"CatLibrary.Core\",\"name.vb\":\"CatLibrary.Core\"},{\"name\":\"Cat\",\"href\":\"CatLibrary.Cat-2.html\",\"topicHref\":\"CatLibrary.Cat-2.html\",\"topicUid\":\"CatLibrary.Cat`2\",\"name.vb\":\"Cat(Of T, K)\"},{\"name\":\"CatException\",\"href\":\"CatLibrary.CatException-1.html\",\"topicHref\":\"CatLibrary.CatException-1.html\",\"topicUid\":\"CatLibrary.CatException`1\",\"name.vb\":\"CatException(Of T)\"},{\"name\":\"Complex\",\"href\":\"CatLibrary.Complex-2.html\",\"topicHref\":\"CatLibrary.Complex-2.html\",\"topicUid\":\"CatLibrary.Complex`2\",\"name.vb\":\"Complex(Of T, J)\"},{\"name\":\"FakeDelegate\",\"href\":\"CatLibrary.FakeDelegate-1.html\",\"topicHref\":\"CatLibrary.FakeDelegate-1.html\",\"topicUid\":\"CatLibrary.FakeDelegate`1\",\"name.vb\":\"FakeDelegate(Of T)\"},{\"name\":\"IAnimal\",\"href\":\"CatLibrary.IAnimal.html\",\"topicHref\":\"CatLibrary.IAnimal.html\",\"topicUid\":\"CatLibrary.IAnimal\"},{\"name\":\"ICat\",\"href\":\"CatLibrary.ICat.html\",\"topicHref\":\"CatLibrary.ICat.html\",\"topicUid\":\"CatLibrary.ICat\"},{\"name\":\"ICatExtension\",\"href\":\"CatLibrary.ICatExtension.html\",\"topicHref\":\"CatLibrary.ICatExtension.html\",\"topicUid\":\"CatLibrary.ICatExtension\"},{\"name\":\"MRefDelegate\",\"href\":\"CatLibrary.MRefDelegate-3.html\",\"topicHref\":\"CatLibrary.MRefDelegate-3.html\",\"topicUid\":\"CatLibrary.MRefDelegate`3\",\"name.vb\":\"MRefDelegate(Of K, T, L)\"},{\"name\":\"MRefNormalDelegate\",\"href\":\"CatLibrary.MRefNormalDelegate.html\",\"topicHref\":\"CatLibrary.MRefNormalDelegate.html\",\"topicUid\":\"CatLibrary.MRefNormalDelegate\"},{\"name\":\"Tom\",\"href\":\"CatLibrary.Tom.html\",\"topicHref\":\"CatLibrary.Tom.html\",\"topicUid\":\"CatLibrary.Tom\"},{\"name\":\"TomFromBaseClass\",\"href\":\"CatLibrary.TomFromBaseClass.html\",\"topicHref\":\"CatLibrary.TomFromBaseClass.html\",\"topicUid\":\"CatLibrary.TomFromBaseClass\"}]},{\"name\":\"MRef.Demo.Enumeration\",\"href\":\"MRef.Demo.Enumeration.html\",\"topicHref\":\"MRef.Demo.Enumeration.html\",\"topicUid\":\"MRef.Demo.Enumeration\",\"items\":[{\"name\":\"ColorType\",\"href\":\"MRef.Demo.Enumeration.ColorType.html\",\"topicHref\":\"MRef.Demo.Enumeration.ColorType.html\",\"topicUid\":\"MRef.Demo.Enumeration.ColorType\"}]}],\"memberLayout\":\"SamePage\"}" } \ No newline at end of file diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.verified.json index 74a032c0ec7..e2e6f982caf 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/toc.verified.json @@ -208,5 +208,6 @@ } ] } - ] + ], + "memberLayout": "SamePage" } \ 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 68d3c7589bc..b29485bd58c 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json @@ -102,7 +102,7 @@ "api/CatLibrary.FakeDelegate-1.html": { "href": "api/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 type.specName.0.value Return a fake number to confuse you. Type Parameters T Fake para" + "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" }, "api/CatLibrary.html": { "href": "api/CatLibrary.html", 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 e34969bfa71..fe63d22482b 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 @@ -228,6 +228,7 @@
Table of Contents
+

Class Class1 @@ -288,8 +289,10 @@

Methods

+

@@ -413,6 +416,7 @@

Re +

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 d4c66ebe776..0a397fe31dc 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 @@ -228,6 +228,7 @@
Table of Contents
+

Constructors

+

@@ -440,9 +443,11 @@

ParametersFields

+

isHealthy @@ -474,8 +479,10 @@

Field ValueProperties

+

@@ -578,8 +585,10 @@

Property ValueMethods

+

@@ -754,9 +763,11 @@

Exceptions +

Events

+

ownEat @@ -786,8 +797,10 @@

Event TypeOperators

+

@@ -909,6 +922,7 @@

Returns 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 5fb188b16d1..138ac430f3f 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 @@ -299,6 +299,8 @@

Delegates

Delegate in the namespace

+ +
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 2935d3bf2bb..b999c673967 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 @@ -299,6 +299,8 @@

Delegates

Delegate in the namespace

+ +
diff --git a/test/docfx.Tests/MetadataCommandTest.cs b/test/docfx.Tests/MetadataCommandTest.cs index eef3b88f6fc..ef2c8f7e868 100644 --- a/test/docfx.Tests/MetadataCommandTest.cs +++ b/test/docfx.Tests/MetadataCommandTest.cs @@ -121,7 +121,7 @@ public void TestMetadataCommandFromVBProject() var file = Path.Combine(_outputFolder, "toc.yml"); Assert.True(File.Exists(file)); - var tocViewModel = YamlUtility.Deserialize(file); + var tocViewModel = YamlUtility.Deserialize(file).Items; Assert.Equal("testVBproj1.Foo", tocViewModel[0].Uid); Assert.Equal("testVBproj1.Foo", tocViewModel[0].Name); Assert.Equal("testVBproj1.Foo.Bar", tocViewModel[0].Items[0].Uid); @@ -190,7 +190,7 @@ public void TestMetadataCommandFromCSProjectWithFilterInConfig() var file = Path.Combine(_outputFolder, "toc.yml"); Assert.True(File.Exists(file)); - var tocViewModel = YamlUtility.Deserialize(file); + var tocViewModel = YamlUtility.Deserialize(file).Items; Assert.Equal("Foo", tocViewModel[0].Uid); Assert.Equal("Foo", tocViewModel[0].Name); Assert.Equal("Foo.Bar", tocViewModel[0].Items[0].Uid); @@ -238,7 +238,7 @@ public void TestMetadataCommandFromCSProjectWithFilterInOption() var file = Path.Combine(_outputFolder, "toc.yml"); Assert.True(File.Exists(file)); - var tocViewModel = YamlUtility.Deserialize(file); + var tocViewModel = YamlUtility.Deserialize(file).Items; Assert.Equal("Foo", tocViewModel[0].Uid); Assert.Equal("Foo", tocViewModel[0].Name); Assert.Equal("Foo.Bar", tocViewModel[0].Items[0].Uid); @@ -302,7 +302,7 @@ public void TestMetadataCommandFromCSProjectWithMultipleNamespaces() var file = Path.Combine(_outputFolder, "toc.yml"); Assert.True(File.Exists(file)); - var tocViewModel = YamlUtility.Deserialize(file); + var tocViewModel = YamlUtility.Deserialize(file).Items; Assert.Equal("OtherNamespace", tocViewModel[0].Uid); Assert.Equal("OtherNamespace", tocViewModel[0].Name); @@ -339,7 +339,7 @@ public void TestMetadataCommandFromCSProjectWithMultipleNamespacesWithFlatToc() var file = Path.Combine(_outputFolder, "toc.yml"); Assert.True(File.Exists(file)); - var tocViewModel = YamlUtility.Deserialize(file); + var tocViewModel = YamlUtility.Deserialize(file).Items; Assert.Equal("OtherNamespace", tocViewModel[0].Uid); Assert.Equal("OtherNamespace", tocViewModel[0].Name); @@ -376,7 +376,7 @@ public void TestMetadataCommandFromCSProjectWithMultipleNamespacesWithGapsWithNe var file = Path.Combine(_outputFolder, "toc.yml"); Assert.True(File.Exists(file)); - var tocViewModel = YamlUtility.Deserialize(file); + var tocViewModel = YamlUtility.Deserialize(file).Items; Assert.Equal("OtherNamespace", tocViewModel[0].Uid); Assert.Equal("OtherNamespace", tocViewModel[0].Name); @@ -408,7 +408,7 @@ private void CheckResult() var file = Path.Combine(_outputFolder, "toc.yml"); Assert.True(File.Exists(file)); - var tocViewModel = YamlUtility.Deserialize(file); + var tocViewModel = YamlUtility.Deserialize(file).Items; Assert.Equal("Foo", tocViewModel[0].Uid); Assert.Equal("Foo", tocViewModel[0].Name); Assert.Equal("Foo.Bar", tocViewModel[0].Items[0].Uid);