diff --git a/README.md b/README.md index ac23b4d3..9e683d1b 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ dotnet tool [![Coverage Status](https://coveralls.io/repos/github/Doraku/DefaultDocumentation/badge.svg?branch=master)](https://coveralls.io/github/Doraku/DefaultDocumentation?branch=master) - [Api documentation](./documentation/api/index.md 'Api documentation') +- [Markdown documentation](./documentation/markdown/index.md 'Markdown documentation') - [Requirement](#Requirement) @@ -420,6 +421,7 @@ The different `DocItem` types are: - `Name` or `DefaultDocumentation.Markdown.FileNameFactories.NameFactory DefaultDocumentation.Markdown` removes the namespace (collisions can happen if there is multiple types with the same name in different namespaces) - `Md5` or `DefaultDocumentation.Markdown.FileNameFactories.Md5Factory DefaultDocumentation.Markdown` uses a Md5 of the full name of each member to produce shorter name, collisions can happen - `NameAndMd5Mix` or `DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory DefaultDocumentation.Markdown` removes the namespace and use a Md5 for parameters +- `DirectoryName` or `DefaultDocumentation.Markdown.FileNameFactories.DirectoryNameFactory DefaultDocumentation.Markdown` use a directory hierarchy The default value is `FullName`. All those implementations *WILL* delete any `.md` file *EXCEPT* a file named `readme.md`. diff --git a/documentation/DefaultDocumentation.Api.txt b/documentation/DefaultDocumentation.Api.txt index 68b96d38..2d9f6f22 100644 --- a/documentation/DefaultDocumentation.Api.txt +++ b/documentation/DefaultDocumentation.Api.txt @@ -1,163 +1,187 @@ https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ -M:DefaultDocumentation.IGeneralContextExtension.GetUrl(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|IGeneralContextExtension.GetUrl(thisIGeneralContext,DocItem).md|GetUrl(this IGeneralContext, DocItem) -M:DefaultDocumentation.IGeneralContextExtension.GetContext(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|IGeneralContextExtension.GetContext(thisIGeneralContext,DocItem).md|GetContext(this IGeneralContext, DocItem) -M:DefaultDocumentation.IGeneralContextExtension.GetSetting``1(DefaultDocumentation.IGeneralContext,System.Type,System.Func{DefaultDocumentation.IContext,``0})|IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,Type,Func_IContext,T_).md|GetSetting(this IGeneralContext, Type, Func) -M:DefaultDocumentation.IGeneralContextExtension.GetSetting``1(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem,System.Func{DefaultDocumentation.IContext,``0})|IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,DocItem,Func_IContext,T_).md|GetSetting(this IGeneralContext, DocItem, Func) +M:ICSharpCode.Decompiler.TypeSystem.IEntityExtensions.IsVisibleInDocumentation(ICSharpCode.Decompiler.TypeSystem.IEntity,DefaultDocumentation.ISettings)|ICSharpCode/Decompiler/TypeSystem/IEntityExtensions/IsVisibleInDocumentation(thisIEntity,ISettings).md|IsVisibleInDocumentation(this IEntity, ISettings) +N:ICSharpCode.Decompiler.TypeSystem|index.md#ICSharpCode.Decompiler.TypeSystem|ICSharpCode.Decompiler.TypeSystem +T:ICSharpCode.Decompiler.TypeSystem.IEntityExtensions|ICSharpCode/Decompiler/TypeSystem/IEntityExtensions/index.md|IEntityExtensions +M:ICSharpCode.Decompiler.TypeSystem.ISymbolExtensions.ToString(ICSharpCode.Decompiler.TypeSystem.ISymbol,ICSharpCode.Decompiler.CSharp.OutputVisitor.CSharpAmbience)|ICSharpCode/Decompiler/TypeSystem/ISymbolExtensions/ToString(thisISymbol,CSharpAmbience).md|ToString(this ISymbol, CSharpAmbience) +T:ICSharpCode.Decompiler.TypeSystem.ISymbolExtensions|ICSharpCode/Decompiler/TypeSystem/ISymbolExtensions/index.md|ISymbolExtensions +M:DefaultDocumentation.IGeneralContextExtensions.GetContext(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/IGeneralContextExtensions/GetContext(thisIGeneralContext,DocItem).md|GetContext(this IGeneralContext, DocItem) +M:DefaultDocumentation.IGeneralContextExtensions.GetSetting``1(DefaultDocumentation.IGeneralContext,System.Type,System.Func{DefaultDocumentation.IContext,``0})|DefaultDocumentation/IGeneralContextExtensions/GetSetting.md#DefaultDocumentation.IGeneralContextExtensions.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,System.Type,System.Func_DefaultDocumentation.IContext,T_)|GetSetting(this IGeneralContext, Type, Func) +M:DefaultDocumentation.IGeneralContextExtensions.GetSetting``1(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem,System.Func{DefaultDocumentation.IContext,``0})|DefaultDocumentation/IGeneralContextExtensions/GetSetting.md#DefaultDocumentation.IGeneralContextExtensions.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem,System.Func_DefaultDocumentation.IContext,T_)|GetSetting(this IGeneralContext, DocItem, Func) N:DefaultDocumentation|index.md#DefaultDocumentation|DefaultDocumentation -T:DefaultDocumentation.IGeneralContextExtension|IGeneralContextExtension.md|IGeneralContextExtension -F:DefaultDocumentation.GeneratedAccessModifiers.Default|GeneratedAccessModifiers.md#DefaultDocumentation.GeneratedAccessModifiers.Default|Default -F:DefaultDocumentation.GeneratedAccessModifiers.Public|GeneratedAccessModifiers.md#DefaultDocumentation.GeneratedAccessModifiers.Public|Public -F:DefaultDocumentation.GeneratedAccessModifiers.Private|GeneratedAccessModifiers.md#DefaultDocumentation.GeneratedAccessModifiers.Private|Private -F:DefaultDocumentation.GeneratedAccessModifiers.Protected|GeneratedAccessModifiers.md#DefaultDocumentation.GeneratedAccessModifiers.Protected|Protected -F:DefaultDocumentation.GeneratedAccessModifiers.Internal|GeneratedAccessModifiers.md#DefaultDocumentation.GeneratedAccessModifiers.Internal|Internal -F:DefaultDocumentation.GeneratedAccessModifiers.ProtectedInternal|GeneratedAccessModifiers.md#DefaultDocumentation.GeneratedAccessModifiers.ProtectedInternal|ProtectedInternal -F:DefaultDocumentation.GeneratedAccessModifiers.PrivateProtected|GeneratedAccessModifiers.md#DefaultDocumentation.GeneratedAccessModifiers.PrivateProtected|PrivateProtected -T:DefaultDocumentation.GeneratedAccessModifiers|GeneratedAccessModifiers.md|GeneratedAccessModifiers -F:DefaultDocumentation.GeneratedPages.Default|GeneratedPages.md#DefaultDocumentation.GeneratedPages.Default|Default -F:DefaultDocumentation.GeneratedPages.Assembly|GeneratedPages.md#DefaultDocumentation.GeneratedPages.Assembly|Assembly -F:DefaultDocumentation.GeneratedPages.Namespaces|GeneratedPages.md#DefaultDocumentation.GeneratedPages.Namespaces|Namespaces -F:DefaultDocumentation.GeneratedPages.Classes|GeneratedPages.md#DefaultDocumentation.GeneratedPages.Classes|Classes -F:DefaultDocumentation.GeneratedPages.Delegates|GeneratedPages.md#DefaultDocumentation.GeneratedPages.Delegates|Delegates -F:DefaultDocumentation.GeneratedPages.Enums|GeneratedPages.md#DefaultDocumentation.GeneratedPages.Enums|Enums -F:DefaultDocumentation.GeneratedPages.Structs|GeneratedPages.md#DefaultDocumentation.GeneratedPages.Structs|Structs -F:DefaultDocumentation.GeneratedPages.Interfaces|GeneratedPages.md#DefaultDocumentation.GeneratedPages.Interfaces|Interfaces -F:DefaultDocumentation.GeneratedPages.Types|GeneratedPages.md#DefaultDocumentation.GeneratedPages.Types|Types -F:DefaultDocumentation.GeneratedPages.Constructors|GeneratedPages.md#DefaultDocumentation.GeneratedPages.Constructors|Constructors -F:DefaultDocumentation.GeneratedPages.Events|GeneratedPages.md#DefaultDocumentation.GeneratedPages.Events|Events -F:DefaultDocumentation.GeneratedPages.Fields|GeneratedPages.md#DefaultDocumentation.GeneratedPages.Fields|Fields -F:DefaultDocumentation.GeneratedPages.Methods|GeneratedPages.md#DefaultDocumentation.GeneratedPages.Methods|Methods -F:DefaultDocumentation.GeneratedPages.Operators|GeneratedPages.md#DefaultDocumentation.GeneratedPages.Operators|Operators -F:DefaultDocumentation.GeneratedPages.Properties|GeneratedPages.md#DefaultDocumentation.GeneratedPages.Properties|Properties -F:DefaultDocumentation.GeneratedPages.ExplicitInterfaceImplementations|GeneratedPages.md#DefaultDocumentation.GeneratedPages.ExplicitInterfaceImplementations|ExplicitInterfaceImplementations -F:DefaultDocumentation.GeneratedPages.Members|GeneratedPages.md#DefaultDocumentation.GeneratedPages.Members|Members -T:DefaultDocumentation.GeneratedPages|GeneratedPages.md|GeneratedPages -P:DefaultDocumentation.IContext.FileNameFactory|IContext.FileNameFactory.md|FileNameFactory -P:DefaultDocumentation.IContext.Sections|IContext.Sections.md|Sections -M:DefaultDocumentation.IContext.GetSetting``1(System.String)|IContext.GetSetting_T_(string).md|GetSetting(string) -T:DefaultDocumentation.IContext|IContext.md|IContext -P:DefaultDocumentation.IGeneralContext.Settings|IGeneralContext.Settings.md|Settings -P:DefaultDocumentation.IGeneralContext.Items|IGeneralContext.Items.md|Items -P:DefaultDocumentation.IGeneralContext.Elements|IGeneralContext.Elements.md|Elements -M:DefaultDocumentation.IGeneralContext.GetContext(System.Type)|IGeneralContext.GetContext(Type).md|GetContext(Type) -M:DefaultDocumentation.IGeneralContext.GetFileName(DefaultDocumentation.Models.DocItem)|IGeneralContext.GetFileName(DocItem).md|GetFileName(DocItem) -M:DefaultDocumentation.IGeneralContext.GetUrl(System.String)|IGeneralContext.GetUrl(string).md|GetUrl(string) -T:DefaultDocumentation.IGeneralContext|IGeneralContext.md|IGeneralContext -P:DefaultDocumentation.ISettings.Logger|ISettings.Logger.md|Logger -P:DefaultDocumentation.ISettings.AssemblyFile|ISettings.AssemblyFile.md|AssemblyFile -P:DefaultDocumentation.ISettings.DocumentationFile|ISettings.DocumentationFile.md|DocumentationFile -P:DefaultDocumentation.ISettings.ProjectDirectory|ISettings.ProjectDirectory.md|ProjectDirectory -P:DefaultDocumentation.ISettings.OutputDirectory|ISettings.OutputDirectory.md|OutputDirectory -P:DefaultDocumentation.ISettings.AssemblyPageName|ISettings.AssemblyPageName.md|AssemblyPageName -P:DefaultDocumentation.ISettings.GeneratedPages|ISettings.GeneratedPages.md|GeneratedPages -P:DefaultDocumentation.ISettings.GeneratedAccessModifiers|ISettings.GeneratedAccessModifiers.md|GeneratedAccessModifiers -P:DefaultDocumentation.ISettings.IncludeUndocumentedItems|ISettings.IncludeUndocumentedItems.md|IncludeUndocumentedItems -P:DefaultDocumentation.ISettings.LinksOutputFile|ISettings.LinksOutputFile.md|LinksOutputFile -P:DefaultDocumentation.ISettings.LinksBaseUrl|ISettings.LinksBaseUrl.md|LinksBaseUrl -P:DefaultDocumentation.ISettings.ExternLinksFiles|ISettings.ExternLinksFiles.md|ExternLinksFiles -T:DefaultDocumentation.ISettings|ISettings.md|ISettings -M:DefaultDocumentation.Models.DocItemExtension.HasOwnPage(DefaultDocumentation.Models.DocItem,DefaultDocumentation.IGeneralContext)|DocItemExtension.HasOwnPage(thisDocItem,IGeneralContext).md|HasOwnPage(this DocItem, IGeneralContext) -M:DefaultDocumentation.Models.DocItemExtension.TryGetTypeParameterDocItem(DefaultDocumentation.Models.DocItem,System.String,DefaultDocumentation.Models.Parameters.TypeParameterDocItem@)|DocItemExtension.TryGetTypeParameterDocItem(thisDocItem,string,TypeParameterDocItem).md|TryGetTypeParameterDocItem(this DocItem, string, TypeParameterDocItem) -M:DefaultDocumentation.Models.DocItemExtension.TryGetParameterDocItem(DefaultDocumentation.Models.DocItem,System.String,DefaultDocumentation.Models.Parameters.ParameterDocItem@)|DocItemExtension.TryGetParameterDocItem(thisDocItem,string,ParameterDocItem).md|TryGetParameterDocItem(this DocItem, string, ParameterDocItem) -M:DefaultDocumentation.Models.DocItemExtension.GetParents(DefaultDocumentation.Models.DocItem)|DocItemExtension.GetParents(thisDocItem).md|GetParents(this DocItem) +T:DefaultDocumentation.IGeneralContextExtensions|DefaultDocumentation/IGeneralContextExtensions/index.md|IGeneralContextExtensions +M:DefaultDocumentation.IPageContextExtensions.GetUrl(DefaultDocumentation.IPageContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/IPageContextExtensions/GetUrl.md#DefaultDocumentation.IPageContextExtensions.GetUrl(thisDefaultDocumentation.IPageContext,DefaultDocumentation.Models.DocItem)|GetUrl(this IPageContext, DocItem) +M:DefaultDocumentation.IPageContextExtensions.GetUrl(DefaultDocumentation.IPageContext,System.String)|DefaultDocumentation/IPageContextExtensions/GetUrl.md#DefaultDocumentation.IPageContextExtensions.GetUrl(thisDefaultDocumentation.IPageContext,string)|GetUrl(this IPageContext, string) +T:DefaultDocumentation.IPageContextExtensions|DefaultDocumentation/IPageContextExtensions/index.md|IPageContextExtensions +F:DefaultDocumentation.GeneratedAccessModifiers.Default|DefaultDocumentation/GeneratedAccessModifiers/index.md#DefaultDocumentation.GeneratedAccessModifiers.Default|Default +F:DefaultDocumentation.GeneratedAccessModifiers.Public|DefaultDocumentation/GeneratedAccessModifiers/index.md#DefaultDocumentation.GeneratedAccessModifiers.Public|Public +F:DefaultDocumentation.GeneratedAccessModifiers.Private|DefaultDocumentation/GeneratedAccessModifiers/index.md#DefaultDocumentation.GeneratedAccessModifiers.Private|Private +F:DefaultDocumentation.GeneratedAccessModifiers.Protected|DefaultDocumentation/GeneratedAccessModifiers/index.md#DefaultDocumentation.GeneratedAccessModifiers.Protected|Protected +F:DefaultDocumentation.GeneratedAccessModifiers.Internal|DefaultDocumentation/GeneratedAccessModifiers/index.md#DefaultDocumentation.GeneratedAccessModifiers.Internal|Internal +F:DefaultDocumentation.GeneratedAccessModifiers.ProtectedInternal|DefaultDocumentation/GeneratedAccessModifiers/index.md#DefaultDocumentation.GeneratedAccessModifiers.ProtectedInternal|ProtectedInternal +F:DefaultDocumentation.GeneratedAccessModifiers.PrivateProtected|DefaultDocumentation/GeneratedAccessModifiers/index.md#DefaultDocumentation.GeneratedAccessModifiers.PrivateProtected|PrivateProtected +F:DefaultDocumentation.GeneratedAccessModifiers.Api|DefaultDocumentation/GeneratedAccessModifiers/index.md#DefaultDocumentation.GeneratedAccessModifiers.Api|Api +T:DefaultDocumentation.GeneratedAccessModifiers|DefaultDocumentation/GeneratedAccessModifiers/index.md|GeneratedAccessModifiers +F:DefaultDocumentation.GeneratedPages.Default|DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Default|Default +F:DefaultDocumentation.GeneratedPages.Assembly|DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Assembly|Assembly +F:DefaultDocumentation.GeneratedPages.Namespaces|DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Namespaces|Namespaces +F:DefaultDocumentation.GeneratedPages.Classes|DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Classes|Classes +F:DefaultDocumentation.GeneratedPages.Delegates|DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Delegates|Delegates +F:DefaultDocumentation.GeneratedPages.Enums|DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Enums|Enums +F:DefaultDocumentation.GeneratedPages.Structs|DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Structs|Structs +F:DefaultDocumentation.GeneratedPages.Interfaces|DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Interfaces|Interfaces +F:DefaultDocumentation.GeneratedPages.Types|DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Types|Types +F:DefaultDocumentation.GeneratedPages.Constructors|DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Constructors|Constructors +F:DefaultDocumentation.GeneratedPages.Events|DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Events|Events +F:DefaultDocumentation.GeneratedPages.Fields|DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Fields|Fields +F:DefaultDocumentation.GeneratedPages.Methods|DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Methods|Methods +F:DefaultDocumentation.GeneratedPages.Operators|DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Operators|Operators +F:DefaultDocumentation.GeneratedPages.Properties|DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Properties|Properties +F:DefaultDocumentation.GeneratedPages.ExplicitInterfaceImplementations|DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.ExplicitInterfaceImplementations|ExplicitInterfaceImplementations +F:DefaultDocumentation.GeneratedPages.Members|DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Members|Members +T:DefaultDocumentation.GeneratedPages|DefaultDocumentation/GeneratedPages/index.md|GeneratedPages +P:DefaultDocumentation.IContext.FileNameFactory|DefaultDocumentation/IContext/FileNameFactory.md|FileNameFactory +P:DefaultDocumentation.IContext.Sections|DefaultDocumentation/IContext/Sections.md|Sections +M:DefaultDocumentation.IContext.GetSetting``1(System.String)|DefaultDocumentation/IContext/GetSetting_T_(string).md|GetSetting(string) +T:DefaultDocumentation.IContext|DefaultDocumentation/IContext/index.md|IContext +P:DefaultDocumentation.IDocItemsContext.Settings|DefaultDocumentation/IDocItemsContext/Settings.md|Settings +P:DefaultDocumentation.IDocItemsContext.Items|DefaultDocumentation/IDocItemsContext/Items.md|Items +P:DefaultDocumentation.IDocItemsContext.ItemsWithOwnPage|DefaultDocumentation/IDocItemsContext/ItemsWithOwnPage.md|ItemsWithOwnPage +M:DefaultDocumentation.IDocItemsContext.GetSetting``1(System.String)|DefaultDocumentation/IDocItemsContext/GetSetting.md#DefaultDocumentation.IDocItemsContext.GetSetting_T_(string)|GetSetting(string) +M:DefaultDocumentation.IDocItemsContext.GetSetting``1(System.Type,System.String)|DefaultDocumentation/IDocItemsContext/GetSetting.md#DefaultDocumentation.IDocItemsContext.GetSetting_T_(System.Type,string)|GetSetting(Type, string) +T:DefaultDocumentation.IDocItemsContext|DefaultDocumentation/IDocItemsContext/index.md|IDocItemsContext +P:DefaultDocumentation.IGeneralContext.Settings|DefaultDocumentation/IGeneralContext/Settings.md|Settings +P:DefaultDocumentation.IGeneralContext.Items|DefaultDocumentation/IGeneralContext/Items.md|Items +P:DefaultDocumentation.IGeneralContext.ItemsWithOwnPage|DefaultDocumentation/IGeneralContext/ItemsWithOwnPage.md|ItemsWithOwnPage +P:DefaultDocumentation.IGeneralContext.Elements|DefaultDocumentation/IGeneralContext/Elements.md|Elements +P:DefaultDocumentation.IGeneralContext.UrlFactories|DefaultDocumentation/IGeneralContext/UrlFactories.md|UrlFactories +M:DefaultDocumentation.IGeneralContext.GetContext(System.Type)|DefaultDocumentation/IGeneralContext/GetContext(Type).md|GetContext(Type) +M:DefaultDocumentation.IGeneralContext.GetFileName(DefaultDocumentation.Models.DocItem)|DefaultDocumentation/IGeneralContext/GetFileName(DocItem).md|GetFileName(DocItem) +T:DefaultDocumentation.IGeneralContext|DefaultDocumentation/IGeneralContext/index.md|IGeneralContext +P:DefaultDocumentation.IPageContext.DocItem|DefaultDocumentation/IPageContext/DocItem.md|DocItem +P:DefaultDocumentation.IPageContext.Item(System.String)|DefaultDocumentation/IPageContext/this[string].md|this[string] +T:DefaultDocumentation.IPageContext|DefaultDocumentation/IPageContext/index.md|IPageContext +P:DefaultDocumentation.ISettings.Logger|DefaultDocumentation/ISettings/Logger.md|Logger +P:DefaultDocumentation.ISettings.AssemblyFile|DefaultDocumentation/ISettings/AssemblyFile.md|AssemblyFile +P:DefaultDocumentation.ISettings.DocumentationFile|DefaultDocumentation/ISettings/DocumentationFile.md|DocumentationFile +P:DefaultDocumentation.ISettings.ProjectDirectory|DefaultDocumentation/ISettings/ProjectDirectory.md|ProjectDirectory +P:DefaultDocumentation.ISettings.OutputDirectory|DefaultDocumentation/ISettings/OutputDirectory.md|OutputDirectory +P:DefaultDocumentation.ISettings.AssemblyPageName|DefaultDocumentation/ISettings/AssemblyPageName.md|AssemblyPageName +P:DefaultDocumentation.ISettings.GeneratedPages|DefaultDocumentation/ISettings/GeneratedPages.md|GeneratedPages +P:DefaultDocumentation.ISettings.GeneratedAccessModifiers|DefaultDocumentation/ISettings/GeneratedAccessModifiers.md|GeneratedAccessModifiers +P:DefaultDocumentation.ISettings.IncludeUndocumentedItems|DefaultDocumentation/ISettings/IncludeUndocumentedItems.md|IncludeUndocumentedItems +P:DefaultDocumentation.ISettings.LinksOutputFile|DefaultDocumentation/ISettings/LinksOutputFile.md|LinksOutputFile +P:DefaultDocumentation.ISettings.LinksBaseUrl|DefaultDocumentation/ISettings/LinksBaseUrl.md|LinksBaseUrl +P:DefaultDocumentation.ISettings.ExternLinksFiles|DefaultDocumentation/ISettings/ExternLinksFiles.md|ExternLinksFiles +T:DefaultDocumentation.ISettings|DefaultDocumentation/ISettings/index.md|ISettings +M:DefaultDocumentation.Models.DocItemExtensions.TryGetTypeParameterDocItem(DefaultDocumentation.Models.DocItem,System.String,DefaultDocumentation.Models.Parameters.TypeParameterDocItem@)|DefaultDocumentation/Models/DocItemExtensions/TryGetTypeParameterDocItem(thisDocItem,string,TypeParameterDocItem).md|TryGetTypeParameterDocItem(this DocItem, string, TypeParameterDocItem) +M:DefaultDocumentation.Models.DocItemExtensions.TryGetParameterDocItem(DefaultDocumentation.Models.DocItem,System.String,DefaultDocumentation.Models.Parameters.ParameterDocItem@)|DefaultDocumentation/Models/DocItemExtensions/TryGetParameterDocItem(thisDocItem,string,ParameterDocItem).md|TryGetParameterDocItem(this DocItem, string, ParameterDocItem) +M:DefaultDocumentation.Models.DocItemExtensions.GetParents(DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Models/DocItemExtensions/GetParents(thisDocItem).md|GetParents(this DocItem) N:DefaultDocumentation.Models|index.md#DefaultDocumentation.Models|DefaultDocumentation.Models -T:DefaultDocumentation.Models.DocItemExtension|DocItemExtension.md|DocItemExtension -M:DefaultDocumentation.Models.AssemblyDocItem.#ctor(System.String,System.String,System.Xml.Linq.XElement)|AssemblyDocItem.AssemblyDocItem(string,string,XElement).md|AssemblyDocItem(string, string, XElement) -T:DefaultDocumentation.Models.AssemblyDocItem|AssemblyDocItem.md|AssemblyDocItem -P:DefaultDocumentation.Models.DocItem.Parent|DocItem.Parent.md|Parent -P:DefaultDocumentation.Models.DocItem.Id|DocItem.Id.md|Id -P:DefaultDocumentation.Models.DocItem.FullName|DocItem.FullName.md|FullName -P:DefaultDocumentation.Models.DocItem.Name|DocItem.Name.md|Name -P:DefaultDocumentation.Models.DocItem.Documentation|DocItem.Documentation.md|Documentation -T:DefaultDocumentation.Models.DocItem|DocItem.md|DocItem -P:DefaultDocumentation.Models.EntityDocItem.Entity|EntityDocItem.Entity.md|Entity -T:DefaultDocumentation.Models.EntityDocItem|EntityDocItem.md|EntityDocItem -P:DefaultDocumentation.Models.ExternDocItem.Url|ExternDocItem.Url.md|Url -M:DefaultDocumentation.Models.ExternDocItem.#ctor(System.String,System.String,System.String)|ExternDocItem.ExternDocItem(string,string,string).md|ExternDocItem(string, string, string) -T:DefaultDocumentation.Models.ExternDocItem|ExternDocItem.md|ExternDocItem -P:DefaultDocumentation.Models.IParameterizedDocItem.Parameters|IParameterizedDocItem.Parameters.md|Parameters -T:DefaultDocumentation.Models.IParameterizedDocItem|IParameterizedDocItem.md|IParameterizedDocItem -P:DefaultDocumentation.Models.ITypeParameterizedDocItem.TypeParameters|ITypeParameterizedDocItem.TypeParameters.md|TypeParameters -T:DefaultDocumentation.Models.ITypeParameterizedDocItem|ITypeParameterizedDocItem.md|ITypeParameterizedDocItem -M:DefaultDocumentation.Models.NamespaceDocItem.#ctor(DefaultDocumentation.Models.AssemblyDocItem,System.String,System.Xml.Linq.XElement)|NamespaceDocItem.NamespaceDocItem(AssemblyDocItem,string,XElement).md|NamespaceDocItem(AssemblyDocItem, string, XElement) -T:DefaultDocumentation.Models.NamespaceDocItem|NamespaceDocItem.md|NamespaceDocItem -M:DefaultDocumentation.Models.Types.ClassDocItem.#ctor(DefaultDocumentation.Models.DocItem,ICSharpCode.Decompiler.TypeSystem.ITypeDefinition,System.Xml.Linq.XElement)|ClassDocItem.ClassDocItem(DocItem,ITypeDefinition,XElement).md|ClassDocItem(DocItem, ITypeDefinition, XElement) +T:DefaultDocumentation.Models.DocItemExtensions|DefaultDocumentation/Models/DocItemExtensions/index.md|DocItemExtensions +M:DefaultDocumentation.Models.AssemblyDocItem.#ctor(System.String,System.String,System.Xml.Linq.XElement)|DefaultDocumentation/Models/AssemblyDocItem/AssemblyDocItem(string,string,XElement).md|AssemblyDocItem(string, string, XElement) +T:DefaultDocumentation.Models.AssemblyDocItem|DefaultDocumentation/Models/AssemblyDocItem/index.md|AssemblyDocItem +P:DefaultDocumentation.Models.DocItem.Parent|DefaultDocumentation/Models/DocItem/Parent.md|Parent +P:DefaultDocumentation.Models.DocItem.Id|DefaultDocumentation/Models/DocItem/Id.md|Id +P:DefaultDocumentation.Models.DocItem.FullName|DefaultDocumentation/Models/DocItem/FullName.md|FullName +P:DefaultDocumentation.Models.DocItem.Name|DefaultDocumentation/Models/DocItem/Name.md|Name +P:DefaultDocumentation.Models.DocItem.Documentation|DefaultDocumentation/Models/DocItem/Documentation.md|Documentation +M:DefaultDocumentation.Models.DocItem.#ctor(DefaultDocumentation.Models.DocItem,System.String,System.String,System.String,System.Xml.Linq.XElement)|DefaultDocumentation/Models/DocItem/DocItem(DocItem,string,string,string,XElement).md|DocItem(DocItem, string, string, string, XElement) +T:DefaultDocumentation.Models.DocItem|DefaultDocumentation/Models/DocItem/index.md|DocItem +P:DefaultDocumentation.Models.EntityDocItem.Entity|DefaultDocumentation/Models/EntityDocItem/Entity.md|Entity +T:DefaultDocumentation.Models.EntityDocItem|DefaultDocumentation/Models/EntityDocItem/index.md|EntityDocItem +P:DefaultDocumentation.Models.ExternDocItem.Url|DefaultDocumentation/Models/ExternDocItem/Url.md|Url +M:DefaultDocumentation.Models.ExternDocItem.#ctor(System.String,System.String,System.String)|DefaultDocumentation/Models/ExternDocItem/ExternDocItem(string,string,string).md|ExternDocItem(string, string, string) +T:DefaultDocumentation.Models.ExternDocItem|DefaultDocumentation/Models/ExternDocItem/index.md|ExternDocItem +P:DefaultDocumentation.Models.IParameterizedDocItem.Parameters|DefaultDocumentation/Models/IParameterizedDocItem/Parameters.md|Parameters +T:DefaultDocumentation.Models.IParameterizedDocItem|DefaultDocumentation/Models/IParameterizedDocItem/index.md|IParameterizedDocItem +P:DefaultDocumentation.Models.ITypeParameterizedDocItem.TypeParameters|DefaultDocumentation/Models/ITypeParameterizedDocItem/TypeParameters.md|TypeParameters +T:DefaultDocumentation.Models.ITypeParameterizedDocItem|DefaultDocumentation/Models/ITypeParameterizedDocItem/index.md|ITypeParameterizedDocItem +M:DefaultDocumentation.Models.NamespaceDocItem.#ctor(DefaultDocumentation.Models.AssemblyDocItem,System.String,System.Xml.Linq.XElement)|DefaultDocumentation/Models/NamespaceDocItem/NamespaceDocItem(AssemblyDocItem,string,XElement).md|NamespaceDocItem(AssemblyDocItem, string, XElement) +T:DefaultDocumentation.Models.NamespaceDocItem|DefaultDocumentation/Models/NamespaceDocItem/index.md|NamespaceDocItem +M:DefaultDocumentation.Models.Types.ClassDocItem.#ctor(DefaultDocumentation.Models.DocItem,ICSharpCode.Decompiler.TypeSystem.ITypeDefinition,System.Xml.Linq.XElement)|DefaultDocumentation/Models/Types/ClassDocItem/ClassDocItem(DocItem,ITypeDefinition,XElement).md|ClassDocItem(DocItem, ITypeDefinition, XElement) N:DefaultDocumentation.Models.Types|index.md#DefaultDocumentation.Models.Types|DefaultDocumentation.Models.Types -T:DefaultDocumentation.Models.Types.ClassDocItem|ClassDocItem.md|ClassDocItem -P:DefaultDocumentation.Models.Types.DelegateDocItem.InvokeMethod|DelegateDocItem.InvokeMethod.md|InvokeMethod -P:DefaultDocumentation.Models.Types.DelegateDocItem.Parameters|DelegateDocItem.Parameters.md|Parameters -M:DefaultDocumentation.Models.Types.DelegateDocItem.#ctor(DefaultDocumentation.Models.DocItem,ICSharpCode.Decompiler.TypeSystem.ITypeDefinition,System.Xml.Linq.XElement)|DelegateDocItem.DelegateDocItem(DocItem,ITypeDefinition,XElement).md|DelegateDocItem(DocItem, ITypeDefinition, XElement) -T:DefaultDocumentation.Models.Types.DelegateDocItem|DelegateDocItem.md|DelegateDocItem -M:DefaultDocumentation.Models.Types.EnumDocItem.#ctor(DefaultDocumentation.Models.DocItem,ICSharpCode.Decompiler.TypeSystem.ITypeDefinition,System.Xml.Linq.XElement)|EnumDocItem.EnumDocItem(DocItem,ITypeDefinition,XElement).md|EnumDocItem(DocItem, ITypeDefinition, XElement) -T:DefaultDocumentation.Models.Types.EnumDocItem|EnumDocItem.md|EnumDocItem -M:DefaultDocumentation.Models.Types.InterfaceDocItem.#ctor(DefaultDocumentation.Models.DocItem,ICSharpCode.Decompiler.TypeSystem.ITypeDefinition,System.Xml.Linq.XElement)|InterfaceDocItem.InterfaceDocItem(DocItem,ITypeDefinition,XElement).md|InterfaceDocItem(DocItem, ITypeDefinition, XElement) -T:DefaultDocumentation.Models.Types.InterfaceDocItem|InterfaceDocItem.md|InterfaceDocItem -M:DefaultDocumentation.Models.Types.StructDocItem.#ctor(DefaultDocumentation.Models.DocItem,ICSharpCode.Decompiler.TypeSystem.ITypeDefinition,System.Xml.Linq.XElement)|StructDocItem.StructDocItem(DocItem,ITypeDefinition,XElement).md|StructDocItem(DocItem, ITypeDefinition, XElement) -T:DefaultDocumentation.Models.Types.StructDocItem|StructDocItem.md|StructDocItem -P:DefaultDocumentation.Models.Types.TypeDocItem.Type|TypeDocItem.Type.md|Type -P:DefaultDocumentation.Models.Types.TypeDocItem.TypeParameters|TypeDocItem.TypeParameters.md|TypeParameters -T:DefaultDocumentation.Models.Types.TypeDocItem|TypeDocItem.md|TypeDocItem -P:DefaultDocumentation.Models.Parameters.ParameterDocItem.Parameter|ParameterDocItem.Parameter.md|Parameter +T:DefaultDocumentation.Models.Types.ClassDocItem|DefaultDocumentation/Models/Types/ClassDocItem/index.md|ClassDocItem +P:DefaultDocumentation.Models.Types.DelegateDocItem.InvokeMethod|DefaultDocumentation/Models/Types/DelegateDocItem/InvokeMethod.md|InvokeMethod +P:DefaultDocumentation.Models.Types.DelegateDocItem.Parameters|DefaultDocumentation/Models/Types/DelegateDocItem/Parameters.md|Parameters +M:DefaultDocumentation.Models.Types.DelegateDocItem.#ctor(DefaultDocumentation.Models.DocItem,ICSharpCode.Decompiler.TypeSystem.ITypeDefinition,System.Xml.Linq.XElement)|DefaultDocumentation/Models/Types/DelegateDocItem/DelegateDocItem(DocItem,ITypeDefinition,XElement).md|DelegateDocItem(DocItem, ITypeDefinition, XElement) +T:DefaultDocumentation.Models.Types.DelegateDocItem|DefaultDocumentation/Models/Types/DelegateDocItem/index.md|DelegateDocItem +M:DefaultDocumentation.Models.Types.EnumDocItem.#ctor(DefaultDocumentation.Models.DocItem,ICSharpCode.Decompiler.TypeSystem.ITypeDefinition,System.Xml.Linq.XElement)|DefaultDocumentation/Models/Types/EnumDocItem/EnumDocItem(DocItem,ITypeDefinition,XElement).md|EnumDocItem(DocItem, ITypeDefinition, XElement) +T:DefaultDocumentation.Models.Types.EnumDocItem|DefaultDocumentation/Models/Types/EnumDocItem/index.md|EnumDocItem +M:DefaultDocumentation.Models.Types.InterfaceDocItem.#ctor(DefaultDocumentation.Models.DocItem,ICSharpCode.Decompiler.TypeSystem.ITypeDefinition,System.Xml.Linq.XElement)|DefaultDocumentation/Models/Types/InterfaceDocItem/InterfaceDocItem(DocItem,ITypeDefinition,XElement).md|InterfaceDocItem(DocItem, ITypeDefinition, XElement) +T:DefaultDocumentation.Models.Types.InterfaceDocItem|DefaultDocumentation/Models/Types/InterfaceDocItem/index.md|InterfaceDocItem +M:DefaultDocumentation.Models.Types.StructDocItem.#ctor(DefaultDocumentation.Models.DocItem,ICSharpCode.Decompiler.TypeSystem.ITypeDefinition,System.Xml.Linq.XElement)|DefaultDocumentation/Models/Types/StructDocItem/StructDocItem(DocItem,ITypeDefinition,XElement).md|StructDocItem(DocItem, ITypeDefinition, XElement) +T:DefaultDocumentation.Models.Types.StructDocItem|DefaultDocumentation/Models/Types/StructDocItem/index.md|StructDocItem +P:DefaultDocumentation.Models.Types.TypeDocItem.Type|DefaultDocumentation/Models/Types/TypeDocItem/Type.md|Type +P:DefaultDocumentation.Models.Types.TypeDocItem.TypeParameters|DefaultDocumentation/Models/Types/TypeDocItem/TypeParameters.md|TypeParameters +T:DefaultDocumentation.Models.Types.TypeDocItem|DefaultDocumentation/Models/Types/TypeDocItem/index.md|TypeDocItem +P:DefaultDocumentation.Models.Parameters.ParameterDocItem.Parameter|DefaultDocumentation/Models/Parameters/ParameterDocItem/Parameter.md|Parameter N:DefaultDocumentation.Models.Parameters|index.md#DefaultDocumentation.Models.Parameters|DefaultDocumentation.Models.Parameters -T:DefaultDocumentation.Models.Parameters.ParameterDocItem|ParameterDocItem.md|ParameterDocItem -P:DefaultDocumentation.Models.Parameters.TypeParameterDocItem.TypeParameter|TypeParameterDocItem.TypeParameter.md|TypeParameter -T:DefaultDocumentation.Models.Parameters.TypeParameterDocItem|TypeParameterDocItem.md|TypeParameterDocItem -P:DefaultDocumentation.Models.Members.ConstructorDocItem.Method|ConstructorDocItem.Method.md|Method -P:DefaultDocumentation.Models.Members.ConstructorDocItem.Parameters|ConstructorDocItem.Parameters.md|Parameters -M:DefaultDocumentation.Models.Members.ConstructorDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,ICSharpCode.Decompiler.TypeSystem.IMethod,System.Xml.Linq.XElement)|ConstructorDocItem.ConstructorDocItem(TypeDocItem,IMethod,XElement).md|ConstructorDocItem(TypeDocItem, IMethod, XElement) +T:DefaultDocumentation.Models.Parameters.ParameterDocItem|DefaultDocumentation/Models/Parameters/ParameterDocItem/index.md|ParameterDocItem +P:DefaultDocumentation.Models.Parameters.TypeParameterDocItem.TypeParameter|DefaultDocumentation/Models/Parameters/TypeParameterDocItem/TypeParameter.md|TypeParameter +T:DefaultDocumentation.Models.Parameters.TypeParameterDocItem|DefaultDocumentation/Models/Parameters/TypeParameterDocItem/index.md|TypeParameterDocItem +P:DefaultDocumentation.Models.Members.ConstructorDocItem.Method|DefaultDocumentation/Models/Members/ConstructorDocItem/Method.md|Method +P:DefaultDocumentation.Models.Members.ConstructorDocItem.Parameters|DefaultDocumentation/Models/Members/ConstructorDocItem/Parameters.md|Parameters +M:DefaultDocumentation.Models.Members.ConstructorDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,ICSharpCode.Decompiler.TypeSystem.IMethod,System.Xml.Linq.XElement)|DefaultDocumentation/Models/Members/ConstructorDocItem/ConstructorDocItem(TypeDocItem,IMethod,XElement).md|ConstructorDocItem(TypeDocItem, IMethod, XElement) N:DefaultDocumentation.Models.Members|index.md#DefaultDocumentation.Models.Members|DefaultDocumentation.Models.Members -T:DefaultDocumentation.Models.Members.ConstructorDocItem|ConstructorDocItem.md|ConstructorDocItem -P:DefaultDocumentation.Models.Members.EnumFieldDocItem.Field|EnumFieldDocItem.Field.md|Field -M:DefaultDocumentation.Models.Members.EnumFieldDocItem.#ctor(DefaultDocumentation.Models.Types.EnumDocItem,ICSharpCode.Decompiler.TypeSystem.IField,System.Xml.Linq.XElement)|EnumFieldDocItem.EnumFieldDocItem(EnumDocItem,IField,XElement).md|EnumFieldDocItem(EnumDocItem, IField, XElement) -T:DefaultDocumentation.Models.Members.EnumFieldDocItem|EnumFieldDocItem.md|EnumFieldDocItem -P:DefaultDocumentation.Models.Members.EventDocItem.Event|EventDocItem.Event.md|Event -M:DefaultDocumentation.Models.Members.EventDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,ICSharpCode.Decompiler.TypeSystem.IEvent,System.Xml.Linq.XElement)|EventDocItem.EventDocItem(TypeDocItem,IEvent,XElement).md|EventDocItem(TypeDocItem, IEvent, XElement) -T:DefaultDocumentation.Models.Members.EventDocItem|EventDocItem.md|EventDocItem -P:DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.Member|ExplicitInterfaceImplementationDocItem.Member.md|Member -P:DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.TypeParameters|ExplicitInterfaceImplementationDocItem.TypeParameters.md|TypeParameters -P:DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.Parameters|ExplicitInterfaceImplementationDocItem.Parameters.md|Parameters -M:DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,ICSharpCode.Decompiler.TypeSystem.IEvent,System.Xml.Linq.XElement)|ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(TypeDocItem,IEvent,XElement).md|ExplicitInterfaceImplementationDocItem(TypeDocItem, IEvent, XElement) -M:DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,ICSharpCode.Decompiler.TypeSystem.IProperty,System.Xml.Linq.XElement)|ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(TypeDocItem,IProperty,XElement).md|ExplicitInterfaceImplementationDocItem(TypeDocItem, IProperty, XElement) -M:DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,ICSharpCode.Decompiler.TypeSystem.IMethod,System.Xml.Linq.XElement)|ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(TypeDocItem,IMethod,XElement).md|ExplicitInterfaceImplementationDocItem(TypeDocItem, IMethod, XElement) -T:DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem|ExplicitInterfaceImplementationDocItem.md|ExplicitInterfaceImplementationDocItem -P:DefaultDocumentation.Models.Members.FieldDocItem.Field|FieldDocItem.Field.md|Field -M:DefaultDocumentation.Models.Members.FieldDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,ICSharpCode.Decompiler.TypeSystem.IField,System.Xml.Linq.XElement)|FieldDocItem.FieldDocItem(TypeDocItem,IField,XElement).md|FieldDocItem(TypeDocItem, IField, XElement) -T:DefaultDocumentation.Models.Members.FieldDocItem|FieldDocItem.md|FieldDocItem -P:DefaultDocumentation.Models.Members.MethodDocItem.Method|MethodDocItem.Method.md|Method -P:DefaultDocumentation.Models.Members.MethodDocItem.TypeParameters|MethodDocItem.TypeParameters.md|TypeParameters -P:DefaultDocumentation.Models.Members.MethodDocItem.Parameters|MethodDocItem.Parameters.md|Parameters -M:DefaultDocumentation.Models.Members.MethodDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,ICSharpCode.Decompiler.TypeSystem.IMethod,System.Xml.Linq.XElement)|MethodDocItem.MethodDocItem(TypeDocItem,IMethod,XElement).md|MethodDocItem(TypeDocItem, IMethod, XElement) -T:DefaultDocumentation.Models.Members.MethodDocItem|MethodDocItem.md|MethodDocItem -P:DefaultDocumentation.Models.Members.OperatorDocItem.Method|OperatorDocItem.Method.md|Method -P:DefaultDocumentation.Models.Members.OperatorDocItem.Parameters|OperatorDocItem.Parameters.md|Parameters -M:DefaultDocumentation.Models.Members.OperatorDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,ICSharpCode.Decompiler.TypeSystem.IMethod,System.Xml.Linq.XElement)|OperatorDocItem.OperatorDocItem(TypeDocItem,IMethod,XElement).md|OperatorDocItem(TypeDocItem, IMethod, XElement) -T:DefaultDocumentation.Models.Members.OperatorDocItem|OperatorDocItem.md|OperatorDocItem -P:DefaultDocumentation.Models.Members.PropertyDocItem.Property|PropertyDocItem.Property.md|Property -P:DefaultDocumentation.Models.Members.PropertyDocItem.Parameters|PropertyDocItem.Parameters.md|Parameters -M:DefaultDocumentation.Models.Members.PropertyDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,ICSharpCode.Decompiler.TypeSystem.IProperty,System.Xml.Linq.XElement)|PropertyDocItem.PropertyDocItem(TypeDocItem,IProperty,XElement).md|PropertyDocItem(TypeDocItem, IProperty, XElement) -T:DefaultDocumentation.Models.Members.PropertyDocItem|PropertyDocItem.md|PropertyDocItem -P:DefaultDocumentation.Api.IElement.Name|IElement.Name.md|Name -M:DefaultDocumentation.Api.IElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|IElement.Write(IWriter,XElement).md|Write(IWriter, XElement) +T:DefaultDocumentation.Models.Members.ConstructorDocItem|DefaultDocumentation/Models/Members/ConstructorDocItem/index.md|ConstructorDocItem +P:DefaultDocumentation.Models.Members.EnumFieldDocItem.Field|DefaultDocumentation/Models/Members/EnumFieldDocItem/Field.md|Field +M:DefaultDocumentation.Models.Members.EnumFieldDocItem.#ctor(DefaultDocumentation.Models.Types.EnumDocItem,ICSharpCode.Decompiler.TypeSystem.IField,System.Xml.Linq.XElement)|DefaultDocumentation/Models/Members/EnumFieldDocItem/EnumFieldDocItem(EnumDocItem,IField,XElement).md|EnumFieldDocItem(EnumDocItem, IField, XElement) +T:DefaultDocumentation.Models.Members.EnumFieldDocItem|DefaultDocumentation/Models/Members/EnumFieldDocItem/index.md|EnumFieldDocItem +P:DefaultDocumentation.Models.Members.EventDocItem.Event|DefaultDocumentation/Models/Members/EventDocItem/Event.md|Event +M:DefaultDocumentation.Models.Members.EventDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,ICSharpCode.Decompiler.TypeSystem.IEvent,System.Xml.Linq.XElement)|DefaultDocumentation/Models/Members/EventDocItem/EventDocItem(TypeDocItem,IEvent,XElement).md|EventDocItem(TypeDocItem, IEvent, XElement) +T:DefaultDocumentation.Models.Members.EventDocItem|DefaultDocumentation/Models/Members/EventDocItem/index.md|EventDocItem +P:DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.Member|DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/Member.md|Member +P:DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.TypeParameters|DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/TypeParameters.md|TypeParameters +P:DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.Parameters|DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/Parameters.md|Parameters +M:DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,ICSharpCode.Decompiler.TypeSystem.IEvent,System.Xml.Linq.XElement)|DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/ExplicitInterfaceImplementationDocItem.md#DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem,IEvent,System.Xml.Linq.XElement)|ExplicitInterfaceImplementationDocItem(TypeDocItem, IEvent, XElement) +M:DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,ICSharpCode.Decompiler.TypeSystem.IProperty,System.Xml.Linq.XElement)|DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/ExplicitInterfaceImplementationDocItem.md#DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem,IProperty,System.Xml.Linq.XElement)|ExplicitInterfaceImplementationDocItem(TypeDocItem, IProperty, XElement) +M:DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,ICSharpCode.Decompiler.TypeSystem.IMethod,System.Xml.Linq.XElement)|DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/ExplicitInterfaceImplementationDocItem.md#DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem,IMethod,System.Xml.Linq.XElement)|ExplicitInterfaceImplementationDocItem(TypeDocItem, IMethod, XElement) +T:DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem|DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/index.md|ExplicitInterfaceImplementationDocItem +P:DefaultDocumentation.Models.Members.FieldDocItem.Field|DefaultDocumentation/Models/Members/FieldDocItem/Field.md|Field +M:DefaultDocumentation.Models.Members.FieldDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,ICSharpCode.Decompiler.TypeSystem.IField,System.Xml.Linq.XElement)|DefaultDocumentation/Models/Members/FieldDocItem/FieldDocItem(TypeDocItem,IField,XElement).md|FieldDocItem(TypeDocItem, IField, XElement) +T:DefaultDocumentation.Models.Members.FieldDocItem|DefaultDocumentation/Models/Members/FieldDocItem/index.md|FieldDocItem +P:DefaultDocumentation.Models.Members.MethodDocItem.Method|DefaultDocumentation/Models/Members/MethodDocItem/Method.md|Method +P:DefaultDocumentation.Models.Members.MethodDocItem.TypeParameters|DefaultDocumentation/Models/Members/MethodDocItem/TypeParameters.md|TypeParameters +P:DefaultDocumentation.Models.Members.MethodDocItem.Parameters|DefaultDocumentation/Models/Members/MethodDocItem/Parameters.md|Parameters +M:DefaultDocumentation.Models.Members.MethodDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,ICSharpCode.Decompiler.TypeSystem.IMethod,System.Xml.Linq.XElement)|DefaultDocumentation/Models/Members/MethodDocItem/MethodDocItem(TypeDocItem,IMethod,XElement).md|MethodDocItem(TypeDocItem, IMethod, XElement) +T:DefaultDocumentation.Models.Members.MethodDocItem|DefaultDocumentation/Models/Members/MethodDocItem/index.md|MethodDocItem +P:DefaultDocumentation.Models.Members.OperatorDocItem.Method|DefaultDocumentation/Models/Members/OperatorDocItem/Method.md|Method +P:DefaultDocumentation.Models.Members.OperatorDocItem.Parameters|DefaultDocumentation/Models/Members/OperatorDocItem/Parameters.md|Parameters +M:DefaultDocumentation.Models.Members.OperatorDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,ICSharpCode.Decompiler.TypeSystem.IMethod,System.Xml.Linq.XElement)|DefaultDocumentation/Models/Members/OperatorDocItem/OperatorDocItem(TypeDocItem,IMethod,XElement).md|OperatorDocItem(TypeDocItem, IMethod, XElement) +T:DefaultDocumentation.Models.Members.OperatorDocItem|DefaultDocumentation/Models/Members/OperatorDocItem/index.md|OperatorDocItem +P:DefaultDocumentation.Models.Members.PropertyDocItem.Property|DefaultDocumentation/Models/Members/PropertyDocItem/Property.md|Property +P:DefaultDocumentation.Models.Members.PropertyDocItem.Parameters|DefaultDocumentation/Models/Members/PropertyDocItem/Parameters.md|Parameters +M:DefaultDocumentation.Models.Members.PropertyDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,ICSharpCode.Decompiler.TypeSystem.IProperty,System.Xml.Linq.XElement)|DefaultDocumentation/Models/Members/PropertyDocItem/PropertyDocItem(TypeDocItem,IProperty,XElement).md|PropertyDocItem(TypeDocItem, IProperty, XElement) +T:DefaultDocumentation.Models.Members.PropertyDocItem|DefaultDocumentation/Models/Members/PropertyDocItem/index.md|PropertyDocItem +P:DefaultDocumentation.Api.IDocItemGenerator.Name|DefaultDocumentation/Api/IDocItemGenerator/Name.md|Name +M:DefaultDocumentation.Api.IDocItemGenerator.Generate(DefaultDocumentation.IDocItemsContext)|DefaultDocumentation/Api/IDocItemGenerator/Generate(IDocItemsContext).md|Generate(IDocItemsContext) N:DefaultDocumentation.Api|index.md#DefaultDocumentation.Api|DefaultDocumentation.Api -T:DefaultDocumentation.Api.IElement|IElement.md|IElement -P:DefaultDocumentation.Api.IFileNameFactory.Name|IFileNameFactory.Name.md|Name -M:DefaultDocumentation.Api.IFileNameFactory.Clean(DefaultDocumentation.IGeneralContext)|IFileNameFactory.Clean(IGeneralContext).md|Clean(IGeneralContext) -M:DefaultDocumentation.Api.IFileNameFactory.GetFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|IFileNameFactory.GetFileName(IGeneralContext,DocItem).md|GetFileName(IGeneralContext, DocItem) -T:DefaultDocumentation.Api.IFileNameFactory|IFileNameFactory.md|IFileNameFactory -P:DefaultDocumentation.Api.ISection.Name|ISection.Name.md|Name -M:DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)|ISection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Api.ISection|ISection.md|ISection -P:DefaultDocumentation.Api.IUrlFactory.Name|IUrlFactory.Name.md|Name -M:DefaultDocumentation.Api.IUrlFactory.GetUrl(DefaultDocumentation.IGeneralContext,System.String)|IUrlFactory.GetUrl(IGeneralContext,string).md|GetUrl(IGeneralContext, string) -T:DefaultDocumentation.Api.IUrlFactory|IUrlFactory.md|IUrlFactory -P:DefaultDocumentation.Api.IWriter.Context|IWriter.Context.md|Context -P:DefaultDocumentation.Api.IWriter.DocItem|IWriter.DocItem.md|DocItem -P:DefaultDocumentation.Api.IWriter.Length|IWriter.Length.md|Length -P:DefaultDocumentation.Api.IWriter.Item(System.String)|IWriter.this[string].md|this[string] -M:DefaultDocumentation.Api.IWriter.Append(System.String)|IWriter.Append(string).md|Append(string) -M:DefaultDocumentation.Api.IWriter.AppendLine|IWriter.AppendLine().md|AppendLine() -M:DefaultDocumentation.Api.IWriter.EndsWith(System.String)|IWriter.EndsWith(string).md|EndsWith(string) -T:DefaultDocumentation.Api.IWriter|IWriter.md|IWriter -M:DefaultDocumentation.Api.IWriterExtension.Append(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|IWriterExtension.Append(thisIWriter,XElement).md|Append(this IWriter, XElement) -M:DefaultDocumentation.Api.IWriterExtension.AppendLine(DefaultDocumentation.Api.IWriter,System.String)|IWriterExtension.AppendLine(thisIWriter,string).md|AppendLine(this IWriter, string) -M:DefaultDocumentation.Api.IWriterExtension.TrimEnd(DefaultDocumentation.Api.IWriter,System.String[])|IWriterExtension.TrimEnd(thisIWriter,string[]).md|TrimEnd(this IWriter, string[]) -T:DefaultDocumentation.Api.IWriterExtension|IWriterExtension.md|IWriterExtension +T:DefaultDocumentation.Api.IDocItemGenerator|DefaultDocumentation/Api/IDocItemGenerator/index.md|IDocItemGenerator +P:DefaultDocumentation.Api.IElement.Name|DefaultDocumentation/Api/IElement/Name.md|Name +M:DefaultDocumentation.Api.IElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|DefaultDocumentation/Api/IElement/Write(IWriter,XElement).md|Write(IWriter, XElement) +T:DefaultDocumentation.Api.IElement|DefaultDocumentation/Api/IElement/index.md|IElement +P:DefaultDocumentation.Api.IFileNameFactory.Name|DefaultDocumentation/Api/IFileNameFactory/Name.md|Name +M:DefaultDocumentation.Api.IFileNameFactory.Clean(DefaultDocumentation.IGeneralContext)|DefaultDocumentation/Api/IFileNameFactory/Clean(IGeneralContext).md|Clean(IGeneralContext) +M:DefaultDocumentation.Api.IFileNameFactory.GetFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Api/IFileNameFactory/GetFileName(IGeneralContext,DocItem).md|GetFileName(IGeneralContext, DocItem) +T:DefaultDocumentation.Api.IFileNameFactory|DefaultDocumentation/Api/IFileNameFactory/index.md|IFileNameFactory +P:DefaultDocumentation.Api.ISection.Name|DefaultDocumentation/Api/ISection/Name.md|Name +M:DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Api/ISection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Api.ISection|DefaultDocumentation/Api/ISection/index.md|ISection +P:DefaultDocumentation.Api.IUrlFactory.Name|DefaultDocumentation/Api/IUrlFactory/Name.md|Name +M:DefaultDocumentation.Api.IUrlFactory.GetUrl(DefaultDocumentation.IPageContext,System.String)|DefaultDocumentation/Api/IUrlFactory/GetUrl(IPageContext,string).md|GetUrl(IPageContext, string) +T:DefaultDocumentation.Api.IUrlFactory|DefaultDocumentation/Api/IUrlFactory/index.md|IUrlFactory +P:DefaultDocumentation.Api.IWriter.Context|DefaultDocumentation/Api/IWriter/Context.md|Context +P:DefaultDocumentation.Api.IWriter.Length|DefaultDocumentation/Api/IWriter/Length.md|Length +M:DefaultDocumentation.Api.IWriter.Append(System.String)|DefaultDocumentation/Api/IWriter/Append(string).md|Append(string) +M:DefaultDocumentation.Api.IWriter.AppendLine|DefaultDocumentation/Api/IWriter/AppendLine().md|AppendLine() +M:DefaultDocumentation.Api.IWriter.EndsWith(System.String)|DefaultDocumentation/Api/IWriter/EndsWith(string).md|EndsWith(string) +T:DefaultDocumentation.Api.IWriter|DefaultDocumentation/Api/IWriter/index.md|IWriter +M:DefaultDocumentation.Api.IWriterExtensions.Append(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|DefaultDocumentation/Api/IWriterExtensions/Append(thisIWriter,XElement).md|Append(this IWriter, XElement) +M:DefaultDocumentation.Api.IWriterExtensions.AppendFormat(DefaultDocumentation.Api.IWriter,System.String,System.Object[])|DefaultDocumentation/Api/IWriterExtensions/AppendFormat(thisIWriter,string,object[]).md|AppendFormat(this IWriter, string, object[]) +M:DefaultDocumentation.Api.IWriterExtensions.AppendLine(DefaultDocumentation.Api.IWriter,System.String)|DefaultDocumentation/Api/IWriterExtensions/AppendLine(thisIWriter,string).md|AppendLine(this IWriter, string) +M:DefaultDocumentation.Api.IWriterExtensions.TrimEnd(DefaultDocumentation.Api.IWriter,System.String[])|DefaultDocumentation/Api/IWriterExtensions/TrimEnd(thisIWriter,string[]).md|TrimEnd(this IWriter, string[]) +T:DefaultDocumentation.Api.IWriterExtensions|DefaultDocumentation/Api/IWriterExtensions/index.md|IWriterExtensions +M:DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem|DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/ExplicitInterfaceImplementationDocItem.md|ExplicitInterfaceImplementationDocItem +M:DefaultDocumentation.IGeneralContextExtensions.GetSetting|DefaultDocumentation/IGeneralContextExtensions/GetSetting.md|GetSetting +M:DefaultDocumentation.IPageContextExtensions.GetUrl|DefaultDocumentation/IPageContextExtensions/GetUrl.md|GetUrl +M:DefaultDocumentation.IDocItemsContext.GetSetting|DefaultDocumentation/IDocItemsContext/GetSetting.md|GetSetting diff --git a/documentation/DefaultDocumentation.Markdown.txt b/documentation/DefaultDocumentation.Markdown.txt index 744e3392..0247cf16 100644 --- a/documentation/DefaultDocumentation.Markdown.txt +++ b/documentation/DefaultDocumentation.Markdown.txt @@ -1,251 +1,317 @@ https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/markdown/ -M:DefaultDocumentation.IGeneralContextExtension.GetNestedTypeVisibilities(DefaultDocumentation.IGeneralContext,System.Type)|IGeneralContextExtension.GetNestedTypeVisibilities(thisIGeneralContext,Type).md|GetNestedTypeVisibilities(this IGeneralContext, Type) -M:DefaultDocumentation.IGeneralContextExtension.GetRemoveFileExtensionFromUrl(DefaultDocumentation.IGeneralContext)|IGeneralContextExtension.GetRemoveFileExtensionFromUrl(thisIGeneralContext).md|GetRemoveFileExtensionFromUrl(this IGeneralContext) -M:DefaultDocumentation.IGeneralContextExtension.GetInvalidCharReplacement(DefaultDocumentation.IGeneralContext)|IGeneralContextExtension.GetInvalidCharReplacement(thisIGeneralContext).md|GetInvalidCharReplacement(this IGeneralContext) -M:DefaultDocumentation.IGeneralContextExtension.GetChildren``1(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|IGeneralContextExtension.GetChildren_T_(thisIGeneralContext,DocItem).md|GetChildren(this IGeneralContext, DocItem) +M:DefaultDocumentation.IGeneralContextExtensions.GetNestedTypeVisibilities(DefaultDocumentation.IGeneralContext,System.Type)|DefaultDocumentation/IGeneralContextExtensions/GetNestedTypeVisibilities(thisIGeneralContext,Type).md|GetNestedTypeVisibilities(this IGeneralContext, Type) +M:DefaultDocumentation.IGeneralContextExtensions.GetRemoveFileExtensionFromUrl(DefaultDocumentation.IGeneralContext)|DefaultDocumentation/IGeneralContextExtensions/GetRemoveFileExtensionFromUrl(thisIGeneralContext).md|GetRemoveFileExtensionFromUrl(this IGeneralContext) +M:DefaultDocumentation.IGeneralContextExtensions.GetInvalidCharReplacement(DefaultDocumentation.IGeneralContext)|DefaultDocumentation/IGeneralContextExtensions/GetInvalidCharReplacement(thisIGeneralContext).md|GetInvalidCharReplacement(this IGeneralContext) +M:DefaultDocumentation.IGeneralContextExtensions.GetUseFullUrl(DefaultDocumentation.IGeneralContext)|DefaultDocumentation/IGeneralContextExtensions/GetUseFullUrl(thisIGeneralContext).md|GetUseFullUrl(this IGeneralContext) +M:DefaultDocumentation.IGeneralContextExtensions.GetChildren``1(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/IGeneralContextExtensions/GetChildren_T_(thisIGeneralContext,DocItem).md|GetChildren(this IGeneralContext, DocItem) N:DefaultDocumentation|index.md#DefaultDocumentation|DefaultDocumentation -T:DefaultDocumentation.IGeneralContextExtension|IGeneralContextExtension.md|IGeneralContextExtension -F:DefaultDocumentation.NestedTypeVisibilities.Default|NestedTypeVisibilities.md#DefaultDocumentation.NestedTypeVisibilities.Default|Default -F:DefaultDocumentation.NestedTypeVisibilities.Namespace|NestedTypeVisibilities.md#DefaultDocumentation.NestedTypeVisibilities.Namespace|Namespace -F:DefaultDocumentation.NestedTypeVisibilities.DeclaringType|NestedTypeVisibilities.md#DefaultDocumentation.NestedTypeVisibilities.DeclaringType|DeclaringType -T:DefaultDocumentation.NestedTypeVisibilities|NestedTypeVisibilities.md|NestedTypeVisibilities -M:DefaultDocumentation.Models.DocItemExtension.GetLongName(DefaultDocumentation.Models.DocItem)|DocItemExtension.GetLongName(thisDocItem).md|GetLongName(this DocItem) +T:DefaultDocumentation.IGeneralContextExtensions|DefaultDocumentation/IGeneralContextExtensions/index.md|IGeneralContextExtensions +M:DefaultDocumentation.Api.IWriterExtensions.GetCurrentItem(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Api/IWriterExtensions/GetCurrentItem(thisIWriter).md|GetCurrentItem(this IWriter) +M:DefaultDocumentation.Api.IWriterExtensions.SetCurrentItem(DefaultDocumentation.Api.IWriter,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Api/IWriterExtensions/SetCurrentItem(thisIWriter,DocItem).md|SetCurrentItem(this IWriter, DocItem) +M:DefaultDocumentation.Api.IWriterExtensions.GetDisplayAsSingleLine(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Api/IWriterExtensions/GetDisplayAsSingleLine(thisIWriter).md|GetDisplayAsSingleLine(this IWriter) +M:DefaultDocumentation.Api.IWriterExtensions.SetDisplayAsSingleLine(DefaultDocumentation.Api.IWriter,System.Nullable{System.Boolean})|DefaultDocumentation/Api/IWriterExtensions/SetDisplayAsSingleLine(thisIWriter,Nullable_bool_).md|SetDisplayAsSingleLine(this IWriter, Nullable) +M:DefaultDocumentation.Api.IWriterExtensions.GetHandleLineBreak(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Api/IWriterExtensions/GetHandleLineBreak(thisIWriter).md|GetHandleLineBreak(this IWriter) +M:DefaultDocumentation.Api.IWriterExtensions.SetHandleLineBreak(DefaultDocumentation.Api.IWriter,System.Nullable{System.Boolean})|DefaultDocumentation/Api/IWriterExtensions/SetHandleLineBreak(thisIWriter,Nullable_bool_).md|SetHandleLineBreak(this IWriter, Nullable) +M:DefaultDocumentation.Api.IWriterExtensions.GetRenderAsRaw(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Api/IWriterExtensions/GetRenderAsRaw(thisIWriter).md|GetRenderAsRaw(this IWriter) +M:DefaultDocumentation.Api.IWriterExtensions.SetRenderAsRaw(DefaultDocumentation.Api.IWriter,System.Nullable{System.Boolean})|DefaultDocumentation/Api/IWriterExtensions/SetRenderAsRaw(thisIWriter,Nullable_bool_).md|SetRenderAsRaw(this IWriter, Nullable) +M:DefaultDocumentation.Api.IWriterExtensions.GetUrlFormat(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Api/IWriterExtensions/GetUrlFormat(thisIWriter).md|GetUrlFormat(this IWriter) +M:DefaultDocumentation.Api.IWriterExtensions.SetUrlFormat(DefaultDocumentation.Api.IWriter,System.String)|DefaultDocumentation/Api/IWriterExtensions/SetUrlFormat(thisIWriter,string).md|SetUrlFormat(this IWriter, string) +M:DefaultDocumentation.Api.IWriterExtensions.AppendAsRaw(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Api/IWriterExtensions/AppendAsRaw(thisIWriter).md|AppendAsRaw(this IWriter) +M:DefaultDocumentation.Api.IWriterExtensions.AppendUrl(DefaultDocumentation.Api.IWriter,System.String,System.String,System.String)|DefaultDocumentation/Api/IWriterExtensions/AppendUrl(thisIWriter,string,string,string).md|AppendUrl(this IWriter, string, string, string) +M:DefaultDocumentation.Api.IWriterExtensions.AppendLink(DefaultDocumentation.Api.IWriter,DefaultDocumentation.Models.DocItem,System.String)|DefaultDocumentation/Api/IWriterExtensions/AppendLink.md#DefaultDocumentation.Api.IWriterExtensions.AppendLink(thisDefaultDocumentation.Api.IWriter,DefaultDocumentation.Models.DocItem,string)|AppendLink(this IWriter, DocItem, string) +M:DefaultDocumentation.Api.IWriterExtensions.AppendLink(DefaultDocumentation.Api.IWriter,System.String,System.String)|DefaultDocumentation/Api/IWriterExtensions/AppendLink.md#DefaultDocumentation.Api.IWriterExtensions.AppendLink(thisDefaultDocumentation.Api.IWriter,string,string)|AppendLink(this IWriter, string, string) +M:DefaultDocumentation.Api.IWriterExtensions.AppendLink(DefaultDocumentation.Api.IWriter,DefaultDocumentation.Models.DocItem,ICSharpCode.Decompiler.TypeSystem.INamedElement)|DefaultDocumentation/Api/IWriterExtensions/AppendLink.md#DefaultDocumentation.Api.IWriterExtensions.AppendLink(thisDefaultDocumentation.Api.IWriter,DefaultDocumentation.Models.DocItem,INamedElement)|AppendLink(this IWriter, DocItem, INamedElement) +M:DefaultDocumentation.Api.IWriterExtensions.EnsureLineStart(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Api/IWriterExtensions/EnsureLineStart(thisIWriter).md|EnsureLineStart(this IWriter) +M:DefaultDocumentation.Api.IWriterExtensions.EnsureLineStartAndAppendLine(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Api/IWriterExtensions/EnsureLineStartAndAppendLine(thisIWriter).md|EnsureLineStartAndAppendLine(this IWriter) +M:DefaultDocumentation.Api.IWriterExtensions.AppendAsMarkdown(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|DefaultDocumentation/Api/IWriterExtensions/AppendAsMarkdown(thisIWriter,XElement).md|AppendAsMarkdown(this IWriter, XElement) +M:DefaultDocumentation.Api.IWriterExtensions.ToPrefixedWriter(DefaultDocumentation.Api.IWriter,System.String)|DefaultDocumentation/Api/IWriterExtensions/ToPrefixedWriter(thisIWriter,string).md|ToPrefixedWriter(this IWriter, string) +M:DefaultDocumentation.Api.IWriterExtensions.ToOverrideWriter(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Api/IWriterExtensions/ToOverrideWriter(thisIWriter).md|ToOverrideWriter(this IWriter) +N:DefaultDocumentation.Api|index.md#DefaultDocumentation.Api|DefaultDocumentation.Api +T:DefaultDocumentation.Api.IWriterExtensions|DefaultDocumentation/Api/IWriterExtensions/index.md|IWriterExtensions +M:DefaultDocumentation.Models.DocItemExtensions.GetLongName(DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Models/DocItemExtensions/GetLongName(thisDocItem).md|GetLongName(this DocItem) N:DefaultDocumentation.Models|index.md#DefaultDocumentation.Models|DefaultDocumentation.Models -T:DefaultDocumentation.Models.DocItemExtension|DocItemExtension.md|DocItemExtension -P:DefaultDocumentation.Markdown.Writers.MarkdownWriter.Context|MarkdownWriter.Context.md|Context -P:DefaultDocumentation.Markdown.Writers.MarkdownWriter.DocItem|MarkdownWriter.DocItem.md|DocItem -P:DefaultDocumentation.Markdown.Writers.MarkdownWriter.Length|MarkdownWriter.Length.md|Length -P:DefaultDocumentation.Markdown.Writers.MarkdownWriter.Item(System.String)|MarkdownWriter.this[string].md|this[string] -M:DefaultDocumentation.Markdown.Writers.MarkdownWriter.#ctor(DefaultDocumentation.Api.IWriter)|MarkdownWriter.MarkdownWriter(IWriter).md|MarkdownWriter(IWriter) -M:DefaultDocumentation.Markdown.Writers.MarkdownWriter.Append(System.String)|MarkdownWriter.Append(string).md|Append(string) -M:DefaultDocumentation.Markdown.Writers.MarkdownWriter.AppendLine|MarkdownWriter.AppendLine().md|AppendLine() -M:DefaultDocumentation.Markdown.Writers.MarkdownWriter.EndsWith(System.String)|MarkdownWriter.EndsWith(string).md|EndsWith(string) +T:DefaultDocumentation.Models.DocItemExtensions|DefaultDocumentation/Models/DocItemExtensions/index.md|DocItemExtensions +F:DefaultDocumentation.Markdown.NestedTypeVisibilities.Default|DefaultDocumentation/Markdown/NestedTypeVisibilities/index.md#DefaultDocumentation.Markdown.NestedTypeVisibilities.Default|Default +F:DefaultDocumentation.Markdown.NestedTypeVisibilities.Namespace|DefaultDocumentation/Markdown/NestedTypeVisibilities/index.md#DefaultDocumentation.Markdown.NestedTypeVisibilities.Namespace|Namespace +F:DefaultDocumentation.Markdown.NestedTypeVisibilities.DeclaringType|DefaultDocumentation/Markdown/NestedTypeVisibilities/index.md#DefaultDocumentation.Markdown.NestedTypeVisibilities.DeclaringType|DeclaringType +N:DefaultDocumentation.Markdown|index.md#DefaultDocumentation.Markdown|DefaultDocumentation.Markdown +T:DefaultDocumentation.Markdown.NestedTypeVisibilities|DefaultDocumentation/Markdown/NestedTypeVisibilities/index.md|NestedTypeVisibilities +P:DefaultDocumentation.Markdown.Writers.MarkdownWriter.Context|DefaultDocumentation/Markdown/Writers/MarkdownWriter/Context.md|Context +P:DefaultDocumentation.Markdown.Writers.MarkdownWriter.Length|DefaultDocumentation/Markdown/Writers/MarkdownWriter/Length.md|Length +M:DefaultDocumentation.Markdown.Writers.MarkdownWriter.#ctor(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Writers/MarkdownWriter/MarkdownWriter(IWriter).md|MarkdownWriter(IWriter) +M:DefaultDocumentation.Markdown.Writers.MarkdownWriter.Append(System.String)|DefaultDocumentation/Markdown/Writers/MarkdownWriter/Append(string).md|Append(string) +M:DefaultDocumentation.Markdown.Writers.MarkdownWriter.AppendLine|DefaultDocumentation/Markdown/Writers/MarkdownWriter/AppendLine().md|AppendLine() +M:DefaultDocumentation.Markdown.Writers.MarkdownWriter.EndsWith(System.String)|DefaultDocumentation/Markdown/Writers/MarkdownWriter/EndsWith(string).md|EndsWith(string) N:DefaultDocumentation.Markdown.Writers|index.md#DefaultDocumentation.Markdown.Writers|DefaultDocumentation.Markdown.Writers -T:DefaultDocumentation.Markdown.Writers.MarkdownWriter|MarkdownWriter.md|MarkdownWriter -P:DefaultDocumentation.Markdown.Writers.OverrideWriter.Context|OverrideWriter.Context.md|Context -P:DefaultDocumentation.Markdown.Writers.OverrideWriter.DocItem|OverrideWriter.DocItem.md|DocItem -P:DefaultDocumentation.Markdown.Writers.OverrideWriter.Length|OverrideWriter.Length.md|Length -P:DefaultDocumentation.Markdown.Writers.OverrideWriter.Item(System.String)|OverrideWriter.this[string].md|this[string] -M:DefaultDocumentation.Markdown.Writers.OverrideWriter.#ctor(DefaultDocumentation.Api.IWriter)|OverrideWriter.OverrideWriter(IWriter).md|OverrideWriter(IWriter) -M:DefaultDocumentation.Markdown.Writers.OverrideWriter.Append(System.String)|OverrideWriter.Append(string).md|Append(string) -M:DefaultDocumentation.Markdown.Writers.OverrideWriter.AppendLine|OverrideWriter.AppendLine().md|AppendLine() -M:DefaultDocumentation.Markdown.Writers.OverrideWriter.EndsWith(System.String)|OverrideWriter.EndsWith(string).md|EndsWith(string) -T:DefaultDocumentation.Markdown.Writers.OverrideWriter|OverrideWriter.md|OverrideWriter -P:DefaultDocumentation.Markdown.Writers.PrefixedWriter.Context|PrefixedWriter.Context.md|Context -P:DefaultDocumentation.Markdown.Writers.PrefixedWriter.DocItem|PrefixedWriter.DocItem.md|DocItem -P:DefaultDocumentation.Markdown.Writers.PrefixedWriter.Length|PrefixedWriter.Length.md|Length -P:DefaultDocumentation.Markdown.Writers.PrefixedWriter.Item(System.String)|PrefixedWriter.this[string].md|this[string] -M:DefaultDocumentation.Markdown.Writers.PrefixedWriter.#ctor(DefaultDocumentation.Api.IWriter,System.String)|PrefixedWriter.PrefixedWriter(IWriter,string).md|PrefixedWriter(IWriter, string) -M:DefaultDocumentation.Markdown.Writers.PrefixedWriter.Append(System.String)|PrefixedWriter.Append(string).md|Append(string) -M:DefaultDocumentation.Markdown.Writers.PrefixedWriter.AppendLine|PrefixedWriter.AppendLine().md|AppendLine() -M:DefaultDocumentation.Markdown.Writers.PrefixedWriter.EndsWith(System.String)|PrefixedWriter.EndsWith(string).md|EndsWith(string) -T:DefaultDocumentation.Markdown.Writers.PrefixedWriter|PrefixedWriter.md|PrefixedWriter -F:DefaultDocumentation.Markdown.UrlFactories.DocItemFactory.ConfigName|DocItemFactory.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.UrlFactories.DocItemFactory.Name|DocItemFactory.Name.md|Name -M:DefaultDocumentation.Markdown.UrlFactories.DocItemFactory.GetUrl(DefaultDocumentation.IGeneralContext,System.String)|DocItemFactory.GetUrl(IGeneralContext,string).md|GetUrl(IGeneralContext, string) +T:DefaultDocumentation.Markdown.Writers.MarkdownWriter|DefaultDocumentation/Markdown/Writers/MarkdownWriter/index.md|MarkdownWriter +P:DefaultDocumentation.Markdown.Writers.OverrideWriter.Context|DefaultDocumentation/Markdown/Writers/OverrideWriter/Context.md|Context +P:DefaultDocumentation.Markdown.Writers.OverrideWriter.Length|DefaultDocumentation/Markdown/Writers/OverrideWriter/Length.md|Length +M:DefaultDocumentation.Markdown.Writers.OverrideWriter.#ctor(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Writers/OverrideWriter/OverrideWriter(IWriter).md|OverrideWriter(IWriter) +M:DefaultDocumentation.Markdown.Writers.OverrideWriter.Append(System.String)|DefaultDocumentation/Markdown/Writers/OverrideWriter/Append(string).md|Append(string) +M:DefaultDocumentation.Markdown.Writers.OverrideWriter.AppendLine|DefaultDocumentation/Markdown/Writers/OverrideWriter/AppendLine().md|AppendLine() +M:DefaultDocumentation.Markdown.Writers.OverrideWriter.EndsWith(System.String)|DefaultDocumentation/Markdown/Writers/OverrideWriter/EndsWith(string).md|EndsWith(string) +T:DefaultDocumentation.Markdown.Writers.OverrideWriter|DefaultDocumentation/Markdown/Writers/OverrideWriter/index.md|OverrideWriter +P:DefaultDocumentation.Markdown.Writers.PrefixedWriter.Context|DefaultDocumentation/Markdown/Writers/PrefixedWriter/Context.md|Context +P:DefaultDocumentation.Markdown.Writers.PrefixedWriter.Length|DefaultDocumentation/Markdown/Writers/PrefixedWriter/Length.md|Length +M:DefaultDocumentation.Markdown.Writers.PrefixedWriter.#ctor(DefaultDocumentation.Api.IWriter,System.String)|DefaultDocumentation/Markdown/Writers/PrefixedWriter/PrefixedWriter(IWriter,string).md|PrefixedWriter(IWriter, string) +M:DefaultDocumentation.Markdown.Writers.PrefixedWriter.Append(System.String)|DefaultDocumentation/Markdown/Writers/PrefixedWriter/Append(string).md|Append(string) +M:DefaultDocumentation.Markdown.Writers.PrefixedWriter.AppendLine|DefaultDocumentation/Markdown/Writers/PrefixedWriter/AppendLine().md|AppendLine() +M:DefaultDocumentation.Markdown.Writers.PrefixedWriter.EndsWith(System.String)|DefaultDocumentation/Markdown/Writers/PrefixedWriter/EndsWith(string).md|EndsWith(string) +T:DefaultDocumentation.Markdown.Writers.PrefixedWriter|DefaultDocumentation/Markdown/Writers/PrefixedWriter/index.md|PrefixedWriter +F:DefaultDocumentation.Markdown.UrlFactories.DocItemFactory.ConfigName|DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.UrlFactories.DocItemFactory.Name|DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/Name.md|Name +M:DefaultDocumentation.Markdown.UrlFactories.DocItemFactory.GetUrl(DefaultDocumentation.IPageContext,System.String)|DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/GetUrl(IPageContext,string).md|GetUrl(IPageContext, string) N:DefaultDocumentation.Markdown.UrlFactories|index.md#DefaultDocumentation.Markdown.UrlFactories|DefaultDocumentation.Markdown.UrlFactories -T:DefaultDocumentation.Markdown.UrlFactories.DocItemFactory|DocItemFactory.md|DocItemFactory -F:DefaultDocumentation.Markdown.UrlFactories.DotnetApiFactory.ConfigName|DotnetApiFactory.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.UrlFactories.DotnetApiFactory.Name|DotnetApiFactory.Name.md|Name -M:DefaultDocumentation.Markdown.UrlFactories.DotnetApiFactory.GetUrl(DefaultDocumentation.IGeneralContext,System.String)|DotnetApiFactory.GetUrl(IGeneralContext,string).md|GetUrl(IGeneralContext, string) -T:DefaultDocumentation.Markdown.UrlFactories.DotnetApiFactory|DotnetApiFactory.md|DotnetApiFactory -P:DefaultDocumentation.Markdown.Sections.ChildrenSection`1.Name|ChildrenSection_T_.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.ChildrenSection`1.#ctor(System.String,System.String)|ChildrenSection_T_.ChildrenSection(string,string).md|ChildrenSection(string, string) -M:DefaultDocumentation.Markdown.Sections.ChildrenSection`1.GetChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|ChildrenSection_T_.GetChildren(IGeneralContext,DocItem).md|GetChildren(IGeneralContext, DocItem) -M:DefaultDocumentation.Markdown.Sections.ChildrenSection`1.Write(DefaultDocumentation.Api.IWriter)|ChildrenSection_T_.Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.UrlFactories.DocItemFactory|DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/index.md|DocItemFactory +F:DefaultDocumentation.Markdown.UrlFactories.DotnetApiFactory.ConfigName|DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.UrlFactories.DotnetApiFactory.Name|DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/Name.md|Name +M:DefaultDocumentation.Markdown.UrlFactories.DotnetApiFactory.GetUrl(DefaultDocumentation.IPageContext,System.String)|DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/GetUrl(IPageContext,string).md|GetUrl(IPageContext, string) +T:DefaultDocumentation.Markdown.UrlFactories.DotnetApiFactory|DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/index.md|DotnetApiFactory +P:DefaultDocumentation.Markdown.Sections.ChildrenSection`1.Name|DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.ChildrenSection`1.#ctor(System.String,System.String)|DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/ChildrenSection(string,string).md|ChildrenSection(string, string) +M:DefaultDocumentation.Markdown.Sections.ChildrenSection`1.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +M:DefaultDocumentation.Markdown.Sections.ChildrenSection`1.ShouldWriteTitle(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/ShouldWriteTitle(IGeneralContext,DocItem).md|ShouldWriteTitle(IGeneralContext, DocItem) +M:DefaultDocumentation.Markdown.Sections.ChildrenSection`1.GetChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/GetChildren(IGeneralContext,DocItem).md|GetChildren(IGeneralContext, DocItem) +M:DefaultDocumentation.Markdown.Sections.ChildrenSection`1.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/Write(IWriter).md|Write(IWriter) N:DefaultDocumentation.Markdown.Sections|index.md#DefaultDocumentation.Markdown.Sections|DefaultDocumentation.Markdown.Sections -T:DefaultDocumentation.Markdown.Sections.ChildrenSection`1|ChildrenSection_T_.md|ChildrenSection -F:DefaultDocumentation.Markdown.Sections.TypeParametersSection.ConfigName|TypeParametersSection.ConfigName.md|ConfigName -M:DefaultDocumentation.Markdown.Sections.TypeParametersSection.#ctor|TypeParametersSection.TypeParametersSection().md|TypeParametersSection() -M:DefaultDocumentation.Markdown.Sections.TypeParametersSection.GetChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|TypeParametersSection.GetChildren(IGeneralContext,DocItem).md|GetChildren(IGeneralContext, DocItem) -T:DefaultDocumentation.Markdown.Sections.TypeParametersSection|TypeParametersSection.md|TypeParametersSection -F:DefaultDocumentation.Markdown.Sections.ParametersSection.ConfigName|ParametersSection.ConfigName.md|ConfigName -M:DefaultDocumentation.Markdown.Sections.ParametersSection.#ctor|ParametersSection.ParametersSection().md|ParametersSection() -M:DefaultDocumentation.Markdown.Sections.ParametersSection.GetChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|ParametersSection.GetChildren(IGeneralContext,DocItem).md|GetChildren(IGeneralContext, DocItem) -T:DefaultDocumentation.Markdown.Sections.ParametersSection|ParametersSection.md|ParametersSection -F:DefaultDocumentation.Markdown.Sections.EnumFieldsSection.ConfigName|EnumFieldsSection.ConfigName.md|ConfigName -M:DefaultDocumentation.Markdown.Sections.EnumFieldsSection.#ctor|EnumFieldsSection.EnumFieldsSection().md|EnumFieldsSection() -T:DefaultDocumentation.Markdown.Sections.EnumFieldsSection|EnumFieldsSection.md|EnumFieldsSection -F:DefaultDocumentation.Markdown.Sections.ConstructorsSection.ConfigName|ConstructorsSection.ConfigName.md|ConfigName -M:DefaultDocumentation.Markdown.Sections.ConstructorsSection.#ctor|ConstructorsSection.ConstructorsSection().md|ConstructorsSection() -T:DefaultDocumentation.Markdown.Sections.ConstructorsSection|ConstructorsSection.md|ConstructorsSection -F:DefaultDocumentation.Markdown.Sections.FieldsSection.ConfigName|FieldsSection.ConfigName.md|ConfigName -M:DefaultDocumentation.Markdown.Sections.FieldsSection.#ctor|FieldsSection.FieldsSection().md|FieldsSection() -T:DefaultDocumentation.Markdown.Sections.FieldsSection|FieldsSection.md|FieldsSection -F:DefaultDocumentation.Markdown.Sections.PropertiesSection.ConfigName|PropertiesSection.ConfigName.md|ConfigName -M:DefaultDocumentation.Markdown.Sections.PropertiesSection.#ctor|PropertiesSection.PropertiesSection().md|PropertiesSection() -T:DefaultDocumentation.Markdown.Sections.PropertiesSection|PropertiesSection.md|PropertiesSection -F:DefaultDocumentation.Markdown.Sections.MethodsSection.ConfigName|MethodsSection.ConfigName.md|ConfigName -M:DefaultDocumentation.Markdown.Sections.MethodsSection.#ctor|MethodsSection.MethodsSection().md|MethodsSection() -T:DefaultDocumentation.Markdown.Sections.MethodsSection|MethodsSection.md|MethodsSection -F:DefaultDocumentation.Markdown.Sections.EventsSection.ConfigName|EventsSection.ConfigName.md|ConfigName -M:DefaultDocumentation.Markdown.Sections.EventsSection.#ctor|EventsSection.EventsSection().md|EventsSection() -T:DefaultDocumentation.Markdown.Sections.EventsSection|EventsSection.md|EventsSection -F:DefaultDocumentation.Markdown.Sections.OperatorsSection.ConfigName|OperatorsSection.ConfigName.md|ConfigName -M:DefaultDocumentation.Markdown.Sections.OperatorsSection.#ctor|OperatorsSection.OperatorsSection().md|OperatorsSection() -T:DefaultDocumentation.Markdown.Sections.OperatorsSection|OperatorsSection.md|OperatorsSection -F:DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection.ConfigName|ExplicitInterfaceImplementationsSection.ConfigName.md|ConfigName -M:DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection.#ctor|ExplicitInterfaceImplementationsSection.ExplicitInterfaceImplementationsSection().md|ExplicitInterfaceImplementationsSection() -T:DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection|ExplicitInterfaceImplementationsSection.md|ExplicitInterfaceImplementationsSection -F:DefaultDocumentation.Markdown.Sections.ClassesSection.ConfigName|ClassesSection.ConfigName.md|ConfigName -M:DefaultDocumentation.Markdown.Sections.ClassesSection.#ctor|ClassesSection.ClassesSection().md|ClassesSection() -T:DefaultDocumentation.Markdown.Sections.ClassesSection|ClassesSection.md|ClassesSection -F:DefaultDocumentation.Markdown.Sections.StructsSection.ConfigName|StructsSection.ConfigName.md|ConfigName -M:DefaultDocumentation.Markdown.Sections.StructsSection.#ctor|StructsSection.StructsSection().md|StructsSection() -T:DefaultDocumentation.Markdown.Sections.StructsSection|StructsSection.md|StructsSection -F:DefaultDocumentation.Markdown.Sections.InterfacesSection.ConfigName|InterfacesSection.ConfigName.md|ConfigName -M:DefaultDocumentation.Markdown.Sections.InterfacesSection.#ctor|InterfacesSection.InterfacesSection().md|InterfacesSection() -T:DefaultDocumentation.Markdown.Sections.InterfacesSection|InterfacesSection.md|InterfacesSection -F:DefaultDocumentation.Markdown.Sections.EnumsSection.ConfigName|EnumsSection.ConfigName.md|ConfigName -M:DefaultDocumentation.Markdown.Sections.EnumsSection.#ctor|EnumsSection.EnumsSection().md|EnumsSection() -T:DefaultDocumentation.Markdown.Sections.EnumsSection|EnumsSection.md|EnumsSection -F:DefaultDocumentation.Markdown.Sections.DelegatesSection.ConfigName|DelegatesSection.ConfigName.md|ConfigName -M:DefaultDocumentation.Markdown.Sections.DelegatesSection.#ctor|DelegatesSection.DelegatesSection().md|DelegatesSection() -T:DefaultDocumentation.Markdown.Sections.DelegatesSection|DelegatesSection.md|DelegatesSection -F:DefaultDocumentation.Markdown.Sections.NamespacesSection.ConfigName|NamespacesSection.ConfigName.md|ConfigName -M:DefaultDocumentation.Markdown.Sections.NamespacesSection.#ctor|NamespacesSection.NamespacesSection().md|NamespacesSection() -T:DefaultDocumentation.Markdown.Sections.NamespacesSection|NamespacesSection.md|NamespacesSection -F:DefaultDocumentation.Markdown.Sections.DefaultSection.ConfigName|DefaultSection.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.Sections.DefaultSection.Name|DefaultSection.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.DefaultSection.#ctor|DefaultSection.DefaultSection().md|DefaultSection() -M:DefaultDocumentation.Markdown.Sections.DefaultSection.Write(DefaultDocumentation.Api.IWriter)|DefaultSection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Markdown.Sections.DefaultSection|DefaultSection.md|DefaultSection -F:DefaultDocumentation.Markdown.Sections.DefinitionSection.ConfigName|DefinitionSection.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.Sections.DefinitionSection.Name|DefinitionSection.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.DefinitionSection.Write(DefaultDocumentation.Api.IWriter)|DefinitionSection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Markdown.Sections.DefinitionSection|DefinitionSection.md|DefinitionSection -F:DefaultDocumentation.Markdown.Sections.DerivedSection.ConfigName|DerivedSection.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.Sections.DerivedSection.Name|DerivedSection.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.DerivedSection.Write(DefaultDocumentation.Api.IWriter)|DerivedSection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Markdown.Sections.DerivedSection|DerivedSection.md|DerivedSection -F:DefaultDocumentation.Markdown.Sections.EventTypeSection.ConfigName|EventTypeSection.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.Sections.EventTypeSection.Name|EventTypeSection.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.EventTypeSection.Write(DefaultDocumentation.Api.IWriter)|EventTypeSection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Markdown.Sections.EventTypeSection|EventTypeSection.md|EventTypeSection -F:DefaultDocumentation.Markdown.Sections.ExampleSection.ConfigName|ExampleSection.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.Sections.ExampleSection.Name|ExampleSection.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.ExampleSection.Write(DefaultDocumentation.Api.IWriter)|ExampleSection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Markdown.Sections.ExampleSection|ExampleSection.md|ExampleSection -F:DefaultDocumentation.Markdown.Sections.ExceptionSection.ConfigName|ExceptionSection.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.Sections.ExceptionSection.Name|ExceptionSection.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.ExceptionSection.Write(DefaultDocumentation.Api.IWriter)|ExceptionSection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Markdown.Sections.ExceptionSection|ExceptionSection.md|ExceptionSection -F:DefaultDocumentation.Markdown.Sections.FieldValueSection.ConfigName|FieldValueSection.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.Sections.FieldValueSection.Name|FieldValueSection.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.FieldValueSection.Write(DefaultDocumentation.Api.IWriter)|FieldValueSection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Markdown.Sections.FieldValueSection|FieldValueSection.md|FieldValueSection -F:DefaultDocumentation.Markdown.Sections.FooterSection.ConfigName|FooterSection.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.Sections.FooterSection.Name|FooterSection.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.FooterSection.Write(DefaultDocumentation.Api.IWriter)|FooterSection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Markdown.Sections.FooterSection|FooterSection.md|FooterSection -F:DefaultDocumentation.Markdown.Sections.HeaderSection.ConfigName|HeaderSection.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.Sections.HeaderSection.Name|HeaderSection.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.HeaderSection.Write(DefaultDocumentation.Api.IWriter)|HeaderSection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Markdown.Sections.HeaderSection|HeaderSection.md|HeaderSection -F:DefaultDocumentation.Markdown.Sections.ImplementSection.ConfigName|ImplementSection.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.Sections.ImplementSection.Name|ImplementSection.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.ImplementSection.Write(DefaultDocumentation.Api.IWriter)|ImplementSection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Markdown.Sections.ImplementSection|ImplementSection.md|ImplementSection -F:DefaultDocumentation.Markdown.Sections.InheritanceSection.ConfigName|InheritanceSection.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.Sections.InheritanceSection.Name|InheritanceSection.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.InheritanceSection.Write(DefaultDocumentation.Api.IWriter)|InheritanceSection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Markdown.Sections.InheritanceSection|InheritanceSection.md|InheritanceSection -F:DefaultDocumentation.Markdown.Sections.RemarksSection.ConfigName|RemarksSection.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.Sections.RemarksSection.Name|RemarksSection.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.RemarksSection.Write(DefaultDocumentation.Api.IWriter)|RemarksSection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Markdown.Sections.RemarksSection|RemarksSection.md|RemarksSection -F:DefaultDocumentation.Markdown.Sections.ReturnsSection.ConfigName|ReturnsSection.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.Sections.ReturnsSection.Name|ReturnsSection.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.ReturnsSection.Write(DefaultDocumentation.Api.IWriter)|ReturnsSection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Markdown.Sections.ReturnsSection|ReturnsSection.md|ReturnsSection -F:DefaultDocumentation.Markdown.Sections.SeeAlsoSection.ConfigName|SeeAlsoSection.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.Sections.SeeAlsoSection.Name|SeeAlsoSection.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.SeeAlsoSection.Write(DefaultDocumentation.Api.IWriter)|SeeAlsoSection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Markdown.Sections.SeeAlsoSection|SeeAlsoSection.md|SeeAlsoSection -F:DefaultDocumentation.Markdown.Sections.SummarySection.ConfigName|SummarySection.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.Sections.SummarySection.Name|SummarySection.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.SummarySection.Write(DefaultDocumentation.Api.IWriter)|SummarySection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Markdown.Sections.SummarySection|SummarySection.md|SummarySection -F:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.ConfigName|TableOfContentsSection.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Name|TableOfContentsSection.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Write(DefaultDocumentation.Api.IWriter)|TableOfContentsSection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Markdown.Sections.TableOfContentsSection|TableOfContentsSection.md|TableOfContentsSection -F:DefaultDocumentation.Markdown.Sections.TitleSection.ConfigName|TitleSection.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.Sections.TitleSection.Name|TitleSection.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.TitleSection.Write(DefaultDocumentation.Api.IWriter)|TitleSection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Markdown.Sections.TitleSection|TitleSection.md|TitleSection -F:DefaultDocumentation.Markdown.Sections.ValueSection.ConfigName|ValueSection.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.Sections.ValueSection.Name|ValueSection.Name.md|Name -M:DefaultDocumentation.Markdown.Sections.ValueSection.Write(DefaultDocumentation.Api.IWriter)|ValueSection.Write(IWriter).md|Write(IWriter) -T:DefaultDocumentation.Markdown.Sections.ValueSection|ValueSection.md|ValueSection -P:DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.Name|AMarkdownFactory.Name.md|Name -M:DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|AMarkdownFactory.GetMarkdownFileName(IGeneralContext,DocItem).md|GetMarkdownFileName(IGeneralContext, DocItem) -M:DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.Clean(DefaultDocumentation.IGeneralContext)|AMarkdownFactory.Clean(IGeneralContext).md|Clean(IGeneralContext) -M:DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.GetFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|AMarkdownFactory.GetFileName(IGeneralContext,DocItem).md|GetFileName(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.ChildrenSection`1|DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/index.md|ChildrenSection +F:DefaultDocumentation.Markdown.Sections.TypeParametersSection.ConfigName|DefaultDocumentation/Markdown/Sections/TypeParametersSection/ConfigName.md|ConfigName +M:DefaultDocumentation.Markdown.Sections.TypeParametersSection.#ctor|DefaultDocumentation/Markdown/Sections/TypeParametersSection/TypeParametersSection().md|TypeParametersSection() +M:DefaultDocumentation.Markdown.Sections.TypeParametersSection.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/TypeParametersSection/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +M:DefaultDocumentation.Markdown.Sections.TypeParametersSection.GetChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/TypeParametersSection/GetChildren(IGeneralContext,DocItem).md|GetChildren(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.TypeParametersSection|DefaultDocumentation/Markdown/Sections/TypeParametersSection/index.md|TypeParametersSection +F:DefaultDocumentation.Markdown.Sections.ParametersSection.ConfigName|DefaultDocumentation/Markdown/Sections/ParametersSection/ConfigName.md|ConfigName +M:DefaultDocumentation.Markdown.Sections.ParametersSection.#ctor|DefaultDocumentation/Markdown/Sections/ParametersSection/ParametersSection().md|ParametersSection() +M:DefaultDocumentation.Markdown.Sections.ParametersSection.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/ParametersSection/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +M:DefaultDocumentation.Markdown.Sections.ParametersSection.GetChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/ParametersSection/GetChildren(IGeneralContext,DocItem).md|GetChildren(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.ParametersSection|DefaultDocumentation/Markdown/Sections/ParametersSection/index.md|ParametersSection +F:DefaultDocumentation.Markdown.Sections.EnumFieldsSection.ConfigName|DefaultDocumentation/Markdown/Sections/EnumFieldsSection/ConfigName.md|ConfigName +M:DefaultDocumentation.Markdown.Sections.EnumFieldsSection.#ctor|DefaultDocumentation/Markdown/Sections/EnumFieldsSection/EnumFieldsSection().md|EnumFieldsSection() +M:DefaultDocumentation.Markdown.Sections.EnumFieldsSection.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/EnumFieldsSection/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +M:DefaultDocumentation.Markdown.Sections.EnumFieldsSection.GetChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/EnumFieldsSection/GetChildren(IGeneralContext,DocItem).md|GetChildren(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.EnumFieldsSection|DefaultDocumentation/Markdown/Sections/EnumFieldsSection/index.md|EnumFieldsSection +F:DefaultDocumentation.Markdown.Sections.ConstructorsSection.ConfigName|DefaultDocumentation/Markdown/Sections/ConstructorsSection/ConfigName.md|ConfigName +M:DefaultDocumentation.Markdown.Sections.ConstructorsSection.#ctor|DefaultDocumentation/Markdown/Sections/ConstructorsSection/ConstructorsSection().md|ConstructorsSection() +M:DefaultDocumentation.Markdown.Sections.ConstructorsSection.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/ConstructorsSection/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +M:DefaultDocumentation.Markdown.Sections.ConstructorsSection.ShouldWriteTitle(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/ConstructorsSection/ShouldWriteTitle(IGeneralContext,DocItem).md|ShouldWriteTitle(IGeneralContext, DocItem) +M:DefaultDocumentation.Markdown.Sections.ConstructorsSection.GetChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/ConstructorsSection/GetChildren(IGeneralContext,DocItem).md|GetChildren(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.ConstructorsSection|DefaultDocumentation/Markdown/Sections/ConstructorsSection/index.md|ConstructorsSection +F:DefaultDocumentation.Markdown.Sections.ConstructorOverloadsSection.ConfigName|DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/ConfigName.md|ConfigName +M:DefaultDocumentation.Markdown.Sections.ConstructorOverloadsSection.#ctor|DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/ConstructorOverloadsSection().md|ConstructorOverloadsSection() +M:DefaultDocumentation.Markdown.Sections.ConstructorOverloadsSection.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +M:DefaultDocumentation.Markdown.Sections.ConstructorOverloadsSection.GetChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/GetChildren(IGeneralContext,DocItem).md|GetChildren(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.ConstructorOverloadsSection|DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/index.md|ConstructorOverloadsSection +F:DefaultDocumentation.Markdown.Sections.FieldsSection.ConfigName|DefaultDocumentation/Markdown/Sections/FieldsSection/ConfigName.md|ConfigName +M:DefaultDocumentation.Markdown.Sections.FieldsSection.#ctor|DefaultDocumentation/Markdown/Sections/FieldsSection/FieldsSection().md|FieldsSection() +M:DefaultDocumentation.Markdown.Sections.FieldsSection.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/FieldsSection/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.FieldsSection|DefaultDocumentation/Markdown/Sections/FieldsSection/index.md|FieldsSection +F:DefaultDocumentation.Markdown.Sections.PropertiesSection.ConfigName|DefaultDocumentation/Markdown/Sections/PropertiesSection/ConfigName.md|ConfigName +M:DefaultDocumentation.Markdown.Sections.PropertiesSection.#ctor|DefaultDocumentation/Markdown/Sections/PropertiesSection/PropertiesSection().md|PropertiesSection() +M:DefaultDocumentation.Markdown.Sections.PropertiesSection.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/PropertiesSection/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.PropertiesSection|DefaultDocumentation/Markdown/Sections/PropertiesSection/index.md|PropertiesSection +F:DefaultDocumentation.Markdown.Sections.MethodsSection.ConfigName|DefaultDocumentation/Markdown/Sections/MethodsSection/ConfigName.md|ConfigName +M:DefaultDocumentation.Markdown.Sections.MethodsSection.#ctor|DefaultDocumentation/Markdown/Sections/MethodsSection/MethodsSection().md|MethodsSection() +M:DefaultDocumentation.Markdown.Sections.MethodsSection.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/MethodsSection/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +M:DefaultDocumentation.Markdown.Sections.MethodsSection.ShouldWriteTitle(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/MethodsSection/ShouldWriteTitle(IGeneralContext,DocItem).md|ShouldWriteTitle(IGeneralContext, DocItem) +M:DefaultDocumentation.Markdown.Sections.MethodsSection.GetChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/MethodsSection/GetChildren(IGeneralContext,DocItem).md|GetChildren(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.MethodsSection|DefaultDocumentation/Markdown/Sections/MethodsSection/index.md|MethodsSection +F:DefaultDocumentation.Markdown.Sections.MethodOverloadsSection.ConfigName|DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/ConfigName.md|ConfigName +M:DefaultDocumentation.Markdown.Sections.MethodOverloadsSection.#ctor|DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/MethodOverloadsSection().md|MethodOverloadsSection() +M:DefaultDocumentation.Markdown.Sections.MethodOverloadsSection.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +M:DefaultDocumentation.Markdown.Sections.MethodOverloadsSection.GetChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/GetChildren(IGeneralContext,DocItem).md|GetChildren(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.MethodOverloadsSection|DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/index.md|MethodOverloadsSection +F:DefaultDocumentation.Markdown.Sections.EventsSection.ConfigName|DefaultDocumentation/Markdown/Sections/EventsSection/ConfigName.md|ConfigName +M:DefaultDocumentation.Markdown.Sections.EventsSection.#ctor|DefaultDocumentation/Markdown/Sections/EventsSection/EventsSection().md|EventsSection() +M:DefaultDocumentation.Markdown.Sections.EventsSection.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/EventsSection/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.EventsSection|DefaultDocumentation/Markdown/Sections/EventsSection/index.md|EventsSection +F:DefaultDocumentation.Markdown.Sections.OperatorsSection.ConfigName|DefaultDocumentation/Markdown/Sections/OperatorsSection/ConfigName.md|ConfigName +M:DefaultDocumentation.Markdown.Sections.OperatorsSection.#ctor|DefaultDocumentation/Markdown/Sections/OperatorsSection/OperatorsSection().md|OperatorsSection() +M:DefaultDocumentation.Markdown.Sections.OperatorsSection.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/OperatorsSection/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.OperatorsSection|DefaultDocumentation/Markdown/Sections/OperatorsSection/index.md|OperatorsSection +F:DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection.ConfigName|DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/ConfigName.md|ConfigName +M:DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection.#ctor|DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/ExplicitInterfaceImplementationsSection().md|ExplicitInterfaceImplementationsSection() +M:DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection|DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/index.md|ExplicitInterfaceImplementationsSection +F:DefaultDocumentation.Markdown.Sections.ClassesSection.ConfigName|DefaultDocumentation/Markdown/Sections/ClassesSection/ConfigName.md|ConfigName +M:DefaultDocumentation.Markdown.Sections.ClassesSection.#ctor|DefaultDocumentation/Markdown/Sections/ClassesSection/ClassesSection().md|ClassesSection() +M:DefaultDocumentation.Markdown.Sections.ClassesSection.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/ClassesSection/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.ClassesSection|DefaultDocumentation/Markdown/Sections/ClassesSection/index.md|ClassesSection +F:DefaultDocumentation.Markdown.Sections.StructsSection.ConfigName|DefaultDocumentation/Markdown/Sections/StructsSection/ConfigName.md|ConfigName +M:DefaultDocumentation.Markdown.Sections.StructsSection.#ctor|DefaultDocumentation/Markdown/Sections/StructsSection/StructsSection().md|StructsSection() +M:DefaultDocumentation.Markdown.Sections.StructsSection.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/StructsSection/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.StructsSection|DefaultDocumentation/Markdown/Sections/StructsSection/index.md|StructsSection +F:DefaultDocumentation.Markdown.Sections.InterfacesSection.ConfigName|DefaultDocumentation/Markdown/Sections/InterfacesSection/ConfigName.md|ConfigName +M:DefaultDocumentation.Markdown.Sections.InterfacesSection.#ctor|DefaultDocumentation/Markdown/Sections/InterfacesSection/InterfacesSection().md|InterfacesSection() +M:DefaultDocumentation.Markdown.Sections.InterfacesSection.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/InterfacesSection/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.InterfacesSection|DefaultDocumentation/Markdown/Sections/InterfacesSection/index.md|InterfacesSection +F:DefaultDocumentation.Markdown.Sections.EnumsSection.ConfigName|DefaultDocumentation/Markdown/Sections/EnumsSection/ConfigName.md|ConfigName +M:DefaultDocumentation.Markdown.Sections.EnumsSection.#ctor|DefaultDocumentation/Markdown/Sections/EnumsSection/EnumsSection().md|EnumsSection() +M:DefaultDocumentation.Markdown.Sections.EnumsSection.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/EnumsSection/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.EnumsSection|DefaultDocumentation/Markdown/Sections/EnumsSection/index.md|EnumsSection +F:DefaultDocumentation.Markdown.Sections.DelegatesSection.ConfigName|DefaultDocumentation/Markdown/Sections/DelegatesSection/ConfigName.md|ConfigName +M:DefaultDocumentation.Markdown.Sections.DelegatesSection.#ctor|DefaultDocumentation/Markdown/Sections/DelegatesSection/DelegatesSection().md|DelegatesSection() +M:DefaultDocumentation.Markdown.Sections.DelegatesSection.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/DelegatesSection/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.DelegatesSection|DefaultDocumentation/Markdown/Sections/DelegatesSection/index.md|DelegatesSection +F:DefaultDocumentation.Markdown.Sections.NamespacesSection.ConfigName|DefaultDocumentation/Markdown/Sections/NamespacesSection/ConfigName.md|ConfigName +M:DefaultDocumentation.Markdown.Sections.NamespacesSection.#ctor|DefaultDocumentation/Markdown/Sections/NamespacesSection/NamespacesSection().md|NamespacesSection() +M:DefaultDocumentation.Markdown.Sections.NamespacesSection.ShouldInlineChildren(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/Sections/NamespacesSection/ShouldInlineChildren(IGeneralContext,DocItem).md|ShouldInlineChildren(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.Sections.NamespacesSection|DefaultDocumentation/Markdown/Sections/NamespacesSection/index.md|NamespacesSection +F:DefaultDocumentation.Markdown.Sections.DefaultSection.ConfigName|DefaultDocumentation/Markdown/Sections/DefaultSection/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Sections.DefaultSection.Name|DefaultDocumentation/Markdown/Sections/DefaultSection/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.DefaultSection.#ctor|DefaultDocumentation/Markdown/Sections/DefaultSection/DefaultSection().md|DefaultSection() +M:DefaultDocumentation.Markdown.Sections.DefaultSection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/DefaultSection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.Sections.DefaultSection|DefaultDocumentation/Markdown/Sections/DefaultSection/index.md|DefaultSection +F:DefaultDocumentation.Markdown.Sections.DefinitionSection.ConfigName|DefaultDocumentation/Markdown/Sections/DefinitionSection/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Sections.DefinitionSection.Name|DefaultDocumentation/Markdown/Sections/DefinitionSection/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.DefinitionSection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/DefinitionSection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.Sections.DefinitionSection|DefaultDocumentation/Markdown/Sections/DefinitionSection/index.md|DefinitionSection +F:DefaultDocumentation.Markdown.Sections.DerivedSection.ConfigName|DefaultDocumentation/Markdown/Sections/DerivedSection/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Sections.DerivedSection.Name|DefaultDocumentation/Markdown/Sections/DerivedSection/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.DerivedSection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/DerivedSection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.Sections.DerivedSection|DefaultDocumentation/Markdown/Sections/DerivedSection/index.md|DerivedSection +F:DefaultDocumentation.Markdown.Sections.EventTypeSection.ConfigName|DefaultDocumentation/Markdown/Sections/EventTypeSection/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Sections.EventTypeSection.Name|DefaultDocumentation/Markdown/Sections/EventTypeSection/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.EventTypeSection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/EventTypeSection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.Sections.EventTypeSection|DefaultDocumentation/Markdown/Sections/EventTypeSection/index.md|EventTypeSection +F:DefaultDocumentation.Markdown.Sections.ExampleSection.ConfigName|DefaultDocumentation/Markdown/Sections/ExampleSection/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Sections.ExampleSection.Name|DefaultDocumentation/Markdown/Sections/ExampleSection/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.ExampleSection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/ExampleSection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.Sections.ExampleSection|DefaultDocumentation/Markdown/Sections/ExampleSection/index.md|ExampleSection +F:DefaultDocumentation.Markdown.Sections.ExceptionSection.ConfigName|DefaultDocumentation/Markdown/Sections/ExceptionSection/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Sections.ExceptionSection.Name|DefaultDocumentation/Markdown/Sections/ExceptionSection/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.ExceptionSection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/ExceptionSection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.Sections.ExceptionSection|DefaultDocumentation/Markdown/Sections/ExceptionSection/index.md|ExceptionSection +F:DefaultDocumentation.Markdown.Sections.FieldValueSection.ConfigName|DefaultDocumentation/Markdown/Sections/FieldValueSection/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Sections.FieldValueSection.Name|DefaultDocumentation/Markdown/Sections/FieldValueSection/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.FieldValueSection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/FieldValueSection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.Sections.FieldValueSection|DefaultDocumentation/Markdown/Sections/FieldValueSection/index.md|FieldValueSection +F:DefaultDocumentation.Markdown.Sections.FooterSection.ConfigName|DefaultDocumentation/Markdown/Sections/FooterSection/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Sections.FooterSection.Name|DefaultDocumentation/Markdown/Sections/FooterSection/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.FooterSection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/FooterSection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.Sections.FooterSection|DefaultDocumentation/Markdown/Sections/FooterSection/index.md|FooterSection +F:DefaultDocumentation.Markdown.Sections.HeaderSection.ConfigName|DefaultDocumentation/Markdown/Sections/HeaderSection/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Sections.HeaderSection.Name|DefaultDocumentation/Markdown/Sections/HeaderSection/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.HeaderSection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/HeaderSection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.Sections.HeaderSection|DefaultDocumentation/Markdown/Sections/HeaderSection/index.md|HeaderSection +F:DefaultDocumentation.Markdown.Sections.ImplementSection.ConfigName|DefaultDocumentation/Markdown/Sections/ImplementSection/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Sections.ImplementSection.Name|DefaultDocumentation/Markdown/Sections/ImplementSection/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.ImplementSection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/ImplementSection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.Sections.ImplementSection|DefaultDocumentation/Markdown/Sections/ImplementSection/index.md|ImplementSection +F:DefaultDocumentation.Markdown.Sections.InheritanceSection.ConfigName|DefaultDocumentation/Markdown/Sections/InheritanceSection/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Sections.InheritanceSection.Name|DefaultDocumentation/Markdown/Sections/InheritanceSection/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.InheritanceSection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/InheritanceSection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.Sections.InheritanceSection|DefaultDocumentation/Markdown/Sections/InheritanceSection/index.md|InheritanceSection +F:DefaultDocumentation.Markdown.Sections.RemarksSection.ConfigName|DefaultDocumentation/Markdown/Sections/RemarksSection/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Sections.RemarksSection.Name|DefaultDocumentation/Markdown/Sections/RemarksSection/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.RemarksSection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/RemarksSection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.Sections.RemarksSection|DefaultDocumentation/Markdown/Sections/RemarksSection/index.md|RemarksSection +F:DefaultDocumentation.Markdown.Sections.ReturnsSection.ConfigName|DefaultDocumentation/Markdown/Sections/ReturnsSection/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Sections.ReturnsSection.Name|DefaultDocumentation/Markdown/Sections/ReturnsSection/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.ReturnsSection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/ReturnsSection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.Sections.ReturnsSection|DefaultDocumentation/Markdown/Sections/ReturnsSection/index.md|ReturnsSection +F:DefaultDocumentation.Markdown.Sections.SeeAlsoSection.ConfigName|DefaultDocumentation/Markdown/Sections/SeeAlsoSection/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Sections.SeeAlsoSection.Name|DefaultDocumentation/Markdown/Sections/SeeAlsoSection/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.SeeAlsoSection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/SeeAlsoSection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.Sections.SeeAlsoSection|DefaultDocumentation/Markdown/Sections/SeeAlsoSection/index.md|SeeAlsoSection +F:DefaultDocumentation.Markdown.Sections.SummarySection.ConfigName|DefaultDocumentation/Markdown/Sections/SummarySection/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Sections.SummarySection.Name|DefaultDocumentation/Markdown/Sections/SummarySection/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.SummarySection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/SummarySection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.Sections.SummarySection|DefaultDocumentation/Markdown/Sections/SummarySection/index.md|SummarySection +F:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.ConfigName|DefaultDocumentation/Markdown/Sections/TableOfContentsSection/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Name|DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.Sections.TableOfContentsSection|DefaultDocumentation/Markdown/Sections/TableOfContentsSection/index.md|TableOfContentsSection +F:DefaultDocumentation.Markdown.Sections.TitleSection.ConfigName|DefaultDocumentation/Markdown/Sections/TitleSection/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Sections.TitleSection.Name|DefaultDocumentation/Markdown/Sections/TitleSection/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.TitleSection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/TitleSection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.Sections.TitleSection|DefaultDocumentation/Markdown/Sections/TitleSection/index.md|TitleSection +F:DefaultDocumentation.Markdown.Sections.ValueSection.ConfigName|DefaultDocumentation/Markdown/Sections/ValueSection/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Sections.ValueSection.Name|DefaultDocumentation/Markdown/Sections/ValueSection/Name.md|Name +M:DefaultDocumentation.Markdown.Sections.ValueSection.Write(DefaultDocumentation.Api.IWriter)|DefaultDocumentation/Markdown/Sections/ValueSection/Write(IWriter).md|Write(IWriter) +T:DefaultDocumentation.Markdown.Sections.ValueSection|DefaultDocumentation/Markdown/Sections/ValueSection/index.md|ValueSection +M:DefaultDocumentation.Markdown.Models.ConstructorOverloadsDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem)|DefaultDocumentation/Markdown/Models/ConstructorOverloadsDocItem/ConstructorOverloadsDocItem(TypeDocItem).md|ConstructorOverloadsDocItem(TypeDocItem) +N:DefaultDocumentation.Markdown.Models|index.md#DefaultDocumentation.Markdown.Models|DefaultDocumentation.Markdown.Models +T:DefaultDocumentation.Markdown.Models.ConstructorOverloadsDocItem|DefaultDocumentation/Markdown/Models/ConstructorOverloadsDocItem/index.md|ConstructorOverloadsDocItem +M:DefaultDocumentation.Markdown.Models.MethodOverloadsDocItem.#ctor(DefaultDocumentation.Models.Types.TypeDocItem,System.String)|DefaultDocumentation/Markdown/Models/MethodOverloadsDocItem/MethodOverloadsDocItem(TypeDocItem,string).md|MethodOverloadsDocItem(TypeDocItem, string) +T:DefaultDocumentation.Markdown.Models.MethodOverloadsDocItem|DefaultDocumentation/Markdown/Models/MethodOverloadsDocItem/index.md|MethodOverloadsDocItem +P:DefaultDocumentation.Markdown.FileNameFactories.BaseMarkdownFileNameFactory.Name|DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/Name.md|Name +M:DefaultDocumentation.Markdown.FileNameFactories.BaseMarkdownFileNameFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/GetMarkdownFileName(IGeneralContext,DocItem).md|GetMarkdownFileName(IGeneralContext, DocItem) +M:DefaultDocumentation.Markdown.FileNameFactories.BaseMarkdownFileNameFactory.Clean(DefaultDocumentation.IGeneralContext)|DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/Clean(IGeneralContext).md|Clean(IGeneralContext) +M:DefaultDocumentation.Markdown.FileNameFactories.BaseMarkdownFileNameFactory.GetFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/GetFileName(IGeneralContext,DocItem).md|GetFileName(IGeneralContext, DocItem) N:DefaultDocumentation.Markdown.FileNameFactories|index.md#DefaultDocumentation.Markdown.FileNameFactories|DefaultDocumentation.Markdown.FileNameFactories -T:DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory|AMarkdownFactory.md|AMarkdownFactory -F:DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory.ConfigName|FullNameFactory.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory.Name|FullNameFactory.Name.md|Name -M:DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|FullNameFactory.GetMarkdownFileName(IGeneralContext,DocItem).md|GetMarkdownFileName(IGeneralContext, DocItem) -T:DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory|FullNameFactory.md|FullNameFactory -F:DefaultDocumentation.Markdown.FileNameFactories.Md5Factory.ConfigName|Md5Factory.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.FileNameFactories.Md5Factory.Name|Md5Factory.Name.md|Name -M:DefaultDocumentation.Markdown.FileNameFactories.Md5Factory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|Md5Factory.GetMarkdownFileName(IGeneralContext,DocItem).md|GetMarkdownFileName(IGeneralContext, DocItem) -T:DefaultDocumentation.Markdown.FileNameFactories.Md5Factory|Md5Factory.md|Md5Factory -F:DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory.ConfigName|NameAndMd5MixFactory.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory.Name|NameAndMd5MixFactory.Name.md|Name -M:DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|NameAndMd5MixFactory.GetMarkdownFileName(IGeneralContext,DocItem).md|GetMarkdownFileName(IGeneralContext, DocItem) -T:DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory|NameAndMd5MixFactory.md|NameAndMd5MixFactory -F:DefaultDocumentation.Markdown.FileNameFactories.NameFactory.ConfigName|NameFactory.ConfigName.md|ConfigName -P:DefaultDocumentation.Markdown.FileNameFactories.NameFactory.Name|NameFactory.Name.md|Name -M:DefaultDocumentation.Markdown.FileNameFactories.NameFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|NameFactory.GetMarkdownFileName(IGeneralContext,DocItem).md|GetMarkdownFileName(IGeneralContext, DocItem) -T:DefaultDocumentation.Markdown.FileNameFactories.NameFactory|NameFactory.md|NameFactory -M:DefaultDocumentation.Markdown.Extensions.IWriterExtension.GetCurrentItem(DefaultDocumentation.Api.IWriter)|IWriterExtension.GetCurrentItem(thisIWriter).md|GetCurrentItem(this IWriter) -M:DefaultDocumentation.Markdown.Extensions.IWriterExtension.SetCurrentItem(DefaultDocumentation.Api.IWriter,DefaultDocumentation.Models.DocItem)|IWriterExtension.SetCurrentItem(thisIWriter,DocItem).md|SetCurrentItem(this IWriter, DocItem) -M:DefaultDocumentation.Markdown.Extensions.IWriterExtension.GetDisplayAsSingleLine(DefaultDocumentation.Api.IWriter)|IWriterExtension.GetDisplayAsSingleLine(thisIWriter).md|GetDisplayAsSingleLine(this IWriter) -M:DefaultDocumentation.Markdown.Extensions.IWriterExtension.SetDisplayAsSingleLine(DefaultDocumentation.Api.IWriter,System.Nullable{System.Boolean})|IWriterExtension.SetDisplayAsSingleLine(thisIWriter,Nullable_bool_).md|SetDisplayAsSingleLine(this IWriter, Nullable) -M:DefaultDocumentation.Markdown.Extensions.IWriterExtension.GetIgnoreLineBreak(DefaultDocumentation.Api.IWriter)|IWriterExtension.GetIgnoreLineBreak(thisIWriter).md|GetIgnoreLineBreak(this IWriter) -M:DefaultDocumentation.Markdown.Extensions.IWriterExtension.SetIgnoreLineBreakLine(DefaultDocumentation.Api.IWriter,System.Nullable{System.Boolean})|IWriterExtension.SetIgnoreLineBreakLine(thisIWriter,Nullable_bool_).md|SetIgnoreLineBreakLine(this IWriter, Nullable) -M:DefaultDocumentation.Markdown.Extensions.IWriterExtension.AppendUrl(DefaultDocumentation.Api.IWriter,System.String,System.String,System.String)|IWriterExtension.AppendUrl(thisIWriter,string,string,string).md|AppendUrl(this IWriter, string, string, string) -M:DefaultDocumentation.Markdown.Extensions.IWriterExtension.AppendLink(DefaultDocumentation.Api.IWriter,DefaultDocumentation.Models.DocItem,System.String)|IWriterExtension.AppendLink(thisIWriter,DocItem,string).md|AppendLink(this IWriter, DocItem, string) -M:DefaultDocumentation.Markdown.Extensions.IWriterExtension.AppendLink(DefaultDocumentation.Api.IWriter,System.String,System.String)|IWriterExtension.AppendLink(thisIWriter,string,string).md|AppendLink(this IWriter, string, string) -M:DefaultDocumentation.Markdown.Extensions.IWriterExtension.AppendLink(DefaultDocumentation.Api.IWriter,DefaultDocumentation.Models.DocItem,ICSharpCode.Decompiler.TypeSystem.INamedElement)|IWriterExtension.AppendLink(thisIWriter,DocItem,INamedElement).md|AppendLink(this IWriter, DocItem, INamedElement) -M:DefaultDocumentation.Markdown.Extensions.IWriterExtension.EnsureLineStart(DefaultDocumentation.Api.IWriter)|IWriterExtension.EnsureLineStart(thisIWriter).md|EnsureLineStart(this IWriter) -M:DefaultDocumentation.Markdown.Extensions.IWriterExtension.EnsureLineStartAndAppendLine(DefaultDocumentation.Api.IWriter)|IWriterExtension.EnsureLineStartAndAppendLine(thisIWriter).md|EnsureLineStartAndAppendLine(this IWriter) -M:DefaultDocumentation.Markdown.Extensions.IWriterExtension.AppendAsMarkdown(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|IWriterExtension.AppendAsMarkdown(thisIWriter,XElement).md|AppendAsMarkdown(this IWriter, XElement) -M:DefaultDocumentation.Markdown.Extensions.IWriterExtension.ToPrefixedWriter(DefaultDocumentation.Api.IWriter,System.String)|IWriterExtension.ToPrefixedWriter(thisIWriter,string).md|ToPrefixedWriter(this IWriter, string) -M:DefaultDocumentation.Markdown.Extensions.IWriterExtension.ToOverrideWriter(DefaultDocumentation.Api.IWriter)|IWriterExtension.ToOverrideWriter(thisIWriter).md|ToOverrideWriter(this IWriter) -N:DefaultDocumentation.Markdown.Extensions|index.md#DefaultDocumentation.Markdown.Extensions|DefaultDocumentation.Markdown.Extensions -T:DefaultDocumentation.Markdown.Extensions.IWriterExtension|IWriterExtension.md|IWriterExtension -P:DefaultDocumentation.Markdown.Elements.CElement.Name|CElement.Name.md|Name -M:DefaultDocumentation.Markdown.Elements.CElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|CElement.Write(IWriter,XElement).md|Write(IWriter, XElement) +T:DefaultDocumentation.Markdown.FileNameFactories.BaseMarkdownFileNameFactory|DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/index.md|BaseMarkdownFileNameFactory +F:DefaultDocumentation.Markdown.FileNameFactories.DirectoryNameFactory.ConfigName|DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.FileNameFactories.DirectoryNameFactory.Name|DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/Name.md|Name +M:DefaultDocumentation.Markdown.FileNameFactories.DirectoryNameFactory.Clean(DefaultDocumentation.IGeneralContext)|DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/Clean(IGeneralContext).md|Clean(IGeneralContext) +M:DefaultDocumentation.Markdown.FileNameFactories.DirectoryNameFactory.GetFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/GetFileName(IGeneralContext,DocItem).md|GetFileName(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.FileNameFactories.DirectoryNameFactory|DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/index.md|DirectoryNameFactory +F:DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory.ConfigName|DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory.Name|DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/Name.md|Name +M:DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/GetMarkdownFileName(IGeneralContext,DocItem).md|GetMarkdownFileName(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory|DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/index.md|FullNameFactory +F:DefaultDocumentation.Markdown.FileNameFactories.Md5Factory.ConfigName|DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.FileNameFactories.Md5Factory.Name|DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/Name.md|Name +M:DefaultDocumentation.Markdown.FileNameFactories.Md5Factory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/GetMarkdownFileName(IGeneralContext,DocItem).md|GetMarkdownFileName(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.FileNameFactories.Md5Factory|DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/index.md|Md5Factory +F:DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory.ConfigName|DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory.Name|DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/Name.md|Name +M:DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/GetMarkdownFileName(IGeneralContext,DocItem).md|GetMarkdownFileName(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory|DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/index.md|NameAndMd5MixFactory +F:DefaultDocumentation.Markdown.FileNameFactories.NameFactory.ConfigName|DefaultDocumentation/Markdown/FileNameFactories/NameFactory/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.FileNameFactories.NameFactory.Name|DefaultDocumentation/Markdown/FileNameFactories/NameFactory/Name.md|Name +M:DefaultDocumentation.Markdown.FileNameFactories.NameFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)|DefaultDocumentation/Markdown/FileNameFactories/NameFactory/GetMarkdownFileName(IGeneralContext,DocItem).md|GetMarkdownFileName(IGeneralContext, DocItem) +T:DefaultDocumentation.Markdown.FileNameFactories.NameFactory|DefaultDocumentation/Markdown/FileNameFactories/NameFactory/index.md|NameFactory +F:DefaultDocumentation.Markdown.Elements.BrElement.ConfigName|DefaultDocumentation/Markdown/Elements/BrElement/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Elements.BrElement.Name|DefaultDocumentation/Markdown/Elements/BrElement/Name.md|Name +M:DefaultDocumentation.Markdown.Elements.BrElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|DefaultDocumentation/Markdown/Elements/BrElement/Write(IWriter,XElement).md|Write(IWriter, XElement) N:DefaultDocumentation.Markdown.Elements|index.md#DefaultDocumentation.Markdown.Elements|DefaultDocumentation.Markdown.Elements -T:DefaultDocumentation.Markdown.Elements.CElement|CElement.md|CElement -P:DefaultDocumentation.Markdown.Elements.CodeElement.Name|CodeElement.Name.md|Name -M:DefaultDocumentation.Markdown.Elements.CodeElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|CodeElement.Write(IWriter,XElement).md|Write(IWriter, XElement) -T:DefaultDocumentation.Markdown.Elements.CodeElement|CodeElement.md|CodeElement -P:DefaultDocumentation.Markdown.Elements.ListElement.Name|ListElement.Name.md|Name -M:DefaultDocumentation.Markdown.Elements.ListElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|ListElement.Write(IWriter,XElement).md|Write(IWriter, XElement) -T:DefaultDocumentation.Markdown.Elements.ListElement|ListElement.md|ListElement -P:DefaultDocumentation.Markdown.Elements.NoteElement.Name|NoteElement.Name.md|Name -M:DefaultDocumentation.Markdown.Elements.NoteElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|NoteElement.Write(IWriter,XElement).md|Write(IWriter, XElement) -T:DefaultDocumentation.Markdown.Elements.NoteElement|NoteElement.md|NoteElement -P:DefaultDocumentation.Markdown.Elements.ParaElement.Name|ParaElement.Name.md|Name -M:DefaultDocumentation.Markdown.Elements.ParaElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|ParaElement.Write(IWriter,XElement).md|Write(IWriter, XElement) -T:DefaultDocumentation.Markdown.Elements.ParaElement|ParaElement.md|ParaElement -P:DefaultDocumentation.Markdown.Elements.ParamRefElement.Name|ParamRefElement.Name.md|Name -M:DefaultDocumentation.Markdown.Elements.ParamRefElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|ParamRefElement.Write(IWriter,XElement).md|Write(IWriter, XElement) -T:DefaultDocumentation.Markdown.Elements.ParamRefElement|ParamRefElement.md|ParamRefElement -P:DefaultDocumentation.Markdown.Elements.SeeElement.Name|SeeElement.Name.md|Name -M:DefaultDocumentation.Markdown.Elements.SeeElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|SeeElement.Write(IWriter,XElement).md|Write(IWriter, XElement) -T:DefaultDocumentation.Markdown.Elements.SeeElement|SeeElement.md|SeeElement -P:DefaultDocumentation.Markdown.Elements.TypeParamRefElement.Name|TypeParamRefElement.Name.md|Name -M:DefaultDocumentation.Markdown.Elements.TypeParamRefElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|TypeParamRefElement.Write(IWriter,XElement).md|Write(IWriter, XElement) -T:DefaultDocumentation.Markdown.Elements.TypeParamRefElement|TypeParamRefElement.md|TypeParamRefElement -F:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.None|TableOfContentsSection.Modes.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.None|None -F:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.Grouped|TableOfContentsSection.Modes.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.Grouped|Grouped -F:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeKind|TableOfContentsSection.Modes.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeKind|IncludeKind -F:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummary|TableOfContentsSection.Modes.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummary|IncludeSummary -F:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeNewLine|TableOfContentsSection.Modes.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeNewLine|IncludeNewLine -F:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummaryWithNewLine|TableOfContentsSection.Modes.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummaryWithNewLine|IncludeSummaryWithNewLine -T:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes|TableOfContentsSection.Modes.md|Modes +T:DefaultDocumentation.Markdown.Elements.BrElement|DefaultDocumentation/Markdown/Elements/BrElement/index.md|BrElement +F:DefaultDocumentation.Markdown.Elements.CElement.ConfigName|DefaultDocumentation/Markdown/Elements/CElement/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Elements.CElement.Name|DefaultDocumentation/Markdown/Elements/CElement/Name.md|Name +M:DefaultDocumentation.Markdown.Elements.CElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|DefaultDocumentation/Markdown/Elements/CElement/Write(IWriter,XElement).md|Write(IWriter, XElement) +T:DefaultDocumentation.Markdown.Elements.CElement|DefaultDocumentation/Markdown/Elements/CElement/index.md|CElement +F:DefaultDocumentation.Markdown.Elements.CodeElement.ConfigName|DefaultDocumentation/Markdown/Elements/CodeElement/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Elements.CodeElement.Name|DefaultDocumentation/Markdown/Elements/CodeElement/Name.md|Name +M:DefaultDocumentation.Markdown.Elements.CodeElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|DefaultDocumentation/Markdown/Elements/CodeElement/Write(IWriter,XElement).md|Write(IWriter, XElement) +T:DefaultDocumentation.Markdown.Elements.CodeElement|DefaultDocumentation/Markdown/Elements/CodeElement/index.md|CodeElement +F:DefaultDocumentation.Markdown.Elements.ListElement.ConfigName|DefaultDocumentation/Markdown/Elements/ListElement/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Elements.ListElement.Name|DefaultDocumentation/Markdown/Elements/ListElement/Name.md|Name +M:DefaultDocumentation.Markdown.Elements.ListElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|DefaultDocumentation/Markdown/Elements/ListElement/Write(IWriter,XElement).md|Write(IWriter, XElement) +T:DefaultDocumentation.Markdown.Elements.ListElement|DefaultDocumentation/Markdown/Elements/ListElement/index.md|ListElement +F:DefaultDocumentation.Markdown.Elements.NoteElement.ConfigName|DefaultDocumentation/Markdown/Elements/NoteElement/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Elements.NoteElement.Name|DefaultDocumentation/Markdown/Elements/NoteElement/Name.md|Name +M:DefaultDocumentation.Markdown.Elements.NoteElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|DefaultDocumentation/Markdown/Elements/NoteElement/Write(IWriter,XElement).md|Write(IWriter, XElement) +T:DefaultDocumentation.Markdown.Elements.NoteElement|DefaultDocumentation/Markdown/Elements/NoteElement/index.md|NoteElement +F:DefaultDocumentation.Markdown.Elements.ParaElement.ConfigName|DefaultDocumentation/Markdown/Elements/ParaElement/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Elements.ParaElement.Name|DefaultDocumentation/Markdown/Elements/ParaElement/Name.md|Name +M:DefaultDocumentation.Markdown.Elements.ParaElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|DefaultDocumentation/Markdown/Elements/ParaElement/Write(IWriter,XElement).md|Write(IWriter, XElement) +T:DefaultDocumentation.Markdown.Elements.ParaElement|DefaultDocumentation/Markdown/Elements/ParaElement/index.md|ParaElement +F:DefaultDocumentation.Markdown.Elements.ParamRefElement.ConfigName|DefaultDocumentation/Markdown/Elements/ParamRefElement/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Elements.ParamRefElement.Name|DefaultDocumentation/Markdown/Elements/ParamRefElement/Name.md|Name +M:DefaultDocumentation.Markdown.Elements.ParamRefElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|DefaultDocumentation/Markdown/Elements/ParamRefElement/Write(IWriter,XElement).md|Write(IWriter, XElement) +T:DefaultDocumentation.Markdown.Elements.ParamRefElement|DefaultDocumentation/Markdown/Elements/ParamRefElement/index.md|ParamRefElement +F:DefaultDocumentation.Markdown.Elements.SeeElement.ConfigName|DefaultDocumentation/Markdown/Elements/SeeElement/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Elements.SeeElement.Name|DefaultDocumentation/Markdown/Elements/SeeElement/Name.md|Name +M:DefaultDocumentation.Markdown.Elements.SeeElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|DefaultDocumentation/Markdown/Elements/SeeElement/Write(IWriter,XElement).md|Write(IWriter, XElement) +T:DefaultDocumentation.Markdown.Elements.SeeElement|DefaultDocumentation/Markdown/Elements/SeeElement/index.md|SeeElement +F:DefaultDocumentation.Markdown.Elements.TypeParamRefElement.ConfigName|DefaultDocumentation/Markdown/Elements/TypeParamRefElement/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.Elements.TypeParamRefElement.Name|DefaultDocumentation/Markdown/Elements/TypeParamRefElement/Name.md|Name +M:DefaultDocumentation.Markdown.Elements.TypeParamRefElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)|DefaultDocumentation/Markdown/Elements/TypeParamRefElement/Write(IWriter,XElement).md|Write(IWriter, XElement) +T:DefaultDocumentation.Markdown.Elements.TypeParamRefElement|DefaultDocumentation/Markdown/Elements/TypeParamRefElement/index.md|TypeParamRefElement +F:DefaultDocumentation.Markdown.DocItemGenerators.ExcludeGenerator.ConfigName|DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.DocItemGenerators.ExcludeGenerator.Name|DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/Name.md|Name +M:DefaultDocumentation.Markdown.DocItemGenerators.ExcludeGenerator.Generate(DefaultDocumentation.IDocItemsContext)|DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/Generate(IDocItemsContext).md|Generate(IDocItemsContext) +N:DefaultDocumentation.Markdown.DocItemGenerators|index.md#DefaultDocumentation.Markdown.DocItemGenerators|DefaultDocumentation.Markdown.DocItemGenerators +T:DefaultDocumentation.Markdown.DocItemGenerators.ExcludeGenerator|DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/index.md|ExcludeGenerator +F:DefaultDocumentation.Markdown.DocItemGenerators.OverloadsGenerator.ConfigName|DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/ConfigName.md|ConfigName +P:DefaultDocumentation.Markdown.DocItemGenerators.OverloadsGenerator.Name|DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/Name.md|Name +M:DefaultDocumentation.Markdown.DocItemGenerators.OverloadsGenerator.Generate(DefaultDocumentation.IDocItemsContext)|DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/Generate(IDocItemsContext).md|Generate(IDocItemsContext) +T:DefaultDocumentation.Markdown.DocItemGenerators.OverloadsGenerator|DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/index.md|OverloadsGenerator +F:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.None|DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.None|None +F:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.Grouped|DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.Grouped|Grouped +F:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeKind|DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeKind|IncludeKind +F:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummary|DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummary|IncludeSummary +F:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeNewLine|DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeNewLine|IncludeNewLine +F:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummaryWithNewLine|DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummaryWithNewLine|IncludeSummaryWithNewLine +T:DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes|DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md|Modes +M:DefaultDocumentation.Api.IWriterExtensions.AppendLink|DefaultDocumentation/Api/IWriterExtensions/AppendLink.md|AppendLink diff --git a/documentation/NEXT_RELEASENOTES.txt b/documentation/NEXT_RELEASENOTES.txt index 11b9698a..716e8131 100644 --- a/documentation/NEXT_RELEASENOTES.txt +++ b/documentation/NEXT_RELEASENOTES.txt @@ -11,6 +11,7 @@ - added OverloadsGenerator to put constructor and method overloads in the same page (closes #139) - added ExcludeGenerator to exclude DocItem from the documentation generation based on regex (closes #160) - list code and note elements now display a placeholder value `...` when displayed as a single line +- added DirectoryName IFileNameFactory implementation (closes #104) ## Bug fixes diff --git a/documentation/api/AssemblyDocItem.AssemblyDocItem(string,string,XElement).md b/documentation/api/AssemblyDocItem.AssemblyDocItem(string,string,XElement).md deleted file mode 100644 index 4d4dcd34..00000000 --- a/documentation/api/AssemblyDocItem.AssemblyDocItem(string,string,XElement).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models').[AssemblyDocItem](AssemblyDocItem.md 'DefaultDocumentation.Models.AssemblyDocItem') - -## AssemblyDocItem(string, string, XElement) Constructor - -Initialize a new instance of the [AssemblyDocItem](AssemblyDocItem.md 'DefaultDocumentation.Models.AssemblyDocItem') type. - -```csharp -public AssemblyDocItem(string fullName, string name, System.Xml.Linq.XElement? documentation); -``` -#### Parameters - - - -`fullName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The full name of the assembly. - - - -`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The name of the assemby. - - - -`documentation` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') documentation element of the assembly. \ No newline at end of file diff --git a/documentation/api/AssemblyDocItem.md b/documentation/api/AssemblyDocItem.md deleted file mode 100644 index 392512d7..00000000 --- a/documentation/api/AssemblyDocItem.md +++ /dev/null @@ -1,16 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models') - -## AssemblyDocItem Class - -Represents an assembly documentation. - -```csharp -public sealed class AssemblyDocItem : DefaultDocumentation.Models.DocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 AssemblyDocItem - -| Constructors | | -| :--- | :--- | -| [AssemblyDocItem(string, string, XElement)](AssemblyDocItem.AssemblyDocItem(string,string,XElement).md 'DefaultDocumentation.Models.AssemblyDocItem.AssemblyDocItem(string, string, System.Xml.Linq.XElement)') | Initialize a new instance of the [AssemblyDocItem](AssemblyDocItem.md 'DefaultDocumentation.Models.AssemblyDocItem') type. | diff --git a/documentation/api/ClassDocItem.ClassDocItem(DocItem,ITypeDefinition,XElement).md b/documentation/api/ClassDocItem.ClassDocItem(DocItem,ITypeDefinition,XElement).md deleted file mode 100644 index af0afffc..00000000 --- a/documentation/api/ClassDocItem.ClassDocItem(DocItem,ITypeDefinition,XElement).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Types](index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation.Models.Types').[ClassDocItem](ClassDocItem.md 'DefaultDocumentation.Models.Types.ClassDocItem') - -## ClassDocItem(DocItem, ITypeDefinition, XElement) Constructor - -Initialize a new instance of the [ClassDocItem](ClassDocItem.md 'DefaultDocumentation.Models.Types.ClassDocItem') type. - -```csharp -public ClassDocItem(DefaultDocumentation.Models.DocItem parent, ITypeDefinition type, System.Xml.Linq.XElement? documentation); -``` -#### Parameters - - - -`parent` [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') parent type or namespace of the class. - - - -`type` [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') - -The [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') of the class. - - - -`documentation` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') documentation element of the class. \ No newline at end of file diff --git a/documentation/api/ClassDocItem.md b/documentation/api/ClassDocItem.md deleted file mode 100644 index aa6442df..00000000 --- a/documentation/api/ClassDocItem.md +++ /dev/null @@ -1,16 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Types](index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation.Models.Types') - -## ClassDocItem Class - -Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') of the [TypeKind.Class](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.TypeKind.Class') kind documentation. - -```csharp -public sealed class ClassDocItem : DefaultDocumentation.Models.Types.TypeDocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 [EntityDocItem](EntityDocItem.md 'DefaultDocumentation.Models.EntityDocItem') 🡒 [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') 🡒 ClassDocItem - -| Constructors | | -| :--- | :--- | -| [ClassDocItem(DocItem, ITypeDefinition, XElement)](ClassDocItem.ClassDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation.Models.Types.ClassDocItem.ClassDocItem(DefaultDocumentation.Models.DocItem, ITypeDefinition, System.Xml.Linq.XElement)') | Initialize a new instance of the [ClassDocItem](ClassDocItem.md 'DefaultDocumentation.Models.Types.ClassDocItem') type. | diff --git a/documentation/api/ConstructorDocItem.ConstructorDocItem(TypeDocItem,IMethod,XElement).md b/documentation/api/ConstructorDocItem.ConstructorDocItem(TypeDocItem,IMethod,XElement).md deleted file mode 100644 index 687db6a5..00000000 --- a/documentation/api/ConstructorDocItem.ConstructorDocItem(TypeDocItem,IMethod,XElement).md +++ /dev/null @@ -1,34 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[ConstructorDocItem](ConstructorDocItem.md 'DefaultDocumentation.Models.Members.ConstructorDocItem') - -## ConstructorDocItem(TypeDocItem, IMethod, XElement) Constructor - -Initialize a new instance of the [ConstructorDocItem](ConstructorDocItem.md 'DefaultDocumentation.Models.Members.ConstructorDocItem') type. - -```csharp -public ConstructorDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, IMethod method, System.Xml.Linq.XElement? documentation); -``` -#### Parameters - - - -`parent` [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') - -The [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') parent type of the constructor. - - - -`method` [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') - -The [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') of the constructor. - - - -`documentation` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') documentation element of the constructor. - -#### Exceptions - -[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') -[parent](ConstructorDocItem.ConstructorDocItem(TypeDocItem,IMethod,XElement).md#DefaultDocumentation.Models.Members.ConstructorDocItem.ConstructorDocItem(DefaultDocumentation.Models.Types.TypeDocItem,IMethod,System.Xml.Linq.XElement).parent 'DefaultDocumentation.Models.Members.ConstructorDocItem.ConstructorDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IMethod, System.Xml.Linq.XElement).parent') or [method](ConstructorDocItem.ConstructorDocItem(TypeDocItem,IMethod,XElement).md#DefaultDocumentation.Models.Members.ConstructorDocItem.ConstructorDocItem(DefaultDocumentation.Models.Types.TypeDocItem,IMethod,System.Xml.Linq.XElement).method 'DefaultDocumentation.Models.Members.ConstructorDocItem.ConstructorDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IMethod, System.Xml.Linq.XElement).method') is null. \ No newline at end of file diff --git a/documentation/api/ConstructorDocItem.Method.md b/documentation/api/ConstructorDocItem.Method.md deleted file mode 100644 index 8fb206b5..00000000 --- a/documentation/api/ConstructorDocItem.Method.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[ConstructorDocItem](ConstructorDocItem.md 'DefaultDocumentation.Models.Members.ConstructorDocItem') - -## ConstructorDocItem.Method Property - -Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') of the current instance. - -```csharp -public IMethod Method { get; } -``` - -#### Property Value -[IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') \ No newline at end of file diff --git a/documentation/api/ConstructorDocItem.Parameters.md b/documentation/api/ConstructorDocItem.Parameters.md deleted file mode 100644 index ec65070e..00000000 --- a/documentation/api/ConstructorDocItem.Parameters.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[ConstructorDocItem](ConstructorDocItem.md 'DefaultDocumentation.Models.Members.ConstructorDocItem') - -## ConstructorDocItem.Parameters Property - -Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. - -```csharp -public System.Collections.Generic.IEnumerable Parameters { get; } -``` - -Implements [Parameters](IParameterizedDocItem.Parameters.md 'DefaultDocumentation.Models.IParameterizedDocItem.Parameters') - -#### Property Value -[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') \ No newline at end of file diff --git a/documentation/api/ConstructorDocItem.md b/documentation/api/ConstructorDocItem.md deleted file mode 100644 index e567ec3c..00000000 --- a/documentation/api/ConstructorDocItem.md +++ /dev/null @@ -1,24 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members') - -## ConstructorDocItem Class - -Represents a constructor [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') documentation. - -```csharp -public sealed class ConstructorDocItem : DefaultDocumentation.Models.EntityDocItem, -DefaultDocumentation.Models.IParameterizedDocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 [EntityDocItem](EntityDocItem.md 'DefaultDocumentation.Models.EntityDocItem') 🡒 ConstructorDocItem - -Implements [IParameterizedDocItem](IParameterizedDocItem.md 'DefaultDocumentation.Models.IParameterizedDocItem') - -| Constructors | | -| :--- | :--- | -| [ConstructorDocItem(TypeDocItem, IMethod, XElement)](ConstructorDocItem.ConstructorDocItem(TypeDocItem,IMethod,XElement).md 'DefaultDocumentation.Models.Members.ConstructorDocItem.ConstructorDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IMethod, System.Xml.Linq.XElement)') | Initialize a new instance of the [ConstructorDocItem](ConstructorDocItem.md 'DefaultDocumentation.Models.Members.ConstructorDocItem') type. | - -| Properties | | -| :--- | :--- | -| [Method](ConstructorDocItem.Method.md 'DefaultDocumentation.Models.Members.ConstructorDocItem.Method') | Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') of the current instance. | -| [Parameters](ConstructorDocItem.Parameters.md 'DefaultDocumentation.Models.Members.ConstructorDocItem.Parameters') | Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. | diff --git a/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/Generate(IDocItemsContext).md b/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/Generate(IDocItemsContext).md new file mode 100644 index 00000000..7a05f81e --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/Generate(IDocItemsContext).md @@ -0,0 +1,17 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IDocItemGenerator](index.md 'DefaultDocumentation\.Api\.IDocItemGenerator') + +## IDocItemGenerator\.Generate\(IDocItemsContext\) Method + +Modified the known [DocItem](../../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') of the [IDocItemsContext](../../IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext')\. + +```csharp +void Generate(DefaultDocumentation.IDocItemsContext context); +``` +#### Parameters + + + +`context` [IDocItemsContext](../../IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext') + +The [IDocItemsContext](../../IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext') of the documentation generation\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/Name.md b/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/Name.md new file mode 100644 index 00000000..c3a59b99 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/Name.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IDocItemGenerator](index.md 'DefaultDocumentation\.Api\.IDocItemGenerator') + +## IDocItemGenerator\.Name Property + +Gets the name of the generator, used to identify it at the configuration level\. + +```csharp +string Name { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/index.md b/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/index.md new file mode 100644 index 00000000..d0fb937c --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/index.md @@ -0,0 +1,18 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api') + +## IDocItemGenerator Interface + +Exposes a method to generate the known [DocItem](../../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') of the documentation\. + +```csharp +public interface IDocItemGenerator +``` + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Api\.IDocItemGenerator\.Name') | Gets the name of the generator, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Generate\(IDocItemsContext\)](Generate(IDocItemsContext).md 'DefaultDocumentation\.Api\.IDocItemGenerator\.Generate\(DefaultDocumentation\.IDocItemsContext\)') | Modified the known [DocItem](../../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') of the [IDocItemsContext](../../IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext')\. | diff --git a/documentation/api/DefaultDocumentation/Api/IElement/Name.md b/documentation/api/DefaultDocumentation/Api/IElement/Name.md new file mode 100644 index 00000000..0e085f06 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IElement/Name.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IElement](index.md 'DefaultDocumentation\.Api\.IElement') + +## IElement\.Name Property + +Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + +```csharp +string Name { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/IElement/Write(IWriter,XElement).md b/documentation/api/DefaultDocumentation/Api/IElement/Write(IWriter,XElement).md new file mode 100644 index 00000000..3c519405 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IElement/Write(IWriter,XElement).md @@ -0,0 +1,23 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IElement](index.md 'DefaultDocumentation\.Api\.IElement') + +## IElement\.Write\(IWriter, XElement\) Method + +Writes to a [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. + +```csharp +void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); +``` +#### Parameters + + + +`writer` [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + + + +`element` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') to write\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/IElement/index.md b/documentation/api/DefaultDocumentation/Api/IElement/index.md new file mode 100644 index 00000000..df64037a --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IElement/index.md @@ -0,0 +1,18 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api') + +## IElement Interface + +Exposes a method to handle a specific kind of [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') when writing documentation\. + +```csharp +public interface IElement +``` + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Api\.IElement\.Name') | Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter, XElement\)](Write(IWriter,XElement).md 'DefaultDocumentation\.Api\.IElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)') | Writes to a [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. | diff --git a/documentation/api/DefaultDocumentation/Api/IFileNameFactory/Clean(IGeneralContext).md b/documentation/api/DefaultDocumentation/Api/IFileNameFactory/Clean(IGeneralContext).md new file mode 100644 index 00000000..9f0fb4ca --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IFileNameFactory/Clean(IGeneralContext).md @@ -0,0 +1,17 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IFileNameFactory](index.md 'DefaultDocumentation\.Api\.IFileNameFactory') + +## IFileNameFactory\.Clean\(IGeneralContext\) Method + +Cleans the [OutputDirectory](../../ISettings/OutputDirectory.md 'DefaultDocumentation\.ISettings\.OutputDirectory') of the previously generated documentation files\. + +```csharp +void Clean(DefaultDocumentation.IGeneralContext context); +``` +#### Parameters + + + +`context` [IGeneralContext](../../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](../../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/IFileNameFactory/GetFileName(IGeneralContext,DocItem).md b/documentation/api/DefaultDocumentation/Api/IFileNameFactory/GetFileName(IGeneralContext,DocItem).md new file mode 100644 index 00000000..b9d5bc6e --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IFileNameFactory/GetFileName(IGeneralContext,DocItem).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IFileNameFactory](index.md 'DefaultDocumentation\.Api\.IFileNameFactory') + +## IFileNameFactory\.GetFileName\(IGeneralContext, DocItem\) Method + +Gets the documentation file name for the given [DocItem](../../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +string GetFileName(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](../../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](../../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](../../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](../../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to get the documentation file name\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +The documentation file name of the given [DocItem](../../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/IFileNameFactory/Name.md b/documentation/api/DefaultDocumentation/Api/IFileNameFactory/Name.md new file mode 100644 index 00000000..84a49ba7 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IFileNameFactory/Name.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IFileNameFactory](index.md 'DefaultDocumentation\.Api\.IFileNameFactory') + +## IFileNameFactory\.Name Property + +Gets the name of the factory, used to identify it at the configuration level\. + +```csharp +string Name { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/IFileNameFactory/index.md b/documentation/api/DefaultDocumentation/Api/IFileNameFactory/index.md new file mode 100644 index 00000000..ba196c93 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IFileNameFactory/index.md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api') + +## IFileNameFactory Interface + +Exposes methods related to the documentation files cleaning and creation\. + +```csharp +public interface IFileNameFactory +``` + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Api\.IFileNameFactory\.Name') | Gets the name of the factory, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Clean\(IGeneralContext\)](Clean(IGeneralContext).md 'DefaultDocumentation\.Api\.IFileNameFactory\.Clean\(DefaultDocumentation\.IGeneralContext\)') | Cleans the [OutputDirectory](../../ISettings/OutputDirectory.md 'DefaultDocumentation\.ISettings\.OutputDirectory') of the previously generated documentation files\. | +| [GetFileName\(IGeneralContext, DocItem\)](GetFileName(IGeneralContext,DocItem).md 'DefaultDocumentation\.Api\.IFileNameFactory\.GetFileName\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the documentation file name for the given [DocItem](../../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. | diff --git a/documentation/api/DefaultDocumentation/Api/ISection/Name.md b/documentation/api/DefaultDocumentation/Api/ISection/Name.md new file mode 100644 index 00000000..e2b0a5c7 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/ISection/Name.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[ISection](index.md 'DefaultDocumentation\.Api\.ISection') + +## ISection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +string Name { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md b/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md new file mode 100644 index 00000000..e5a3c409 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md @@ -0,0 +1,17 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[ISection](index.md 'DefaultDocumentation\.Api\.ISection') + +## ISection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/ISection/index.md b/documentation/api/DefaultDocumentation/Api/ISection/index.md new file mode 100644 index 00000000..94ae9e54 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/ISection/index.md @@ -0,0 +1,18 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api') + +## ISection Interface + +Exposes a method to write a specific section when writing documentation\. + +```csharp +public interface ISection +``` + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Api\.ISection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/api/DefaultDocumentation/Api/IUrlFactory/GetUrl(IPageContext,string).md b/documentation/api/DefaultDocumentation/Api/IUrlFactory/GetUrl(IPageContext,string).md new file mode 100644 index 00000000..35729205 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IUrlFactory/GetUrl(IPageContext,string).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IUrlFactory](index.md 'DefaultDocumentation\.Api\.IUrlFactory') + +## IUrlFactory\.GetUrl\(IPageContext, string\) Method + +Gets the url of the given id\. Returns null of the instance does not know how to handle the provided id\. + +```csharp +string? GetUrl(DefaultDocumentation.IPageContext context, string id); +``` +#### Parameters + + + +`context` [IPageContext](../../IPageContext/index.md 'DefaultDocumentation\.IPageContext') + +The [IPageContext](../../IPageContext/index.md 'DefaultDocumentation\.IPageContext') of the current documentation generation process\. + + + +`id` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The id to get the url for\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +The url of the given id\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/IUrlFactory/Name.md b/documentation/api/DefaultDocumentation/Api/IUrlFactory/Name.md new file mode 100644 index 00000000..72b81ca8 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IUrlFactory/Name.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IUrlFactory](index.md 'DefaultDocumentation\.Api\.IUrlFactory') + +## IUrlFactory\.Name Property + +Gets the name of the factory, used to identify it at the configuration level\. + +```csharp +string Name { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/IUrlFactory/index.md b/documentation/api/DefaultDocumentation/Api/IUrlFactory/index.md new file mode 100644 index 00000000..cd510fc1 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IUrlFactory/index.md @@ -0,0 +1,18 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api') + +## IUrlFactory Interface + +Exposes methods related to the documentation files url creation\. + +```csharp +public interface IUrlFactory +``` + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Api\.IUrlFactory\.Name') | Gets the name of the factory, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [GetUrl\(IPageContext, string\)](GetUrl(IPageContext,string).md 'DefaultDocumentation\.Api\.IUrlFactory\.GetUrl\(DefaultDocumentation\.IPageContext, string\)') | Gets the url of the given id\. Returns null of the instance does not know how to handle the provided id\. | diff --git a/documentation/api/DefaultDocumentation/Api/IWriter/Append(string).md b/documentation/api/DefaultDocumentation/Api/IWriter/Append(string).md new file mode 100644 index 00000000..9047c2d9 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IWriter/Append(string).md @@ -0,0 +1,21 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriter](index.md 'DefaultDocumentation\.Api\.IWriter') + +## IWriter\.Append\(string\) Method + +Appends a string at the end of the documentation text\. + +```csharp +DefaultDocumentation.Api.IWriter Append(string value); +``` +#### Parameters + + + +`value` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The value to append\. + +#### Returns +[IWriter](index.md 'DefaultDocumentation\.Api\.IWriter') +The current [IWriter](index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/IWriter/AppendLine().md b/documentation/api/DefaultDocumentation/Api/IWriter/AppendLine().md new file mode 100644 index 00000000..6cc8506f --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IWriter/AppendLine().md @@ -0,0 +1,14 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriter](index.md 'DefaultDocumentation\.Api\.IWriter') + +## IWriter\.AppendLine\(\) Method + +Appends a [System\.Environment\.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System\.Environment\.NewLine') at the end of the documentation text\. + +```csharp +DefaultDocumentation.Api.IWriter AppendLine(); +``` + +#### Returns +[IWriter](index.md 'DefaultDocumentation\.Api\.IWriter') +The current [IWriter](index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/IWriter/Context.md b/documentation/api/DefaultDocumentation/Api/IWriter/Context.md new file mode 100644 index 00000000..2b959e6d --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IWriter/Context.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriter](index.md 'DefaultDocumentation\.Api\.IWriter') + +## IWriter\.Context Property + +Gets the [IPageContext](../../IPageContext/index.md 'DefaultDocumentation\.IPageContext') of the current documentation generation process\. + +```csharp +DefaultDocumentation.IPageContext Context { get; } +``` + +#### Property Value +[IPageContext](../../IPageContext/index.md 'DefaultDocumentation\.IPageContext') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/IWriter/EndsWith(string).md b/documentation/api/DefaultDocumentation/Api/IWriter/EndsWith(string).md new file mode 100644 index 00000000..d38a1d45 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IWriter/EndsWith(string).md @@ -0,0 +1,21 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriter](index.md 'DefaultDocumentation\.Api\.IWriter') + +## IWriter\.EndsWith\(string\) Method + +Returns whether the documentation text ends with the given string\. + +```csharp +bool EndsWith(string value); +``` +#### Parameters + + + +`value` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') to check\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs\.microsoft\.com/en\-us/dotnet/csharp/language\-reference/builtin\-types/bool') if the documentation text ends with [value](DefaultDocumentation/Api/IWriter/EndsWith(string).md#DefaultDocumentation.Api.IWriter.EndsWith(string).value 'DefaultDocumentation\.Api\.IWriter\.EndsWith\(string\)\.value'), else [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs\.microsoft\.com/en\-us/dotnet/csharp/language\-reference/builtin\-types/bool')\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/IWriter/Length.md b/documentation/api/DefaultDocumentation/Api/IWriter/Length.md new file mode 100644 index 00000000..42c6bf65 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IWriter/Length.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriter](index.md 'DefaultDocumentation\.Api\.IWriter') + +## IWriter\.Length Property + +Gets or sets the length of the documentation text currently produced\. + +```csharp +int Length { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/IWriter/index.md b/documentation/api/DefaultDocumentation/Api/IWriter/index.md new file mode 100644 index 00000000..7ceadfc3 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IWriter/index.md @@ -0,0 +1,21 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api') + +## IWriter Interface + +Exposes properties and methods use to generate a documentation file for a specific [DocItem](../../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public interface IWriter +``` + +| Properties | | +| :--- | :--- | +| [Context](Context.md 'DefaultDocumentation\.Api\.IWriter\.Context') | Gets the [IPageContext](../../IPageContext/index.md 'DefaultDocumentation\.IPageContext') of the current documentation generation process\. | +| [Length](Length.md 'DefaultDocumentation\.Api\.IWriter\.Length') | Gets or sets the length of the documentation text currently produced\. | + +| Methods | | +| :--- | :--- | +| [Append\(string\)](Append(string).md 'DefaultDocumentation\.Api\.IWriter\.Append\(string\)') | Appends a string at the end of the documentation text\. | +| [AppendLine\(\)](AppendLine().md 'DefaultDocumentation\.Api\.IWriter\.AppendLine\(\)') | Appends a [System\.Environment\.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System\.Environment\.NewLine') at the end of the documentation text\. | +| [EndsWith\(string\)](EndsWith(string).md 'DefaultDocumentation\.Api\.IWriter\.EndsWith\(string\)') | Returns whether the documentation text ends with the given string\. | diff --git a/documentation/api/DefaultDocumentation/Api/IWriterExtensions/Append(thisIWriter,XElement).md b/documentation/api/DefaultDocumentation/Api/IWriterExtensions/Append(thisIWriter,XElement).md new file mode 100644 index 00000000..36c6ca02 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IWriterExtensions/Append(thisIWriter,XElement).md @@ -0,0 +1,28 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.Append\(this IWriter, XElement\) Method + +Appends an [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') to a [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') by using the [Elements](../../IGeneralContext/Elements.md 'DefaultDocumentation\.IGeneralContext\.Elements') of [Context](../IWriter/Context.md 'DefaultDocumentation\.Api\.IWriter\.Context')\. +If no [IElement](../IElement/index.md 'DefaultDocumentation\.Api\.IElement') is found, the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') is appended as text directly\. + +```csharp +public static DefaultDocumentation.Api.IWriter Append(this DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement? value); +``` +#### Parameters + + + +`writer` [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to append to\. + + + +`value` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') to append\. + +#### Returns +[IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The given [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/IWriterExtensions/AppendFormat(thisIWriter,string,object[]).md b/documentation/api/DefaultDocumentation/Api/IWriterExtensions/AppendFormat(thisIWriter,string,object[]).md new file mode 100644 index 00000000..52aab17e --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IWriterExtensions/AppendFormat(thisIWriter,string,object[]).md @@ -0,0 +1,33 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.AppendFormat\(this IWriter, string, object\[\]\) Method + +Appends a formatted string to a [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public static DefaultDocumentation.Api.IWriter AppendFormat(this DefaultDocumentation.Api.IWriter writer, string format, params object?[] args); +``` +#### Parameters + + + +`writer` [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to append to\. + + + +`format` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The format to use\. + + + +`args` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') + +The arguments to use in the format\. + +#### Returns +[IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The given [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/IWriterExtensions/AppendLine(thisIWriter,string).md b/documentation/api/DefaultDocumentation/Api/IWriterExtensions/AppendLine(thisIWriter,string).md new file mode 100644 index 00000000..7e648f99 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IWriterExtensions/AppendLine(thisIWriter,string).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.AppendLine\(this IWriter, string\) Method + +Appends a line after writing the provided [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')\. + +```csharp +public static DefaultDocumentation.Api.IWriter AppendLine(this DefaultDocumentation.Api.IWriter writer, string value); +``` +#### Parameters + + + +`writer` [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to append to\. + + + +`value` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') to append before the line\. + +#### Returns +[IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The given [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/IWriterExtensions/TrimEnd(thisIWriter,string[]).md b/documentation/api/DefaultDocumentation/Api/IWriterExtensions/TrimEnd(thisIWriter,string[]).md new file mode 100644 index 00000000..71017ada --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IWriterExtensions/TrimEnd(thisIWriter,string[]).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.TrimEnd\(this IWriter, string\[\]\) Method + +Trims from the end of a [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') all the provided values\. + +```csharp +public static DefaultDocumentation.Api.IWriter TrimEnd(this DefaultDocumentation.Api.IWriter writer, params string[] values); +``` +#### Parameters + + + +`writer` [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to trim\. + + + +`values` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') + +The [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') values to trim from the end\. + +#### Returns +[IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The given [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Api/IWriterExtensions/index.md b/documentation/api/DefaultDocumentation/Api/IWriterExtensions/index.md new file mode 100644 index 00000000..7060272f --- /dev/null +++ b/documentation/api/DefaultDocumentation/Api/IWriterExtensions/index.md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api') + +## IWriterExtensions Class + +Provides extension methods on the [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') type\. + +```csharp +public static class IWriterExtensions +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 IWriterExtensions + +| Methods | | +| :--- | :--- | +| [Append\(this IWriter, XElement\)](Append(thisIWriter,XElement).md 'DefaultDocumentation\.Api\.IWriterExtensions\.Append\(this DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)') | Appends an [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') to a [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') by using the [Elements](../../IGeneralContext/Elements.md 'DefaultDocumentation\.IGeneralContext\.Elements') of [Context](../IWriter/Context.md 'DefaultDocumentation\.Api\.IWriter\.Context')\. If no [IElement](../IElement/index.md 'DefaultDocumentation\.Api\.IElement') is found, the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') is appended as text directly\. | +| [AppendFormat\(this IWriter, string, object\[\]\)](AppendFormat(thisIWriter,string,object[]).md 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendFormat\(this DefaultDocumentation\.Api\.IWriter, string, object\[\]\)') | Appends a formatted string to a [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | +| [AppendLine\(this IWriter, string\)](AppendLine(thisIWriter,string).md 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendLine\(this DefaultDocumentation\.Api\.IWriter, string\)') | Appends a line after writing the provided [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')\. | +| [TrimEnd\(this IWriter, string\[\]\)](TrimEnd(thisIWriter,string[]).md 'DefaultDocumentation\.Api\.IWriterExtensions\.TrimEnd\(this DefaultDocumentation\.Api\.IWriter, string\[\]\)') | Trims from the end of a [IWriter](../IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') all the provided values\. | diff --git a/documentation/api/DefaultDocumentation/GeneratedAccessModifiers/index.md b/documentation/api/DefaultDocumentation/GeneratedAccessModifiers/index.md new file mode 100644 index 00000000..118e426e --- /dev/null +++ b/documentation/api/DefaultDocumentation/GeneratedAccessModifiers/index.md @@ -0,0 +1,59 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation') + +## GeneratedAccessModifiers Enum + +Specifies a combination of access modifiers\. + +```csharp +public enum GeneratedAccessModifiers +``` +### Fields + + + +`Default` 0 + +Generates documentation for all access modifiers\. + + + +`Public` 1 + +Generates documentation for 'public' access modifier\. + + + +`Private` 2 + +Generates documentation for 'private' access modifier\. + + + +`Protected` 4 + +Generates documentation for 'protected' access modifier\. + + + +`Internal` 8 + +Generates documentation for 'internal' access modifier\. + + + +`ProtectedInternal` 16 + +Generates documentation for 'protected internal' access modifier\. + + + +`PrivateProtected` 32 + +Generates documentation for 'private protected' access modifier\. + + + +`Api` 21 + +Generates documentation for 'public', 'protected' and 'protected internal' access modifier\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/GeneratedPages/index.md b/documentation/api/DefaultDocumentation/GeneratedPages/index.md new file mode 100644 index 00000000..0971855d --- /dev/null +++ b/documentation/api/DefaultDocumentation/GeneratedPages/index.md @@ -0,0 +1,113 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation') + +## GeneratedPages Enum + +Specifies a combination of page kinds\. + +```csharp +public enum GeneratedPages +``` +### Fields + + + +`Default` 0 + +Generates all documentation page kinds\. + + + +`Assembly` 1 + +Generates documentation page for the assembly\. + + + +`Namespaces` 2 + +Generates documentation pages for the namespaces\. + + + +`Classes` 4 + +Generates documentation pages for the classes\. + + + +`Delegates` 8 + +Generates documentation pages for the delegates\. + + + +`Enums` 16 + +Generates documentation pages for the enums\. + + + +`Structs` 32 + +Generates documentation pages for the structs\. + + + +`Interfaces` 64 + +Generates documentation pages for the interfaces\. + + + +`Types` 124 + +Generates documentation pages for all type kinds \(class, delegate, enum, struct, interface\)\. + + + +`Constructors` 128 + +Generates documentation pages for the constructors\. + + + +`Events` 256 + +Generates documentation pages for the events\. + + + +`Fields` 512 + +Generates documentation pages for the fields\. + + + +`Methods` 1024 + +Generates documentation pages for the methods\. + + + +`Operators` 2048 + +Generates documentation pages for the operators\. + + + +`Properties` 4096 + +Generates documentation pages for the properties\. + + + +`ExplicitInterfaceImplementations` 8192 + +Generates documentation pages for the explicit interface implementations\. + + + +`Members` 16256 + +Generates documentation pages for all member kinds \(constructor, event, field, method, operator, property, explicit interface implementation\)\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IContext/FileNameFactory.md b/documentation/api/DefaultDocumentation/IContext/FileNameFactory.md new file mode 100644 index 00000000..0fe96eb2 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IContext/FileNameFactory.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IContext](index.md 'DefaultDocumentation\.IContext') + +## IContext\.FileNameFactory Property + +Gets the [IFileNameFactory](../Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory') to use to generate a file for a documentation page\. + +```csharp +DefaultDocumentation.Api.IFileNameFactory? FileNameFactory { get; } +``` + +#### Property Value +[IFileNameFactory](../Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IContext/GetSetting_T_(string).md b/documentation/api/DefaultDocumentation/IContext/GetSetting_T_(string).md new file mode 100644 index 00000000..f5f035e1 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IContext/GetSetting_T_(string).md @@ -0,0 +1,28 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IContext](index.md 'DefaultDocumentation\.IContext') + +## IContext\.GetSetting\\(string\) Method + +Gets a [T](DefaultDocumentation/IContext/GetSetting_T_(string).md#DefaultDocumentation.IContext.GetSetting_T_(string).T 'DefaultDocumentation\.IContext\.GetSetting\\(string\)\.T') setting with the given name\. + +```csharp +T? GetSetting(string name); +``` +#### Type parameters + + + +`T` + +The type of the setting to get\. +#### Parameters + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The name of the setting to get\. + +#### Returns +[T](DefaultDocumentation/IContext/GetSetting_T_(string).md#DefaultDocumentation.IContext.GetSetting_T_(string).T 'DefaultDocumentation\.IContext\.GetSetting\\(string\)\.T') +The setting if present, otherwise the default value of the type [T](DefaultDocumentation/IContext/GetSetting_T_(string).md#DefaultDocumentation.IContext.GetSetting_T_(string).T 'DefaultDocumentation\.IContext\.GetSetting\\(string\)\.T')\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IContext/Sections.md b/documentation/api/DefaultDocumentation/IContext/Sections.md new file mode 100644 index 00000000..3f103928 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IContext/Sections.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IContext](index.md 'DefaultDocumentation\.IContext') + +## IContext\.Sections Property + +Gets the [ISection](../Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') to use to generate a documentation page\. + +```csharp +System.Collections.Generic.IEnumerable? Sections { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[ISection](../Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IContext/index.md b/documentation/api/DefaultDocumentation/IContext/index.md new file mode 100644 index 00000000..b380f7d3 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IContext/index.md @@ -0,0 +1,23 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation') + +## IContext Interface + +Exposes settings used to generate documentation for a given [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') type\. + +```csharp +public interface IContext +``` + +Derived +↳ [IGeneralContext](../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') +↳ [IPageContext](../IPageContext/index.md 'DefaultDocumentation\.IPageContext') + +| Properties | | +| :--- | :--- | +| [FileNameFactory](FileNameFactory.md 'DefaultDocumentation\.IContext\.FileNameFactory') | Gets the [IFileNameFactory](../Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory') to use to generate a file for a documentation page\. | +| [Sections](Sections.md 'DefaultDocumentation\.IContext\.Sections') | Gets the [ISection](../Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') to use to generate a documentation page\. | + +| Methods | | +| :--- | :--- | +| [GetSetting<T>\(string\)](GetSetting_T_(string).md 'DefaultDocumentation\.IContext\.GetSetting\\(string\)') | Gets a [T](GetSetting_T_(string).md#DefaultDocumentation.IContext.GetSetting_T_(string).T 'DefaultDocumentation\.IContext\.GetSetting\\(string\)\.T') setting with the given name\. | diff --git a/documentation/api/DefaultDocumentation/IDocItemsContext/GetSetting.md b/documentation/api/DefaultDocumentation/IDocItemsContext/GetSetting.md new file mode 100644 index 00000000..5b97f050 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IDocItemsContext/GetSetting.md @@ -0,0 +1,71 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IDocItemsContext](index.md 'DefaultDocumentation\.IDocItemsContext') + +## IDocItemsContext\.GetSetting Method + +| Overloads | | +| :--- | :--- | +| [GetSetting<T>\(string\)](DefaultDocumentation/IDocItemsContext/GetSetting.md#DefaultDocumentation.IDocItemsContext.GetSetting_T_(string) 'DefaultDocumentation\.IDocItemsContext\.GetSetting\\(string\)') | Gets a [T](index.md#DefaultDocumentation.IDocItemsContext.GetSetting_T_(string).T 'DefaultDocumentation\.IDocItemsContext\.GetSetting\\(string\)\.T') setting with the given name\. | +| [GetSetting<T>\(Type, string\)](DefaultDocumentation/IDocItemsContext/GetSetting.md#DefaultDocumentation.IDocItemsContext.GetSetting_T_(System.Type,string) 'DefaultDocumentation\.IDocItemsContext\.GetSetting\\(System\.Type, string\)') | Gets a [T](index.md#DefaultDocumentation.IDocItemsContext.GetSetting_T_(System.Type,string).T 'DefaultDocumentation\.IDocItemsContext\.GetSetting\\(System\.Type, string\)\.T') setting with the given name for the given [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')[System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type')\. | + + + +## IDocItemsContext\.GetSetting\\(string\) Method + +Gets a [T](index.md#DefaultDocumentation.IDocItemsContext.GetSetting_T_(string).T 'DefaultDocumentation\.IDocItemsContext\.GetSetting\\(string\)\.T') setting with the given name\. + +```csharp +T? GetSetting(string name); +``` +#### Type parameters + + + +`T` + +The type of the setting to get\. +#### Parameters + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The name of the setting to get\. + +#### Returns +[T](index.md#DefaultDocumentation.IDocItemsContext.GetSetting_T_(string).T 'DefaultDocumentation\.IDocItemsContext\.GetSetting\\(string\)\.T') +The setting if present, otherwise the default value of the type [T](index.md#DefaultDocumentation.IDocItemsContext.GetSetting_T_(string).T 'DefaultDocumentation\.IDocItemsContext\.GetSetting\\(string\)\.T')\. + + + +## IDocItemsContext\.GetSetting\\(Type, string\) Method + +Gets a [T](index.md#DefaultDocumentation.IDocItemsContext.GetSetting_T_(System.Type,string).T 'DefaultDocumentation\.IDocItemsContext\.GetSetting\\(System\.Type, string\)\.T') setting with the given name for the given [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')[System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type')\. + +```csharp +T? GetSetting(System.Type? type, string name); +``` +#### Type parameters + + + +`T` + +The type of the setting to get\. +#### Parameters + + + +`type` [System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') + +The [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')[System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') for which to get the specific setting\. + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The name of the setting to get\. + +#### Returns +[T](index.md#DefaultDocumentation.IDocItemsContext.GetSetting_T_(System.Type,string).T 'DefaultDocumentation\.IDocItemsContext\.GetSetting\\(System\.Type, string\)\.T') +The setting if present, otherwise the default value of the type [T](index.md#DefaultDocumentation.IDocItemsContext.GetSetting_T_(System.Type,string).T 'DefaultDocumentation\.IDocItemsContext\.GetSetting\\(System\.Type, string\)\.T')\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IDocItemsContext/Items.md b/documentation/api/DefaultDocumentation/IDocItemsContext/Items.md new file mode 100644 index 00000000..d7f83aad --- /dev/null +++ b/documentation/api/DefaultDocumentation/IDocItemsContext/Items.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IDocItemsContext](index.md 'DefaultDocumentation\.IDocItemsContext') + +## IDocItemsContext\.Items Property + +Gets all the [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') known by this documentation generation context\. + +```csharp +System.Collections.Generic.IDictionary Items { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.IDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System\.Collections\.Generic\.IDictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System\.Collections\.Generic\.IDictionary\`2')[DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System\.Collections\.Generic\.IDictionary\`2') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IDocItemsContext/ItemsWithOwnPage.md b/documentation/api/DefaultDocumentation/IDocItemsContext/ItemsWithOwnPage.md new file mode 100644 index 00000000..f6740082 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IDocItemsContext/ItemsWithOwnPage.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IDocItemsContext](index.md 'DefaultDocumentation\.IDocItemsContext') + +## IDocItemsContext\.ItemsWithOwnPage Property + +Gets all the [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') that should generate their own documentation page\. + +```csharp +System.Collections.Generic.ICollection ItemsWithOwnPage { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IDocItemsContext/Settings.md b/documentation/api/DefaultDocumentation/IDocItemsContext/Settings.md new file mode 100644 index 00000000..26c33208 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IDocItemsContext/Settings.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IDocItemsContext](index.md 'DefaultDocumentation\.IDocItemsContext') + +## IDocItemsContext\.Settings Property + +Gets the [ISettings](../ISettings/index.md 'DefaultDocumentation\.ISettings') of this documentation generation context\. + +```csharp +DefaultDocumentation.ISettings Settings { get; } +``` + +#### Property Value +[ISettings](../ISettings/index.md 'DefaultDocumentation\.ISettings') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IDocItemsContext/index.md b/documentation/api/DefaultDocumentation/IDocItemsContext/index.md new file mode 100644 index 00000000..c05ec9f7 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IDocItemsContext/index.md @@ -0,0 +1,21 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation') + +## IDocItemsContext Interface + +Exposes properties and methods used to impact the [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') that will be generated, used by [IDocItemGenerator](../Api/IDocItemGenerator/index.md 'DefaultDocumentation\.Api\.IDocItemGenerator') + +```csharp +public interface IDocItemsContext +``` + +| Properties | | +| :--- | :--- | +| [Items](Items.md 'DefaultDocumentation\.IDocItemsContext\.Items') | Gets all the [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') known by this documentation generation context\. | +| [ItemsWithOwnPage](ItemsWithOwnPage.md 'DefaultDocumentation\.IDocItemsContext\.ItemsWithOwnPage') | Gets all the [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') that should generate their own documentation page\. | +| [Settings](Settings.md 'DefaultDocumentation\.IDocItemsContext\.Settings') | Gets the [ISettings](../ISettings/index.md 'DefaultDocumentation\.ISettings') of this documentation generation context\. | + +| Methods | | +| :--- | :--- | +| [GetSetting<T>\(string\)](GetSetting.md#DefaultDocumentation.IDocItemsContext.GetSetting_T_(string) 'DefaultDocumentation\.IDocItemsContext\.GetSetting\\(string\)') | Gets a [T](DefaultDocumentation/IDocItemsContext/index.md#DefaultDocumentation.IDocItemsContext.GetSetting_T_(string).T 'DefaultDocumentation\.IDocItemsContext\.GetSetting\\(string\)\.T') setting with the given name\. | +| [GetSetting<T>\(Type, string\)](GetSetting.md#DefaultDocumentation.IDocItemsContext.GetSetting_T_(System.Type,string) 'DefaultDocumentation\.IDocItemsContext\.GetSetting\\(System\.Type, string\)') | Gets a [T](DefaultDocumentation/IDocItemsContext/index.md#DefaultDocumentation.IDocItemsContext.GetSetting_T_(System.Type,string).T 'DefaultDocumentation\.IDocItemsContext\.GetSetting\\(System\.Type, string\)\.T') setting with the given name for the given [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')[System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type')\. | diff --git a/documentation/api/DefaultDocumentation/IGeneralContext/Elements.md b/documentation/api/DefaultDocumentation/IGeneralContext/Elements.md new file mode 100644 index 00000000..04f79296 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IGeneralContext/Elements.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContext](index.md 'DefaultDocumentation\.IGeneralContext') + +## IGeneralContext\.Elements Property + +Gets the [IElement](../Api/IElement/index.md 'DefaultDocumentation\.Api\.IElement') used to render specific [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') from the documentation\. + +```csharp +System.Collections.Generic.IReadOnlyDictionary Elements { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.IReadOnlyDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyDictionary-2 'System\.Collections\.Generic\.IReadOnlyDictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyDictionary-2 'System\.Collections\.Generic\.IReadOnlyDictionary\`2')[IElement](../Api/IElement/index.md 'DefaultDocumentation\.Api\.IElement')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyDictionary-2 'System\.Collections\.Generic\.IReadOnlyDictionary\`2') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IGeneralContext/GetContext(Type).md b/documentation/api/DefaultDocumentation/IGeneralContext/GetContext(Type).md new file mode 100644 index 00000000..dc2803a5 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IGeneralContext/GetContext(Type).md @@ -0,0 +1,21 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContext](index.md 'DefaultDocumentation\.IGeneralContext') + +## IGeneralContext\.GetContext\(Type\) Method + +Gets the specific [IContext](../IContext/index.md 'DefaultDocumentation\.IContext') for the given [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')[System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type')\. + +```csharp +DefaultDocumentation.IContext GetContext(System.Type? type); +``` +#### Parameters + + + +`type` [System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') + +The [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')[System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') for which to get the specific [IContext](../IContext/index.md 'DefaultDocumentation\.IContext')\. + +#### Returns +[IContext](../IContext/index.md 'DefaultDocumentation\.IContext') +The [IContext](../IContext/index.md 'DefaultDocumentation\.IContext') specific to the provided [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')[System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type')\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IGeneralContext/GetFileName(DocItem).md b/documentation/api/DefaultDocumentation/IGeneralContext/GetFileName(DocItem).md new file mode 100644 index 00000000..e3111e95 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IGeneralContext/GetFileName(DocItem).md @@ -0,0 +1,21 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContext](index.md 'DefaultDocumentation\.IGeneralContext') + +## IGeneralContext\.GetFileName\(DocItem\) Method + +Gets the file name for the given [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +string GetFileName(DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`item` [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to get the page name\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +The file name of the documentation page of the given [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IGeneralContext/Items.md b/documentation/api/DefaultDocumentation/IGeneralContext/Items.md new file mode 100644 index 00000000..14668944 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IGeneralContext/Items.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContext](index.md 'DefaultDocumentation\.IGeneralContext') + +## IGeneralContext\.Items Property + +Gets all the [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') known by this documentation generation context\. + +```csharp +System.Collections.Generic.IReadOnlyDictionary Items { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.IReadOnlyDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyDictionary-2 'System\.Collections\.Generic\.IReadOnlyDictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyDictionary-2 'System\.Collections\.Generic\.IReadOnlyDictionary\`2')[DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyDictionary-2 'System\.Collections\.Generic\.IReadOnlyDictionary\`2') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IGeneralContext/ItemsWithOwnPage.md b/documentation/api/DefaultDocumentation/IGeneralContext/ItemsWithOwnPage.md new file mode 100644 index 00000000..df5e211e --- /dev/null +++ b/documentation/api/DefaultDocumentation/IGeneralContext/ItemsWithOwnPage.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContext](index.md 'DefaultDocumentation\.IGeneralContext') + +## IGeneralContext\.ItemsWithOwnPage Property + +Gets all the [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') that should generate their own documentation page\. + +```csharp +System.Collections.Generic.IReadOnlyCollection ItemsWithOwnPage { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.IReadOnlyCollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyCollection-1 'System\.Collections\.Generic\.IReadOnlyCollection\`1')[DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyCollection-1 'System\.Collections\.Generic\.IReadOnlyCollection\`1') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IGeneralContext/Settings.md b/documentation/api/DefaultDocumentation/IGeneralContext/Settings.md new file mode 100644 index 00000000..edf18689 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IGeneralContext/Settings.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContext](index.md 'DefaultDocumentation\.IGeneralContext') + +## IGeneralContext\.Settings Property + +Gets the [ISettings](../ISettings/index.md 'DefaultDocumentation\.ISettings') of this documentation generation context\. + +```csharp +DefaultDocumentation.ISettings Settings { get; } +``` + +#### Property Value +[ISettings](../ISettings/index.md 'DefaultDocumentation\.ISettings') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IGeneralContext/UrlFactories.md b/documentation/api/DefaultDocumentation/IGeneralContext/UrlFactories.md new file mode 100644 index 00000000..2dc8a178 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IGeneralContext/UrlFactories.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContext](index.md 'DefaultDocumentation\.IGeneralContext') + +## IGeneralContext\.UrlFactories Property + +Gets the [IUrlFactory](../Api/IUrlFactory/index.md 'DefaultDocumentation\.Api\.IUrlFactory') used to create the documentation urls\. + +```csharp +System.Collections.Generic.IEnumerable UrlFactories { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[IUrlFactory](../Api/IUrlFactory/index.md 'DefaultDocumentation\.Api\.IUrlFactory')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IGeneralContext/index.md b/documentation/api/DefaultDocumentation/IGeneralContext/index.md new file mode 100644 index 00000000..e5d4d0b2 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IGeneralContext/index.md @@ -0,0 +1,28 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation') + +## IGeneralContext Interface + +Exposes settings used to generate documentation\. + +```csharp +public interface IGeneralContext : DefaultDocumentation.IContext +``` + +Derived +↳ [IPageContext](../IPageContext/index.md 'DefaultDocumentation\.IPageContext') + +Implements [IContext](../IContext/index.md 'DefaultDocumentation\.IContext') + +| Properties | | +| :--- | :--- | +| [Elements](Elements.md 'DefaultDocumentation\.IGeneralContext\.Elements') | Gets the [IElement](../Api/IElement/index.md 'DefaultDocumentation\.Api\.IElement') used to render specific [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') from the documentation\. | +| [Items](Items.md 'DefaultDocumentation\.IGeneralContext\.Items') | Gets all the [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') known by this documentation generation context\. | +| [ItemsWithOwnPage](ItemsWithOwnPage.md 'DefaultDocumentation\.IGeneralContext\.ItemsWithOwnPage') | Gets all the [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') that should generate their own documentation page\. | +| [Settings](Settings.md 'DefaultDocumentation\.IGeneralContext\.Settings') | Gets the [ISettings](../ISettings/index.md 'DefaultDocumentation\.ISettings') of this documentation generation context\. | +| [UrlFactories](UrlFactories.md 'DefaultDocumentation\.IGeneralContext\.UrlFactories') | Gets the [IUrlFactory](../Api/IUrlFactory/index.md 'DefaultDocumentation\.Api\.IUrlFactory') used to create the documentation urls\. | + +| Methods | | +| :--- | :--- | +| [GetContext\(Type\)](GetContext(Type).md 'DefaultDocumentation\.IGeneralContext\.GetContext\(System\.Type\)') | Gets the specific [IContext](../IContext/index.md 'DefaultDocumentation\.IContext') for the given [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')[System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type')\. | +| [GetFileName\(DocItem\)](GetFileName(DocItem).md 'DefaultDocumentation\.IGeneralContext\.GetFileName\(DefaultDocumentation\.Models\.DocItem\)') | Gets the file name for the given [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. | diff --git a/documentation/api/DefaultDocumentation/IGeneralContextExtensions/GetContext(thisIGeneralContext,DocItem).md b/documentation/api/DefaultDocumentation/IGeneralContextExtensions/GetContext(thisIGeneralContext,DocItem).md new file mode 100644 index 00000000..82cd658b --- /dev/null +++ b/documentation/api/DefaultDocumentation/IGeneralContextExtensions/GetContext(thisIGeneralContext,DocItem).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContextExtensions](index.md 'DefaultDocumentation\.IGeneralContextExtensions') + +## IGeneralContextExtensions\.GetContext\(this IGeneralContext, DocItem\) Method + +Gets the specific [IContext](../IContext/index.md 'DefaultDocumentation\.IContext') for the given [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') kind\. + +```csharp +public static DefaultDocumentation.IContext GetContext(this DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation file\. + + + +`item` [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to get a specific [IContext](../IContext/index.md 'DefaultDocumentation\.IContext')\. + +#### Returns +[IContext](../IContext/index.md 'DefaultDocumentation\.IContext') +The [IContext](../IContext/index.md 'DefaultDocumentation\.IContext') specific to the provided [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IGeneralContextExtensions/GetSetting.md b/documentation/api/DefaultDocumentation/IGeneralContextExtensions/GetSetting.md new file mode 100644 index 00000000..3f0e4692 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IGeneralContextExtensions/GetSetting.md @@ -0,0 +1,95 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContextExtensions](index.md 'DefaultDocumentation\.IGeneralContextExtensions') + +## IGeneralContextExtensions\.GetSetting Method + +| Overloads | | +| :--- | :--- | +| [GetSetting<T>\(this IGeneralContext, DocItem, Func<IContext,T>\)](DefaultDocumentation/IGeneralContextExtensions/GetSetting.md#DefaultDocumentation.IGeneralContextExtensions.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem,System.Func_DefaultDocumentation.IContext,T_) 'DefaultDocumentation\.IGeneralContextExtensions\.GetSetting\\(this DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem, System\.Func\\)') | Gets a data from the specific [IContext](../IContext/index.md 'DefaultDocumentation\.IContext') of the provided [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') if it exists, else from the [IGeneralContext](../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext')\. | +| [GetSetting<T>\(this IGeneralContext, Type, Func<IContext,T>\)](DefaultDocumentation/IGeneralContextExtensions/GetSetting.md#DefaultDocumentation.IGeneralContextExtensions.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,System.Type,System.Func_DefaultDocumentation.IContext,T_) 'DefaultDocumentation\.IGeneralContextExtensions\.GetSetting\\(this DefaultDocumentation\.IGeneralContext, System\.Type, System\.Func\\)') | Gets a data from the specific [IContext](../IContext/index.md 'DefaultDocumentation\.IContext') of the provided [System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') if it exists, else from the [IGeneralContext](../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext')\. | + + + +## IGeneralContextExtensions\.GetSetting\\(this IGeneralContext, DocItem, Func\\) Method + +Gets a data from the specific [IContext](../IContext/index.md 'DefaultDocumentation\.IContext') of the provided [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') if it exists, else from the [IGeneralContext](../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext')\. + +```csharp +public static T? GetSetting(this DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item, System.Func getter); +``` +#### Type parameters + + + +`T` + +The type of the data to get\. +#### Parameters + + + +`context` [IGeneralContext](../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation file\. + + + +`item` [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to get a specific setting\. + + + +`getter` [System\.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2')[IContext](../IContext/index.md 'DefaultDocumentation\.IContext')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2')[T](index.md#DefaultDocumentation.IGeneralContextExtensions.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem,System.Func_DefaultDocumentation.IContext,T_).T 'DefaultDocumentation\.IGeneralContextExtensions\.GetSetting\\(this DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem, System\.Func\\)\.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2') + +The [System\.Func<>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2') used to get the setting from a [IContext](../IContext/index.md 'DefaultDocumentation\.IContext')\. + +#### Returns +[T](index.md#DefaultDocumentation.IGeneralContextExtensions.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem,System.Func_DefaultDocumentation.IContext,T_).T 'DefaultDocumentation\.IGeneralContextExtensions\.GetSetting\\(this DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem, System\.Func\\)\.T') +The [T](index.md#DefaultDocumentation.IGeneralContextExtensions.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem,System.Func_DefaultDocumentation.IContext,T_).T 'DefaultDocumentation\.IGeneralContextExtensions\.GetSetting\\(this DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem, System\.Func\\)\.T') settings from the specific [IContext](../IContext/index.md 'DefaultDocumentation\.IContext') if it exists, otherwise from the [IGeneralContext](../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext')\. + +### Remarks +The [T](index.md#DefaultDocumentation.IGeneralContextExtensions.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem,System.Func_DefaultDocumentation.IContext,T_).T 'DefaultDocumentation\.IGeneralContextExtensions\.GetSetting\\(this DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem, System\.Func\\)\.T') should be [System\.Nullable<>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') for struct settings\. + + + +## IGeneralContextExtensions\.GetSetting\\(this IGeneralContext, Type, Func\\) Method + +Gets a data from the specific [IContext](../IContext/index.md 'DefaultDocumentation\.IContext') of the provided [System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') if it exists, else from the [IGeneralContext](../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext')\. + +```csharp +public static T? GetSetting(this DefaultDocumentation.IGeneralContext context, System.Type? type, System.Func getter); +``` +#### Type parameters + + + +`T` + +The type of the data to get\. +#### Parameters + + + +`context` [IGeneralContext](../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation file\. + + + +`type` [System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') + +The [System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') for which to get a specific setting\. + + + +`getter` [System\.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2')[IContext](../IContext/index.md 'DefaultDocumentation\.IContext')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2')[T](index.md#DefaultDocumentation.IGeneralContextExtensions.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,System.Type,System.Func_DefaultDocumentation.IContext,T_).T 'DefaultDocumentation\.IGeneralContextExtensions\.GetSetting\\(this DefaultDocumentation\.IGeneralContext, System\.Type, System\.Func\\)\.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2') + +The [System\.Func<>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2') used to get the setting from a [IContext](../IContext/index.md 'DefaultDocumentation\.IContext')\. + +#### Returns +[T](index.md#DefaultDocumentation.IGeneralContextExtensions.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,System.Type,System.Func_DefaultDocumentation.IContext,T_).T 'DefaultDocumentation\.IGeneralContextExtensions\.GetSetting\\(this DefaultDocumentation\.IGeneralContext, System\.Type, System\.Func\\)\.T') +The [T](index.md#DefaultDocumentation.IGeneralContextExtensions.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,System.Type,System.Func_DefaultDocumentation.IContext,T_).T 'DefaultDocumentation\.IGeneralContextExtensions\.GetSetting\\(this DefaultDocumentation\.IGeneralContext, System\.Type, System\.Func\\)\.T') settings from the specific [IContext](../IContext/index.md 'DefaultDocumentation\.IContext') if it exists, otherwise from the [IGeneralContext](../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext')\. + +### Remarks +The [T](index.md#DefaultDocumentation.IGeneralContextExtensions.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,System.Type,System.Func_DefaultDocumentation.IContext,T_).T 'DefaultDocumentation\.IGeneralContextExtensions\.GetSetting\\(this DefaultDocumentation\.IGeneralContext, System\.Type, System\.Func\\)\.T') should be [System\.Nullable<>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') for struct settings\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IGeneralContextExtensions/index.md b/documentation/api/DefaultDocumentation/IGeneralContextExtensions/index.md new file mode 100644 index 00000000..c7f55381 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IGeneralContextExtensions/index.md @@ -0,0 +1,18 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation') + +## IGeneralContextExtensions Class + +Provides extension methods on the [IGeneralContext](../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') type\. + +```csharp +public static class IGeneralContextExtensions +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 IGeneralContextExtensions + +| Methods | | +| :--- | :--- | +| [GetContext\(this IGeneralContext, DocItem\)](GetContext(thisIGeneralContext,DocItem).md 'DefaultDocumentation\.IGeneralContextExtensions\.GetContext\(this DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the specific [IContext](../IContext/index.md 'DefaultDocumentation\.IContext') for the given [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') kind\. | +| [GetSetting<T>\(this IGeneralContext, DocItem, Func<IContext,T>\)](GetSetting.md#DefaultDocumentation.IGeneralContextExtensions.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem,System.Func_DefaultDocumentation.IContext,T_) 'DefaultDocumentation\.IGeneralContextExtensions\.GetSetting\\(this DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem, System\.Func\\)') | Gets a data from the specific [IContext](../IContext/index.md 'DefaultDocumentation\.IContext') of the provided [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') if it exists, else from the [IGeneralContext](../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext')\. | +| [GetSetting<T>\(this IGeneralContext, Type, Func<IContext,T>\)](GetSetting.md#DefaultDocumentation.IGeneralContextExtensions.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,System.Type,System.Func_DefaultDocumentation.IContext,T_) 'DefaultDocumentation\.IGeneralContextExtensions\.GetSetting\\(this DefaultDocumentation\.IGeneralContext, System\.Type, System\.Func\\)') | Gets a data from the specific [IContext](../IContext/index.md 'DefaultDocumentation\.IContext') of the provided [System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') if it exists, else from the [IGeneralContext](../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext')\. | diff --git a/documentation/api/DefaultDocumentation/IPageContext/DocItem.md b/documentation/api/DefaultDocumentation/IPageContext/DocItem.md new file mode 100644 index 00000000..dc3ac23c --- /dev/null +++ b/documentation/api/DefaultDocumentation/IPageContext/DocItem.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IPageContext](index.md 'DefaultDocumentation\.IPageContext') + +## IPageContext\.DocItem Property + +Gets the [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which the documentation is being generated\. + +```csharp +DefaultDocumentation.Models.DocItem DocItem { get; } +``` + +#### Property Value +[DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IPageContext/index.md b/documentation/api/DefaultDocumentation/IPageContext/index.md new file mode 100644 index 00000000..d73bec17 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IPageContext/index.md @@ -0,0 +1,17 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation') + +## IPageContext Interface + +Exposes settings used to generate documentation for a specific [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public interface IPageContext : DefaultDocumentation.IGeneralContext, DefaultDocumentation.IContext +``` + +Implements [IGeneralContext](../IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext'), [IContext](../IContext/index.md 'DefaultDocumentation\.IContext') + +| Properties | | +| :--- | :--- | +| [DocItem](DocItem.md 'DefaultDocumentation\.IPageContext\.DocItem') | Gets the [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which the documentation is being generated\. | +| [this\[string\]](this[string].md 'DefaultDocumentation\.IPageContext\.this\[string\]') | Gets or sets extra data for the current [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') documentation generation\. | diff --git a/documentation/api/DefaultDocumentation/IPageContext/this[string].md b/documentation/api/DefaultDocumentation/IPageContext/this[string].md new file mode 100644 index 00000000..310873a9 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IPageContext/this[string].md @@ -0,0 +1,20 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IPageContext](index.md 'DefaultDocumentation\.IPageContext') + +## IPageContext\.this\[string\] Property + +Gets or sets extra data for the current [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') documentation generation\. + +```csharp +object? this[string key] { get; set; } +``` +#### Parameters + + + +`key` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The key of the data\. + +#### Property Value +[System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IPageContextExtensions/GetUrl.md b/documentation/api/DefaultDocumentation/IPageContextExtensions/GetUrl.md new file mode 100644 index 00000000..71b62667 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IPageContextExtensions/GetUrl.md @@ -0,0 +1,63 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IPageContextExtensions](index.md 'DefaultDocumentation\.IPageContextExtensions') + +## IPageContextExtensions\.GetUrl Method + +| Overloads | | +| :--- | :--- | +| [GetUrl\(this IPageContext, DocItem\)](DefaultDocumentation/IPageContextExtensions/GetUrl.md#DefaultDocumentation.IPageContextExtensions.GetUrl(thisDefaultDocumentation.IPageContext,DefaultDocumentation.Models.DocItem) 'DefaultDocumentation\.IPageContextExtensions\.GetUrl\(this DefaultDocumentation\.IPageContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the url of the given [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') in a specific page\. | +| [GetUrl\(this IPageContext, string\)](DefaultDocumentation/IPageContextExtensions/GetUrl.md#DefaultDocumentation.IPageContextExtensions.GetUrl(thisDefaultDocumentation.IPageContext,string) 'DefaultDocumentation\.IPageContextExtensions\.GetUrl\(this DefaultDocumentation\.IPageContext, string\)') | Gets the url of the given id in a specific page\. | + + + +## IPageContextExtensions\.GetUrl\(this IPageContext, DocItem\) Method + +Gets the url of the given [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') in a specific page\. + +```csharp +public static string? GetUrl(this DefaultDocumentation.IPageContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IPageContext](../IPageContext/index.md 'DefaultDocumentation\.IPageContext') + +The [IPageContext](../IPageContext/index.md 'DefaultDocumentation\.IPageContext') of the current documentation file\. + + + +`item` [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to get the url\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +The url of the given [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + + + +## IPageContextExtensions\.GetUrl\(this IPageContext, string\) Method + +Gets the url of the given id in a specific page\. + +```csharp +public static string? GetUrl(this DefaultDocumentation.IPageContext context, string id); +``` +#### Parameters + + + +`context` [IPageContext](../IPageContext/index.md 'DefaultDocumentation\.IPageContext') + +The [IPageContext](../IPageContext/index.md 'DefaultDocumentation\.IPageContext') of the current documentation file\. + + + +`id` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The id for which to get the url\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +The url of the given [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/IPageContextExtensions/index.md b/documentation/api/DefaultDocumentation/IPageContextExtensions/index.md new file mode 100644 index 00000000..05f01010 --- /dev/null +++ b/documentation/api/DefaultDocumentation/IPageContextExtensions/index.md @@ -0,0 +1,17 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation') + +## IPageContextExtensions Class + +Provides extension methods on the [IPageContext](../IPageContext/index.md 'DefaultDocumentation\.IPageContext') type\. + +```csharp +public static class IPageContextExtensions +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 IPageContextExtensions + +| Methods | | +| :--- | :--- | +| [GetUrl\(this IPageContext, DocItem\)](GetUrl.md#DefaultDocumentation.IPageContextExtensions.GetUrl(thisDefaultDocumentation.IPageContext,DefaultDocumentation.Models.DocItem) 'DefaultDocumentation\.IPageContextExtensions\.GetUrl\(this DefaultDocumentation\.IPageContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the url of the given [DocItem](../Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') in a specific page\. | +| [GetUrl\(this IPageContext, string\)](GetUrl.md#DefaultDocumentation.IPageContextExtensions.GetUrl(thisDefaultDocumentation.IPageContext,string) 'DefaultDocumentation\.IPageContextExtensions\.GetUrl\(this DefaultDocumentation\.IPageContext, string\)') | Gets the url of the given id in a specific page\. | diff --git a/documentation/api/DefaultDocumentation/ISettings/AssemblyFile.md b/documentation/api/DefaultDocumentation/ISettings/AssemblyFile.md new file mode 100644 index 00000000..a59c0413 --- /dev/null +++ b/documentation/api/DefaultDocumentation/ISettings/AssemblyFile.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](index.md 'DefaultDocumentation\.ISettings') + +## ISettings\.AssemblyFile Property + +Gets the assembly file for which the documentation is being generated\. + +```csharp +System.IO.FileInfo AssemblyFile { get; } +``` + +#### Property Value +[System\.IO\.FileInfo](https://docs.microsoft.com/en-us/dotnet/api/System.IO.FileInfo 'System\.IO\.FileInfo') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/ISettings/AssemblyPageName.md b/documentation/api/DefaultDocumentation/ISettings/AssemblyPageName.md new file mode 100644 index 00000000..280c9965 --- /dev/null +++ b/documentation/api/DefaultDocumentation/ISettings/AssemblyPageName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](index.md 'DefaultDocumentation\.ISettings') + +## ISettings\.AssemblyPageName Property + +Gets the name of the assembly page name\. + +```csharp +string? AssemblyPageName { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/ISettings/DocumentationFile.md b/documentation/api/DefaultDocumentation/ISettings/DocumentationFile.md new file mode 100644 index 00000000..364eca06 --- /dev/null +++ b/documentation/api/DefaultDocumentation/ISettings/DocumentationFile.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](index.md 'DefaultDocumentation\.ISettings') + +## ISettings\.DocumentationFile Property + +Gets the xml documentation file of the [AssemblyFile](AssemblyFile.md 'DefaultDocumentation\.ISettings\.AssemblyFile')\. + +```csharp +System.IO.FileInfo DocumentationFile { get; } +``` + +#### Property Value +[System\.IO\.FileInfo](https://docs.microsoft.com/en-us/dotnet/api/System.IO.FileInfo 'System\.IO\.FileInfo') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/ISettings/ExternLinksFiles.md b/documentation/api/DefaultDocumentation/ISettings/ExternLinksFiles.md new file mode 100644 index 00000000..d8a2cbeb --- /dev/null +++ b/documentation/api/DefaultDocumentation/ISettings/ExternLinksFiles.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](index.md 'DefaultDocumentation\.ISettings') + +## ISettings\.ExternLinksFiles Property + +Gets the links files of external items which are not part of the dotnet api\. + +```csharp +System.Collections.Generic.IEnumerable ExternLinksFiles { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[System\.IO\.FileInfo](https://docs.microsoft.com/en-us/dotnet/api/System.IO.FileInfo 'System\.IO\.FileInfo')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/ISettings/GeneratedAccessModifiers.md b/documentation/api/DefaultDocumentation/ISettings/GeneratedAccessModifiers.md new file mode 100644 index 00000000..9060acc7 --- /dev/null +++ b/documentation/api/DefaultDocumentation/ISettings/GeneratedAccessModifiers.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](index.md 'DefaultDocumentation\.ISettings') + +## ISettings\.GeneratedAccessModifiers Property + +Gets the [GeneratedAccessModifiers](../GeneratedAccessModifiers/index.md 'DefaultDocumentation\.GeneratedAccessModifiers') flags stating which access modifiers should have their documentation generated\. + +```csharp +DefaultDocumentation.GeneratedAccessModifiers GeneratedAccessModifiers { get; } +``` + +#### Property Value +[GeneratedAccessModifiers](../GeneratedAccessModifiers/index.md 'DefaultDocumentation\.GeneratedAccessModifiers') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/ISettings/GeneratedPages.md b/documentation/api/DefaultDocumentation/ISettings/GeneratedPages.md new file mode 100644 index 00000000..f74f1c8a --- /dev/null +++ b/documentation/api/DefaultDocumentation/ISettings/GeneratedPages.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](index.md 'DefaultDocumentation\.ISettings') + +## ISettings\.GeneratedPages Property + +Gets the [GeneratedPages](../GeneratedPages/index.md 'DefaultDocumentation\.GeneratedPages') flags stating which kind should have their own page and which should be inlined\. + +```csharp +DefaultDocumentation.GeneratedPages GeneratedPages { get; } +``` + +#### Property Value +[GeneratedPages](../GeneratedPages/index.md 'DefaultDocumentation\.GeneratedPages') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/ISettings/IncludeUndocumentedItems.md b/documentation/api/DefaultDocumentation/ISettings/IncludeUndocumentedItems.md new file mode 100644 index 00000000..0a6e7e65 --- /dev/null +++ b/documentation/api/DefaultDocumentation/ISettings/IncludeUndocumentedItems.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](index.md 'DefaultDocumentation\.ISettings') + +## ISettings\.IncludeUndocumentedItems Property + +Gets wether item with no xml documentation should have their documentation generated or not\. + +```csharp +bool IncludeUndocumentedItems { get; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/ISettings/LinksBaseUrl.md b/documentation/api/DefaultDocumentation/ISettings/LinksBaseUrl.md new file mode 100644 index 00000000..32c01546 --- /dev/null +++ b/documentation/api/DefaultDocumentation/ISettings/LinksBaseUrl.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](index.md 'DefaultDocumentation\.ISettings') + +## ISettings\.LinksBaseUrl Property + +Gets the base url to prefix item url with when generating the links output file\. + +```csharp +string? LinksBaseUrl { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/ISettings/LinksOutputFile.md b/documentation/api/DefaultDocumentation/ISettings/LinksOutputFile.md new file mode 100644 index 00000000..8d4e6ffa --- /dev/null +++ b/documentation/api/DefaultDocumentation/ISettings/LinksOutputFile.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](index.md 'DefaultDocumentation\.ISettings') + +## ISettings\.LinksOutputFile Property + +Gets the file name where all the url of the generated documentation should be writen to, to be used for referencing documentation generation\. + +```csharp +System.IO.FileInfo? LinksOutputFile { get; } +``` + +#### Property Value +[System\.IO\.FileInfo](https://docs.microsoft.com/en-us/dotnet/api/System.IO.FileInfo 'System\.IO\.FileInfo') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/ISettings/Logger.md b/documentation/api/DefaultDocumentation/ISettings/Logger.md new file mode 100644 index 00000000..e1196226 --- /dev/null +++ b/documentation/api/DefaultDocumentation/ISettings/Logger.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](index.md 'DefaultDocumentation\.ISettings') + +## ISettings\.Logger Property + +Gets the [NLog\.ILogger](https://docs.microsoft.com/en-us/dotnet/api/NLog.ILogger 'NLog\.ILogger') of the process\. + +```csharp +ILogger Logger { get; } +``` + +#### Property Value +[NLog\.ILogger](https://docs.microsoft.com/en-us/dotnet/api/NLog.ILogger 'NLog\.ILogger') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/ISettings/OutputDirectory.md b/documentation/api/DefaultDocumentation/ISettings/OutputDirectory.md new file mode 100644 index 00000000..a63471c9 --- /dev/null +++ b/documentation/api/DefaultDocumentation/ISettings/OutputDirectory.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](index.md 'DefaultDocumentation\.ISettings') + +## ISettings\.OutputDirectory Property + +Gets the output directory where the documentation is being generated\. + +```csharp +System.IO.DirectoryInfo OutputDirectory { get; } +``` + +#### Property Value +[System\.IO\.DirectoryInfo](https://docs.microsoft.com/en-us/dotnet/api/System.IO.DirectoryInfo 'System\.IO\.DirectoryInfo') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/ISettings/ProjectDirectory.md b/documentation/api/DefaultDocumentation/ISettings/ProjectDirectory.md new file mode 100644 index 00000000..1850a1e5 --- /dev/null +++ b/documentation/api/DefaultDocumentation/ISettings/ProjectDirectory.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](index.md 'DefaultDocumentation\.ISettings') + +## ISettings\.ProjectDirectory Property + +Gets the root project directory where the sources of the [AssemblyFile](AssemblyFile.md 'DefaultDocumentation\.ISettings\.AssemblyFile') are\. + +```csharp +System.IO.DirectoryInfo? ProjectDirectory { get; } +``` + +#### Property Value +[System\.IO\.DirectoryInfo](https://docs.microsoft.com/en-us/dotnet/api/System.IO.DirectoryInfo 'System\.IO\.DirectoryInfo') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/ISettings/index.md b/documentation/api/DefaultDocumentation/ISettings/index.md new file mode 100644 index 00000000..319a790c --- /dev/null +++ b/documentation/api/DefaultDocumentation/ISettings/index.md @@ -0,0 +1,25 @@ +#### [DefaultDocumentation\.Api](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation') + +## ISettings Interface + +Exposes all the settings of the documentation generation process\. + +```csharp +public interface ISettings +``` + +| Properties | | +| :--- | :--- | +| [AssemblyFile](AssemblyFile.md 'DefaultDocumentation\.ISettings\.AssemblyFile') | Gets the assembly file for which the documentation is being generated\. | +| [AssemblyPageName](AssemblyPageName.md 'DefaultDocumentation\.ISettings\.AssemblyPageName') | Gets the name of the assembly page name\. | +| [DocumentationFile](DocumentationFile.md 'DefaultDocumentation\.ISettings\.DocumentationFile') | Gets the xml documentation file of the [AssemblyFile](AssemblyFile.md 'DefaultDocumentation\.ISettings\.AssemblyFile')\. | +| [ExternLinksFiles](ExternLinksFiles.md 'DefaultDocumentation\.ISettings\.ExternLinksFiles') | Gets the links files of external items which are not part of the dotnet api\. | +| [GeneratedAccessModifiers](GeneratedAccessModifiers.md 'DefaultDocumentation\.ISettings\.GeneratedAccessModifiers') | Gets the [GeneratedAccessModifiers](../GeneratedAccessModifiers/index.md 'DefaultDocumentation\.GeneratedAccessModifiers') flags stating which access modifiers should have their documentation generated\. | +| [GeneratedPages](GeneratedPages.md 'DefaultDocumentation\.ISettings\.GeneratedPages') | Gets the [GeneratedPages](../GeneratedPages/index.md 'DefaultDocumentation\.GeneratedPages') flags stating which kind should have their own page and which should be inlined\. | +| [IncludeUndocumentedItems](IncludeUndocumentedItems.md 'DefaultDocumentation\.ISettings\.IncludeUndocumentedItems') | Gets wether item with no xml documentation should have their documentation generated or not\. | +| [LinksBaseUrl](LinksBaseUrl.md 'DefaultDocumentation\.ISettings\.LinksBaseUrl') | Gets the base url to prefix item url with when generating the links output file\. | +| [LinksOutputFile](LinksOutputFile.md 'DefaultDocumentation\.ISettings\.LinksOutputFile') | Gets the file name where all the url of the generated documentation should be writen to, to be used for referencing documentation generation\. | +| [Logger](Logger.md 'DefaultDocumentation\.ISettings\.Logger') | Gets the [NLog\.ILogger](https://docs.microsoft.com/en-us/dotnet/api/NLog.ILogger 'NLog\.ILogger') of the process\. | +| [OutputDirectory](OutputDirectory.md 'DefaultDocumentation\.ISettings\.OutputDirectory') | Gets the output directory where the documentation is being generated\. | +| [ProjectDirectory](ProjectDirectory.md 'DefaultDocumentation\.ISettings\.ProjectDirectory') | Gets the root project directory where the sources of the [AssemblyFile](AssemblyFile.md 'DefaultDocumentation\.ISettings\.AssemblyFile') are\. | diff --git a/documentation/api/DefaultDocumentation/Models/AssemblyDocItem/AssemblyDocItem(string,string,XElement).md b/documentation/api/DefaultDocumentation/Models/AssemblyDocItem/AssemblyDocItem(string,string,XElement).md new file mode 100644 index 00000000..57bf431a --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/AssemblyDocItem/AssemblyDocItem(string,string,XElement).md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models').[AssemblyDocItem](index.md 'DefaultDocumentation\.Models\.AssemblyDocItem') + +## AssemblyDocItem\(string, string, XElement\) Constructor + +Initialize a new instance of the [AssemblyDocItem](index.md 'DefaultDocumentation\.Models\.AssemblyDocItem') type\. + +```csharp +public AssemblyDocItem(string fullName, string name, System.Xml.Linq.XElement? documentation); +``` +#### Parameters + + + +`fullName` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The full name of the assembly\. + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The name of the assemby\. + + + +`documentation` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') documentation element of the assembly\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/AssemblyDocItem/index.md b/documentation/api/DefaultDocumentation/Models/AssemblyDocItem/index.md new file mode 100644 index 00000000..ae817a09 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/AssemblyDocItem/index.md @@ -0,0 +1,16 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models') + +## AssemblyDocItem Class + +Represents an assembly documentation\. + +```csharp +public sealed class AssemblyDocItem : DefaultDocumentation.Models.DocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 AssemblyDocItem + +| Constructors | | +| :--- | :--- | +| [AssemblyDocItem\(string, string, XElement\)](AssemblyDocItem(string,string,XElement).md 'DefaultDocumentation\.Models\.AssemblyDocItem\.AssemblyDocItem\(string, string, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [AssemblyDocItem](DefaultDocumentation/Models/AssemblyDocItem/index.md 'DefaultDocumentation\.Models\.AssemblyDocItem') type\. | diff --git a/documentation/api/DefaultDocumentation/Models/DocItem/DocItem(DocItem,string,string,string,XElement).md b/documentation/api/DefaultDocumentation/Models/DocItem/DocItem(DocItem,string,string,string,XElement).md new file mode 100644 index 00000000..32f71855 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/DocItem/DocItem(DocItem,string,string,string,XElement).md @@ -0,0 +1,41 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models').[DocItem](index.md 'DefaultDocumentation\.Models\.DocItem') + +## DocItem\(DocItem, string, string, string, XElement\) Constructor + +Initialize a new instance of the [DocItem](index.md 'DefaultDocumentation\.Models\.DocItem') type\. + +```csharp +protected DocItem(DefaultDocumentation.Models.DocItem? parent, string id, string fullName, string name, System.Xml.Linq.XElement? documentation); +``` +#### Parameters + + + +`parent` [DocItem](index.md 'DefaultDocumentation\.Models\.DocItem') + +The parent\. + + + +`id` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The id\. + + + +`fullName` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The full name\. + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The name\. + + + +`documentation` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The documentation\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/DocItem/Documentation.md b/documentation/api/DefaultDocumentation/Models/DocItem/Documentation.md new file mode 100644 index 00000000..56926b2a --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/DocItem/Documentation.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models').[DocItem](index.md 'DefaultDocumentation\.Models\.DocItem') + +## DocItem\.Documentation Property + +Gets the xml documentation node of the current instance\. + +```csharp +public System.Xml.Linq.XElement? Documentation { get; } +``` + +#### Property Value +[System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/DocItem/FullName.md b/documentation/api/DefaultDocumentation/Models/DocItem/FullName.md new file mode 100644 index 00000000..849d4673 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/DocItem/FullName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models').[DocItem](index.md 'DefaultDocumentation\.Models\.DocItem') + +## DocItem\.FullName Property + +Gets the full name of the current instance\. + +```csharp +public string FullName { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/DocItem/Id.md b/documentation/api/DefaultDocumentation/Models/DocItem/Id.md new file mode 100644 index 00000000..b1c30953 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/DocItem/Id.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models').[DocItem](index.md 'DefaultDocumentation\.Models\.DocItem') + +## DocItem\.Id Property + +Gets the id of the current instance\. + +```csharp +public string Id { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/DocItem/Name.md b/documentation/api/DefaultDocumentation/Models/DocItem/Name.md new file mode 100644 index 00000000..48066085 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/DocItem/Name.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models').[DocItem](index.md 'DefaultDocumentation\.Models\.DocItem') + +## DocItem\.Name Property + +Gets the name of the current instance\. + +```csharp +public string Name { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/DocItem/Parent.md b/documentation/api/DefaultDocumentation/Models/DocItem/Parent.md new file mode 100644 index 00000000..4d61c17b --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/DocItem/Parent.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models').[DocItem](index.md 'DefaultDocumentation\.Models\.DocItem') + +## DocItem\.Parent Property + +Gets the [DocItem](index.md 'DefaultDocumentation\.Models\.DocItem') parent of the current instance \(for members it is their declaring type, for types it is their namespace, \.\.\.\)\. + +```csharp +public DefaultDocumentation.Models.DocItem? Parent { get; } +``` + +#### Property Value +[DocItem](index.md 'DefaultDocumentation\.Models\.DocItem') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/DocItem/index.md b/documentation/api/DefaultDocumentation/Models/DocItem/index.md new file mode 100644 index 00000000..e9ddfce9 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/DocItem/index.md @@ -0,0 +1,32 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models') + +## DocItem Class + +Represent a documentation item\. + +```csharp +public abstract class DocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 DocItem + +Derived +↳ [AssemblyDocItem](../AssemblyDocItem/index.md 'DefaultDocumentation\.Models\.AssemblyDocItem') +↳ [EntityDocItem](../EntityDocItem/index.md 'DefaultDocumentation\.Models\.EntityDocItem') +↳ [ExternDocItem](../ExternDocItem/index.md 'DefaultDocumentation\.Models\.ExternDocItem') +↳ [NamespaceDocItem](../NamespaceDocItem/index.md 'DefaultDocumentation\.Models\.NamespaceDocItem') +↳ [ParameterDocItem](../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') +↳ [TypeParameterDocItem](../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') + +| Constructors | | +| :--- | :--- | +| [DocItem\(DocItem, string, string, string, XElement\)](DocItem(DocItem,string,string,string,XElement).md 'DefaultDocumentation\.Models\.DocItem\.DocItem\(DefaultDocumentation\.Models\.DocItem, string, string, string, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') type\. | + +| Properties | | +| :--- | :--- | +| [Documentation](Documentation.md 'DefaultDocumentation\.Models\.DocItem\.Documentation') | Gets the xml documentation node of the current instance\. | +| [FullName](FullName.md 'DefaultDocumentation\.Models\.DocItem\.FullName') | Gets the full name of the current instance\. | +| [Id](Id.md 'DefaultDocumentation\.Models\.DocItem\.Id') | Gets the id of the current instance\. | +| [Name](Name.md 'DefaultDocumentation\.Models\.DocItem\.Name') | Gets the name of the current instance\. | +| [Parent](Parent.md 'DefaultDocumentation\.Models\.DocItem\.Parent') | Gets the [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') parent of the current instance \(for members it is their declaring type, for types it is their namespace, \.\.\.\)\. | diff --git a/documentation/api/DefaultDocumentation/Models/DocItemExtensions/GetParents(thisDocItem).md b/documentation/api/DefaultDocumentation/Models/DocItemExtensions/GetParents(thisDocItem).md new file mode 100644 index 00000000..dc5aac52 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/DocItemExtensions/GetParents(thisDocItem).md @@ -0,0 +1,21 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models').[DocItemExtensions](index.md 'DefaultDocumentation\.Models\.DocItemExtensions') + +## DocItemExtensions\.GetParents\(this DocItem\) Method + +Returns all the parents of the given [DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public static System.Collections.Generic.IEnumerable GetParents(this DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`item` [DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which parents should be returned\. + +#### Returns +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') +The parents of the given [DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') from the top parent\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/DocItemExtensions/TryGetParameterDocItem(thisDocItem,string,ParameterDocItem).md b/documentation/api/DefaultDocumentation/Models/DocItemExtensions/TryGetParameterDocItem(thisDocItem,string,ParameterDocItem).md new file mode 100644 index 00000000..a551843d --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/DocItemExtensions/TryGetParameterDocItem(thisDocItem,string,ParameterDocItem).md @@ -0,0 +1,33 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models').[DocItemExtensions](index.md 'DefaultDocumentation\.Models\.DocItemExtensions') + +## DocItemExtensions\.TryGetParameterDocItem\(this DocItem, string, ParameterDocItem\) Method + +Searchs recursively on the given [DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') parent a [ParameterDocItem](../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') with the provided name\. + +```csharp +public static bool TryGetParameterDocItem(this DefaultDocumentation.Models.DocItem item, string name, out DefaultDocumentation.Models.Parameters.ParameterDocItem? parameterDocItem); +``` +#### Parameters + + + +`item` [DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') starting point from which to look for a specific [ParameterDocItem](../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem')\. + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The name of the [ParameterDocItem](../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem')\. + + + +`parameterDocItem` [ParameterDocItem](../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') + +The [ParameterDocItem](../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') if found, else [null](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/null 'https://docs\.microsoft\.com/en\-us/dotnet/csharp/language\-reference/keywords/null')\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs\.microsoft\.com/en\-us/dotnet/csharp/language\-reference/builtin\-types/bool') if the [ParameterDocItem](../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') was found, else [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs\.microsoft\.com/en\-us/dotnet/csharp/language\-reference/builtin\-types/bool')\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/DocItemExtensions/TryGetTypeParameterDocItem(thisDocItem,string,TypeParameterDocItem).md b/documentation/api/DefaultDocumentation/Models/DocItemExtensions/TryGetTypeParameterDocItem(thisDocItem,string,TypeParameterDocItem).md new file mode 100644 index 00000000..b23483f9 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/DocItemExtensions/TryGetTypeParameterDocItem(thisDocItem,string,TypeParameterDocItem).md @@ -0,0 +1,33 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models').[DocItemExtensions](index.md 'DefaultDocumentation\.Models\.DocItemExtensions') + +## DocItemExtensions\.TryGetTypeParameterDocItem\(this DocItem, string, TypeParameterDocItem\) Method + +Searchs recursively on the given [DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') parent a [TypeParameterDocItem](../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') with the provided name\. + +```csharp +public static bool TryGetTypeParameterDocItem(this DefaultDocumentation.Models.DocItem item, string name, out DefaultDocumentation.Models.Parameters.TypeParameterDocItem? typeParameterDocItem); +``` +#### Parameters + + + +`item` [DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') starting point from which to look for a specific [TypeParameterDocItem](../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem')\. + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The name of the [TypeParameterDocItem](../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem')\. + + + +`typeParameterDocItem` [TypeParameterDocItem](../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') + +The [TypeParameterDocItem](../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') if found, else [null](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/null 'https://docs\.microsoft\.com/en\-us/dotnet/csharp/language\-reference/keywords/null')\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs\.microsoft\.com/en\-us/dotnet/csharp/language\-reference/builtin\-types/bool') if the [TypeParameterDocItem](../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') was found, else [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs\.microsoft\.com/en\-us/dotnet/csharp/language\-reference/builtin\-types/bool')\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/DocItemExtensions/index.md b/documentation/api/DefaultDocumentation/Models/DocItemExtensions/index.md new file mode 100644 index 00000000..7df16102 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/DocItemExtensions/index.md @@ -0,0 +1,18 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models') + +## DocItemExtensions Class + +Provides extension methods on the [DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') type\. + +```csharp +public static class DocItemExtensions +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 DocItemExtensions + +| Methods | | +| :--- | :--- | +| [GetParents\(this DocItem\)](GetParents(thisDocItem).md 'DefaultDocumentation\.Models\.DocItemExtensions\.GetParents\(this DefaultDocumentation\.Models\.DocItem\)') | Returns all the parents of the given [DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. | +| [TryGetParameterDocItem\(this DocItem, string, ParameterDocItem\)](TryGetParameterDocItem(thisDocItem,string,ParameterDocItem).md 'DefaultDocumentation\.Models\.DocItemExtensions\.TryGetParameterDocItem\(this DefaultDocumentation\.Models\.DocItem, string, DefaultDocumentation\.Models\.Parameters\.ParameterDocItem\)') | Searchs recursively on the given [DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') parent a [ParameterDocItem](../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') with the provided name\. | +| [TryGetTypeParameterDocItem\(this DocItem, string, TypeParameterDocItem\)](TryGetTypeParameterDocItem(thisDocItem,string,TypeParameterDocItem).md 'DefaultDocumentation\.Models\.DocItemExtensions\.TryGetTypeParameterDocItem\(this DefaultDocumentation\.Models\.DocItem, string, DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem\)') | Searchs recursively on the given [DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') parent a [TypeParameterDocItem](../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') with the provided name\. | diff --git a/documentation/api/DefaultDocumentation/Models/EntityDocItem/Entity.md b/documentation/api/DefaultDocumentation/Models/EntityDocItem/Entity.md new file mode 100644 index 00000000..70e5f9fb --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/EntityDocItem/Entity.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models').[EntityDocItem](index.md 'DefaultDocumentation\.Models\.EntityDocItem') + +## EntityDocItem\.Entity Property + +Gets the [IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEntity') of the current instance\. + +```csharp +public IEntity Entity { get; } +``` + +#### Property Value +[IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEntity') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/EntityDocItem/index.md b/documentation/api/DefaultDocumentation/Models/EntityDocItem/index.md new file mode 100644 index 00000000..ecda3098 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/EntityDocItem/index.md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models') + +## EntityDocItem Class + +Represent an [IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEntity') documentation\. + +```csharp +public abstract class EntityDocItem : DefaultDocumentation.Models.DocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 EntityDocItem + +Derived +↳ [ConstructorDocItem](../Members/ConstructorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem') +↳ [EnumFieldDocItem](../Members/EnumFieldDocItem/index.md 'DefaultDocumentation\.Models\.Members\.EnumFieldDocItem') +↳ [EventDocItem](../Members/EventDocItem/index.md 'DefaultDocumentation\.Models\.Members\.EventDocItem') +↳ [ExplicitInterfaceImplementationDocItem](../Members/ExplicitInterfaceImplementationDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') +↳ [FieldDocItem](../Members/FieldDocItem/index.md 'DefaultDocumentation\.Models\.Members\.FieldDocItem') +↳ [MethodDocItem](../Members/MethodDocItem/index.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem') +↳ [OperatorDocItem](../Members/OperatorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.OperatorDocItem') +↳ [PropertyDocItem](../Members/PropertyDocItem/index.md 'DefaultDocumentation\.Models\.Members\.PropertyDocItem') +↳ [TypeDocItem](../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') + +| Properties | | +| :--- | :--- | +| [Entity](Entity.md 'DefaultDocumentation\.Models\.EntityDocItem\.Entity') | Gets the [IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEntity') of the current instance\. | diff --git a/documentation/api/DefaultDocumentation/Models/ExternDocItem/ExternDocItem(string,string,string).md b/documentation/api/DefaultDocumentation/Models/ExternDocItem/ExternDocItem(string,string,string).md new file mode 100644 index 00000000..ef6f15eb --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/ExternDocItem/ExternDocItem(string,string,string).md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models').[ExternDocItem](index.md 'DefaultDocumentation\.Models\.ExternDocItem') + +## ExternDocItem\(string, string, string\) Constructor + +Initialize a new instance of the [ExternDocItem](index.md 'DefaultDocumentation\.Models\.ExternDocItem') type\. + +```csharp +public ExternDocItem(string id, string url, string? name); +``` +#### Parameters + + + +`id` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The id of the external item\. + + + +`url` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The url of the documentation\. + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The name of the external item\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/ExternDocItem/Url.md b/documentation/api/DefaultDocumentation/Models/ExternDocItem/Url.md new file mode 100644 index 00000000..b094f5ef --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/ExternDocItem/Url.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models').[ExternDocItem](index.md 'DefaultDocumentation\.Models\.ExternDocItem') + +## ExternDocItem\.Url Property + +Gets the url of the current instance\. + +```csharp +public string Url { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/ExternDocItem/index.md b/documentation/api/DefaultDocumentation/Models/ExternDocItem/index.md new file mode 100644 index 00000000..1e72230b --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/ExternDocItem/index.md @@ -0,0 +1,20 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models') + +## ExternDocItem Class + +Represent an external documentation\. + +```csharp +public sealed class ExternDocItem : DefaultDocumentation.Models.DocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 ExternDocItem + +| Constructors | | +| :--- | :--- | +| [ExternDocItem\(string, string, string\)](ExternDocItem(string,string,string).md 'DefaultDocumentation\.Models\.ExternDocItem\.ExternDocItem\(string, string, string\)') | Initialize a new instance of the [ExternDocItem](DefaultDocumentation/Models/ExternDocItem/index.md 'DefaultDocumentation\.Models\.ExternDocItem') type\. | + +| Properties | | +| :--- | :--- | +| [Url](Url.md 'DefaultDocumentation\.Models\.ExternDocItem\.Url') | Gets the url of the current instance\. | diff --git a/documentation/api/DefaultDocumentation/Models/IParameterizedDocItem/Parameters.md b/documentation/api/DefaultDocumentation/Models/IParameterizedDocItem/Parameters.md new file mode 100644 index 00000000..fe7fb962 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/IParameterizedDocItem/Parameters.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models').[IParameterizedDocItem](index.md 'DefaultDocumentation\.Models\.IParameterizedDocItem') + +## IParameterizedDocItem\.Parameters Property + +Gets the [ParameterDocItem](../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. + +```csharp +System.Collections.Generic.IEnumerable Parameters { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[ParameterDocItem](../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/IParameterizedDocItem/index.md b/documentation/api/DefaultDocumentation/Models/IParameterizedDocItem/index.md new file mode 100644 index 00000000..ff365284 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/IParameterizedDocItem/index.md @@ -0,0 +1,22 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models') + +## IParameterizedDocItem Interface + +Exposes [ParameterDocItem](../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') instances\. + +```csharp +public interface IParameterizedDocItem +``` + +Derived +↳ [ConstructorDocItem](../Members/ConstructorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem') +↳ [ExplicitInterfaceImplementationDocItem](../Members/ExplicitInterfaceImplementationDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') +↳ [MethodDocItem](../Members/MethodDocItem/index.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem') +↳ [OperatorDocItem](../Members/OperatorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.OperatorDocItem') +↳ [PropertyDocItem](../Members/PropertyDocItem/index.md 'DefaultDocumentation\.Models\.Members\.PropertyDocItem') +↳ [DelegateDocItem](../Types/DelegateDocItem/index.md 'DefaultDocumentation\.Models\.Types\.DelegateDocItem') + +| Properties | | +| :--- | :--- | +| [Parameters](Parameters.md 'DefaultDocumentation\.Models\.IParameterizedDocItem\.Parameters') | Gets the [ParameterDocItem](../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. | diff --git a/documentation/api/DefaultDocumentation/Models/ITypeParameterizedDocItem/TypeParameters.md b/documentation/api/DefaultDocumentation/Models/ITypeParameterizedDocItem/TypeParameters.md new file mode 100644 index 00000000..63a903d2 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/ITypeParameterizedDocItem/TypeParameters.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models').[ITypeParameterizedDocItem](index.md 'DefaultDocumentation\.Models\.ITypeParameterizedDocItem') + +## ITypeParameterizedDocItem\.TypeParameters Property + +Gets the [TypeParameterDocItem](../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') of this instance\. + +```csharp +System.Collections.Generic.IEnumerable TypeParameters { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[TypeParameterDocItem](../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/ITypeParameterizedDocItem/index.md b/documentation/api/DefaultDocumentation/Models/ITypeParameterizedDocItem/index.md new file mode 100644 index 00000000..fa56766d --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/ITypeParameterizedDocItem/index.md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models') + +## ITypeParameterizedDocItem Interface + +Exposes [TypeParameterDocItem](../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') instances\. + +```csharp +public interface ITypeParameterizedDocItem +``` + +Derived +↳ [ExplicitInterfaceImplementationDocItem](../Members/ExplicitInterfaceImplementationDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') +↳ [MethodDocItem](../Members/MethodDocItem/index.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem') +↳ [TypeDocItem](../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') + +| Properties | | +| :--- | :--- | +| [TypeParameters](TypeParameters.md 'DefaultDocumentation\.Models\.ITypeParameterizedDocItem\.TypeParameters') | Gets the [TypeParameterDocItem](../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') of this instance\. | diff --git a/documentation/api/DefaultDocumentation/Models/Members/ConstructorDocItem/ConstructorDocItem(TypeDocItem,IMethod,XElement).md b/documentation/api/DefaultDocumentation/Models/Members/ConstructorDocItem/ConstructorDocItem(TypeDocItem,IMethod,XElement).md new file mode 100644 index 00000000..f724b520 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/ConstructorDocItem/ConstructorDocItem(TypeDocItem,IMethod,XElement).md @@ -0,0 +1,34 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[ConstructorDocItem](index.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem') + +## ConstructorDocItem\(TypeDocItem, IMethod, XElement\) Constructor + +Initialize a new instance of the [ConstructorDocItem](index.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem') type\. + +```csharp +public ConstructorDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, IMethod method, System.Xml.Linq.XElement? documentation); +``` +#### Parameters + + + +`parent` [TypeDocItem](../../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') + +The [TypeDocItem](../../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') parent type of the constructor\. + + + +`method` [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') + +The [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') of the constructor\. + + + +`documentation` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') documentation element of the constructor\. + +#### Exceptions + +[System\.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System\.ArgumentNullException') +[parent](DefaultDocumentation/Models/Members/ConstructorDocItem/ConstructorDocItem(TypeDocItem,IMethod,XElement).md#DefaultDocumentation.Models.Members.ConstructorDocItem.ConstructorDocItem(DefaultDocumentation.Models.Types.TypeDocItem,IMethod,System.Xml.Linq.XElement).parent 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem\.ConstructorDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IMethod, System\.Xml\.Linq\.XElement\)\.parent') or [method](DefaultDocumentation/Models/Members/ConstructorDocItem/ConstructorDocItem(TypeDocItem,IMethod,XElement).md#DefaultDocumentation.Models.Members.ConstructorDocItem.ConstructorDocItem(DefaultDocumentation.Models.Types.TypeDocItem,IMethod,System.Xml.Linq.XElement).method 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem\.ConstructorDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IMethod, System\.Xml\.Linq\.XElement\)\.method') is null\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/ConstructorDocItem/Method.md b/documentation/api/DefaultDocumentation/Models/Members/ConstructorDocItem/Method.md new file mode 100644 index 00000000..1a5d46a7 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/ConstructorDocItem/Method.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[ConstructorDocItem](index.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem') + +## ConstructorDocItem\.Method Property + +Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') of the current instance\. + +```csharp +public IMethod Method { get; } +``` + +#### Property Value +[IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/ConstructorDocItem/Parameters.md b/documentation/api/DefaultDocumentation/Models/Members/ConstructorDocItem/Parameters.md new file mode 100644 index 00000000..aac9ca25 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/ConstructorDocItem/Parameters.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[ConstructorDocItem](index.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem') + +## ConstructorDocItem\.Parameters Property + +Gets the [ParameterDocItem](../../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. + +```csharp +public System.Collections.Generic.IEnumerable Parameters { get; } +``` + +Implements [Parameters](../../IParameterizedDocItem/Parameters.md 'DefaultDocumentation\.Models\.IParameterizedDocItem\.Parameters') + +#### Property Value +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[ParameterDocItem](../../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/ConstructorDocItem/index.md b/documentation/api/DefaultDocumentation/Models/Members/ConstructorDocItem/index.md new file mode 100644 index 00000000..793e86d5 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/ConstructorDocItem/index.md @@ -0,0 +1,23 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members') + +## ConstructorDocItem Class + +Represents a constructor [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') documentation\. + +```csharp +public sealed class ConstructorDocItem : DefaultDocumentation.Models.EntityDocItem, DefaultDocumentation.Models.IParameterizedDocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 [EntityDocItem](../../EntityDocItem/index.md 'DefaultDocumentation\.Models\.EntityDocItem') 🡒 ConstructorDocItem + +Implements [IParameterizedDocItem](../../IParameterizedDocItem/index.md 'DefaultDocumentation\.Models\.IParameterizedDocItem') + +| Constructors | | +| :--- | :--- | +| [ConstructorDocItem\(TypeDocItem, IMethod, XElement\)](ConstructorDocItem(TypeDocItem,IMethod,XElement).md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem\.ConstructorDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IMethod, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [ConstructorDocItem](DefaultDocumentation/Models/Members/ConstructorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem') type\. | + +| Properties | | +| :--- | :--- | +| [Method](Method.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem\.Method') | Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') of the current instance\. | +| [Parameters](Parameters.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem\.Parameters') | Gets the [ParameterDocItem](../../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. | diff --git a/documentation/api/DefaultDocumentation/Models/Members/EnumFieldDocItem/EnumFieldDocItem(EnumDocItem,IField,XElement).md b/documentation/api/DefaultDocumentation/Models/Members/EnumFieldDocItem/EnumFieldDocItem(EnumDocItem,IField,XElement).md new file mode 100644 index 00000000..b8c3c35d --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/EnumFieldDocItem/EnumFieldDocItem(EnumDocItem,IField,XElement).md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[EnumFieldDocItem](index.md 'DefaultDocumentation\.Models\.Members\.EnumFieldDocItem') + +## EnumFieldDocItem\(EnumDocItem, IField, XElement\) Constructor + +Initialize a new instance of the [EnumFieldDocItem](index.md 'DefaultDocumentation\.Models\.Members\.EnumFieldDocItem') type\. + +```csharp +public EnumFieldDocItem(DefaultDocumentation.Models.Types.EnumDocItem parent, IField field, System.Xml.Linq.XElement? documentation); +``` +#### Parameters + + + +`parent` [EnumDocItem](../../Types/EnumDocItem/index.md 'DefaultDocumentation\.Models\.Types\.EnumDocItem') + +The [EnumDocItem](../../Types/EnumDocItem/index.md 'DefaultDocumentation\.Models\.Types\.EnumDocItem') parent enum of the enum field\. + + + +`field` [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IField') + +The [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IField') of the enum field\. + + + +`documentation` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') documentation element of the enum field\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/EnumFieldDocItem/Field.md b/documentation/api/DefaultDocumentation/Models/Members/EnumFieldDocItem/Field.md new file mode 100644 index 00000000..b46f07fc --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/EnumFieldDocItem/Field.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[EnumFieldDocItem](index.md 'DefaultDocumentation\.Models\.Members\.EnumFieldDocItem') + +## EnumFieldDocItem\.Field Property + +Gets the [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IField') of the current instance\. + +```csharp +public IField Field { get; } +``` + +#### Property Value +[IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IField') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/EnumFieldDocItem/index.md b/documentation/api/DefaultDocumentation/Models/Members/EnumFieldDocItem/index.md new file mode 100644 index 00000000..6491902b --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/EnumFieldDocItem/index.md @@ -0,0 +1,20 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members') + +## EnumFieldDocItem Class + +Represents an enum [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IField') documentation\. + +```csharp +public sealed class EnumFieldDocItem : DefaultDocumentation.Models.EntityDocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 [EntityDocItem](../../EntityDocItem/index.md 'DefaultDocumentation\.Models\.EntityDocItem') 🡒 EnumFieldDocItem + +| Constructors | | +| :--- | :--- | +| [EnumFieldDocItem\(EnumDocItem, IField, XElement\)](EnumFieldDocItem(EnumDocItem,IField,XElement).md 'DefaultDocumentation\.Models\.Members\.EnumFieldDocItem\.EnumFieldDocItem\(DefaultDocumentation\.Models\.Types\.EnumDocItem, IField, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [EnumFieldDocItem](DefaultDocumentation/Models/Members/EnumFieldDocItem/index.md 'DefaultDocumentation\.Models\.Members\.EnumFieldDocItem') type\. | + +| Properties | | +| :--- | :--- | +| [Field](Field.md 'DefaultDocumentation\.Models\.Members\.EnumFieldDocItem\.Field') | Gets the [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IField') of the current instance\. | diff --git a/documentation/api/DefaultDocumentation/Models/Members/EventDocItem/Event.md b/documentation/api/DefaultDocumentation/Models/Members/EventDocItem/Event.md new file mode 100644 index 00000000..8cdd269e --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/EventDocItem/Event.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[EventDocItem](index.md 'DefaultDocumentation\.Models\.Members\.EventDocItem') + +## EventDocItem\.Event Property + +Gets the [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEvent') of the current instance\. + +```csharp +public IEvent Event { get; } +``` + +#### Property Value +[IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEvent') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/EventDocItem/EventDocItem(TypeDocItem,IEvent,XElement).md b/documentation/api/DefaultDocumentation/Models/Members/EventDocItem/EventDocItem(TypeDocItem,IEvent,XElement).md new file mode 100644 index 00000000..653fba32 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/EventDocItem/EventDocItem(TypeDocItem,IEvent,XElement).md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[EventDocItem](index.md 'DefaultDocumentation\.Models\.Members\.EventDocItem') + +## EventDocItem\(TypeDocItem, IEvent, XElement\) Constructor + +Initialize a new instance of the [EventDocItem](index.md 'DefaultDocumentation\.Models\.Members\.EventDocItem') type\. + +```csharp +public EventDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, IEvent @event, System.Xml.Linq.XElement? documentation); +``` +#### Parameters + + + +`parent` [TypeDocItem](../../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') + +The [TypeDocItem](../../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') parent type of the event\. + + + +`event` [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEvent') + +The [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEvent') of the event\. + + + +`documentation` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') documentation element of the event\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/EventDocItem/index.md b/documentation/api/DefaultDocumentation/Models/Members/EventDocItem/index.md new file mode 100644 index 00000000..488b91ff --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/EventDocItem/index.md @@ -0,0 +1,20 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members') + +## EventDocItem Class + +Represents an [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEvent') documentation\. + +```csharp +public sealed class EventDocItem : DefaultDocumentation.Models.EntityDocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 [EntityDocItem](../../EntityDocItem/index.md 'DefaultDocumentation\.Models\.EntityDocItem') 🡒 EventDocItem + +| Constructors | | +| :--- | :--- | +| [EventDocItem\(TypeDocItem, IEvent, XElement\)](EventDocItem(TypeDocItem,IEvent,XElement).md 'DefaultDocumentation\.Models\.Members\.EventDocItem\.EventDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IEvent, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [EventDocItem](DefaultDocumentation/Models/Members/EventDocItem/index.md 'DefaultDocumentation\.Models\.Members\.EventDocItem') type\. | + +| Properties | | +| :--- | :--- | +| [Event](Event.md 'DefaultDocumentation\.Models\.Members\.EventDocItem\.Event') | Gets the [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEvent') of the current instance\. | diff --git a/documentation/api/DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/ExplicitInterfaceImplementationDocItem.md b/documentation/api/DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/ExplicitInterfaceImplementationDocItem.md new file mode 100644 index 00000000..2deb3ebf --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/ExplicitInterfaceImplementationDocItem.md @@ -0,0 +1,97 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[ExplicitInterfaceImplementationDocItem](index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') + +## ExplicitInterfaceImplementationDocItem Constructors + +| Overloads | | +| :--- | :--- | +| [ExplicitInterfaceImplementationDocItem\(TypeDocItem, IEvent, XElement\)](DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/ExplicitInterfaceImplementationDocItem.md#DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem,IEvent,System.Xml.Linq.XElement) 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem\.ExplicitInterfaceImplementationDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IEvent, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') type\. | +| [ExplicitInterfaceImplementationDocItem\(TypeDocItem, IMethod, XElement\)](DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/ExplicitInterfaceImplementationDocItem.md#DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem,IMethod,System.Xml.Linq.XElement) 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem\.ExplicitInterfaceImplementationDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IMethod, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') type\. | +| [ExplicitInterfaceImplementationDocItem\(TypeDocItem, IProperty, XElement\)](DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/ExplicitInterfaceImplementationDocItem.md#DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem,IProperty,System.Xml.Linq.XElement) 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem\.ExplicitInterfaceImplementationDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IProperty, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') type\. | + + + +## ExplicitInterfaceImplementationDocItem\(TypeDocItem, IEvent, XElement\) Constructor + +Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') type\. + +```csharp +public ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, IEvent @event, System.Xml.Linq.XElement? documentation); +``` +#### Parameters + + + +`parent` [TypeDocItem](../../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') + +The [TypeDocItem](../../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') parent type of the interface event explicitly implemented\. + + + +`event` [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEvent') + +The [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEvent') of the interface event explicitly implemented\. + + + +`documentation` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') documentation element of the interface event explicitly implemented\. + + + +## ExplicitInterfaceImplementationDocItem\(TypeDocItem, IMethod, XElement\) Constructor + +Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') type\. + +```csharp +public ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, IMethod method, System.Xml.Linq.XElement? documentation); +``` +#### Parameters + + + +`parent` [TypeDocItem](../../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') + +The [TypeDocItem](../../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') parent type of the interface method explicitly implemented\. + + + +`method` [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') + +The [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') of the interface method explicitly implemented\. + + + +`documentation` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') documentation element of the interface method explicitly implemented\. + + + +## ExplicitInterfaceImplementationDocItem\(TypeDocItem, IProperty, XElement\) Constructor + +Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') type\. + +```csharp +public ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, IProperty property, System.Xml.Linq.XElement? documentation); +``` +#### Parameters + + + +`parent` [TypeDocItem](../../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') + +The [TypeDocItem](../../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') parent type of the interface property explicitly implemented\. + + + +`property` [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IProperty') + +The [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IProperty') of the interface property explicitly implemented\. + + + +`documentation` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') documentation element of the interface property explicitly implemented\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/Member.md b/documentation/api/DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/Member.md new file mode 100644 index 00000000..fcc0c421 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/Member.md @@ -0,0 +1,14 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[ExplicitInterfaceImplementationDocItem](index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') + +## ExplicitInterfaceImplementationDocItem\.Member Property + +Gets the [IMember](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMember') of the current instance\. +It can either be an [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEvent'), [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IProperty') or [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod')\. + +```csharp +public IMember Member { get; } +``` + +#### Property Value +[IMember](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMember') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/Parameters.md b/documentation/api/DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/Parameters.md new file mode 100644 index 00000000..18991a0d --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/Parameters.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[ExplicitInterfaceImplementationDocItem](index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') + +## ExplicitInterfaceImplementationDocItem\.Parameters Property + +Gets the [ParameterDocItem](../../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. + +```csharp +public System.Collections.Generic.IEnumerable Parameters { get; } +``` + +Implements [Parameters](../../IParameterizedDocItem/Parameters.md 'DefaultDocumentation\.Models\.IParameterizedDocItem\.Parameters') + +#### Property Value +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[ParameterDocItem](../../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/TypeParameters.md b/documentation/api/DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/TypeParameters.md new file mode 100644 index 00000000..867ecf25 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/TypeParameters.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[ExplicitInterfaceImplementationDocItem](index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') + +## ExplicitInterfaceImplementationDocItem\.TypeParameters Property + +Gets the [TypeParameterDocItem](../../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') of this instance\. + +```csharp +public System.Collections.Generic.IEnumerable TypeParameters { get; } +``` + +Implements [TypeParameters](../../ITypeParameterizedDocItem/TypeParameters.md 'DefaultDocumentation\.Models\.ITypeParameterizedDocItem\.TypeParameters') + +#### Property Value +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[TypeParameterDocItem](../../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/index.md b/documentation/api/DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/index.md new file mode 100644 index 00000000..d691050b --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members') + +## ExplicitInterfaceImplementationDocItem Class + +Represents an explicit interface implementation documentation\. + +```csharp +public sealed class ExplicitInterfaceImplementationDocItem : DefaultDocumentation.Models.EntityDocItem, DefaultDocumentation.Models.ITypeParameterizedDocItem, DefaultDocumentation.Models.IParameterizedDocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 [EntityDocItem](../../EntityDocItem/index.md 'DefaultDocumentation\.Models\.EntityDocItem') 🡒 ExplicitInterfaceImplementationDocItem + +Implements [ITypeParameterizedDocItem](../../ITypeParameterizedDocItem/index.md 'DefaultDocumentation\.Models\.ITypeParameterizedDocItem'), [IParameterizedDocItem](../../IParameterizedDocItem/index.md 'DefaultDocumentation\.Models\.IParameterizedDocItem') + +| Constructors | | +| :--- | :--- | +| [ExplicitInterfaceImplementationDocItem\(TypeDocItem, IEvent, XElement\)](ExplicitInterfaceImplementationDocItem.md#DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem,IEvent,System.Xml.Linq.XElement) 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem\.ExplicitInterfaceImplementationDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IEvent, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') type\. | +| [ExplicitInterfaceImplementationDocItem\(TypeDocItem, IMethod, XElement\)](ExplicitInterfaceImplementationDocItem.md#DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem,IMethod,System.Xml.Linq.XElement) 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem\.ExplicitInterfaceImplementationDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IMethod, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') type\. | +| [ExplicitInterfaceImplementationDocItem\(TypeDocItem, IProperty, XElement\)](ExplicitInterfaceImplementationDocItem.md#DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem,IProperty,System.Xml.Linq.XElement) 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem\.ExplicitInterfaceImplementationDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IProperty, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') type\. | + +| Properties | | +| :--- | :--- | +| [Member](Member.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem\.Member') | Gets the [IMember](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMember') of the current instance\. It can either be an [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEvent'), [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IProperty') or [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod')\. | +| [Parameters](Parameters.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem\.Parameters') | Gets the [ParameterDocItem](../../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. | +| [TypeParameters](TypeParameters.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem\.TypeParameters') | Gets the [TypeParameterDocItem](../../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') of this instance\. | diff --git a/documentation/api/DefaultDocumentation/Models/Members/FieldDocItem/Field.md b/documentation/api/DefaultDocumentation/Models/Members/FieldDocItem/Field.md new file mode 100644 index 00000000..45425800 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/FieldDocItem/Field.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[FieldDocItem](index.md 'DefaultDocumentation\.Models\.Members\.FieldDocItem') + +## FieldDocItem\.Field Property + +Gets the [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IField') of the current instance\. + +```csharp +public IField Field { get; } +``` + +#### Property Value +[IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IField') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/FieldDocItem/FieldDocItem(TypeDocItem,IField,XElement).md b/documentation/api/DefaultDocumentation/Models/Members/FieldDocItem/FieldDocItem(TypeDocItem,IField,XElement).md new file mode 100644 index 00000000..4e6f8aef --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/FieldDocItem/FieldDocItem(TypeDocItem,IField,XElement).md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[FieldDocItem](index.md 'DefaultDocumentation\.Models\.Members\.FieldDocItem') + +## FieldDocItem\(TypeDocItem, IField, XElement\) Constructor + +Initialize a new instance of the [FieldDocItem](index.md 'DefaultDocumentation\.Models\.Members\.FieldDocItem') type\. + +```csharp +public FieldDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, IField field, System.Xml.Linq.XElement? documentation); +``` +#### Parameters + + + +`parent` [TypeDocItem](../../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') + +The [TypeDocItem](../../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') parent type of the field\. + + + +`field` [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IField') + +The [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IField') of the field\. + + + +`documentation` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') documentation element of the field\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/FieldDocItem/index.md b/documentation/api/DefaultDocumentation/Models/Members/FieldDocItem/index.md new file mode 100644 index 00000000..ebe65c24 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/FieldDocItem/index.md @@ -0,0 +1,20 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members') + +## FieldDocItem Class + +Represents an [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IField') documentation\. + +```csharp +public sealed class FieldDocItem : DefaultDocumentation.Models.EntityDocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 [EntityDocItem](../../EntityDocItem/index.md 'DefaultDocumentation\.Models\.EntityDocItem') 🡒 FieldDocItem + +| Constructors | | +| :--- | :--- | +| [FieldDocItem\(TypeDocItem, IField, XElement\)](FieldDocItem(TypeDocItem,IField,XElement).md 'DefaultDocumentation\.Models\.Members\.FieldDocItem\.FieldDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IField, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [FieldDocItem](DefaultDocumentation/Models/Members/FieldDocItem/index.md 'DefaultDocumentation\.Models\.Members\.FieldDocItem') type\. | + +| Properties | | +| :--- | :--- | +| [Field](Field.md 'DefaultDocumentation\.Models\.Members\.FieldDocItem\.Field') | Gets the [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IField') of the current instance\. | diff --git a/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/Method.md b/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/Method.md new file mode 100644 index 00000000..64b85c1e --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/Method.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[MethodDocItem](index.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem') + +## MethodDocItem\.Method Property + +Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') of the current instance\. + +```csharp +public IMethod Method { get; } +``` + +#### Property Value +[IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/MethodDocItem(TypeDocItem,IMethod,XElement).md b/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/MethodDocItem(TypeDocItem,IMethod,XElement).md new file mode 100644 index 00000000..1610da85 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/MethodDocItem(TypeDocItem,IMethod,XElement).md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[MethodDocItem](index.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem') + +## MethodDocItem\(TypeDocItem, IMethod, XElement\) Constructor + +Initialize a new instance of the [MethodDocItem](index.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem') type\. + +```csharp +public MethodDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, IMethod method, System.Xml.Linq.XElement? documentation); +``` +#### Parameters + + + +`parent` [TypeDocItem](../../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') + +The [TypeDocItem](../../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') parent type of the method\. + + + +`method` [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') + +The [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') of the method\. + + + +`documentation` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') documentation element of the method\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/Parameters.md b/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/Parameters.md new file mode 100644 index 00000000..5ff618dc --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/Parameters.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[MethodDocItem](index.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem') + +## MethodDocItem\.Parameters Property + +Gets the [ParameterDocItem](../../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. + +```csharp +public System.Collections.Generic.IEnumerable Parameters { get; } +``` + +Implements [Parameters](../../IParameterizedDocItem/Parameters.md 'DefaultDocumentation\.Models\.IParameterizedDocItem\.Parameters') + +#### Property Value +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[ParameterDocItem](../../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/TypeParameters.md b/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/TypeParameters.md new file mode 100644 index 00000000..09c3b06d --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/TypeParameters.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[MethodDocItem](index.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem') + +## MethodDocItem\.TypeParameters Property + +Gets the [TypeParameterDocItem](../../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') of this instance\. + +```csharp +public System.Collections.Generic.IEnumerable TypeParameters { get; } +``` + +Implements [TypeParameters](../../ITypeParameterizedDocItem/TypeParameters.md 'DefaultDocumentation\.Models\.ITypeParameterizedDocItem\.TypeParameters') + +#### Property Value +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[TypeParameterDocItem](../../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/index.md b/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/index.md new file mode 100644 index 00000000..f3e045c0 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/index.md @@ -0,0 +1,24 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members') + +## MethodDocItem Class + +Represents an [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') documentation\. + +```csharp +public sealed class MethodDocItem : DefaultDocumentation.Models.EntityDocItem, DefaultDocumentation.Models.ITypeParameterizedDocItem, DefaultDocumentation.Models.IParameterizedDocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 [EntityDocItem](../../EntityDocItem/index.md 'DefaultDocumentation\.Models\.EntityDocItem') 🡒 MethodDocItem + +Implements [ITypeParameterizedDocItem](../../ITypeParameterizedDocItem/index.md 'DefaultDocumentation\.Models\.ITypeParameterizedDocItem'), [IParameterizedDocItem](../../IParameterizedDocItem/index.md 'DefaultDocumentation\.Models\.IParameterizedDocItem') + +| Constructors | | +| :--- | :--- | +| [MethodDocItem\(TypeDocItem, IMethod, XElement\)](MethodDocItem(TypeDocItem,IMethod,XElement).md 'DefaultDocumentation\.Models\.Members\.MethodDocItem\.MethodDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IMethod, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [MethodDocItem](DefaultDocumentation/Models/Members/MethodDocItem/index.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem') type\. | + +| Properties | | +| :--- | :--- | +| [Method](Method.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem\.Method') | Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') of the current instance\. | +| [Parameters](Parameters.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem\.Parameters') | Gets the [ParameterDocItem](../../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. | +| [TypeParameters](TypeParameters.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem\.TypeParameters') | Gets the [TypeParameterDocItem](../../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') of this instance\. | diff --git a/documentation/api/DefaultDocumentation/Models/Members/OperatorDocItem/Method.md b/documentation/api/DefaultDocumentation/Models/Members/OperatorDocItem/Method.md new file mode 100644 index 00000000..42f4c8bd --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/OperatorDocItem/Method.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[OperatorDocItem](index.md 'DefaultDocumentation\.Models\.Members\.OperatorDocItem') + +## OperatorDocItem\.Method Property + +Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') of the current instance\. + +```csharp +public IMethod Method { get; } +``` + +#### Property Value +[IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/OperatorDocItem/OperatorDocItem(TypeDocItem,IMethod,XElement).md b/documentation/api/DefaultDocumentation/Models/Members/OperatorDocItem/OperatorDocItem(TypeDocItem,IMethod,XElement).md new file mode 100644 index 00000000..54344041 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/OperatorDocItem/OperatorDocItem(TypeDocItem,IMethod,XElement).md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[OperatorDocItem](index.md 'DefaultDocumentation\.Models\.Members\.OperatorDocItem') + +## OperatorDocItem\(TypeDocItem, IMethod, XElement\) Constructor + +Initialize a new instance of the [OperatorDocItem](index.md 'DefaultDocumentation\.Models\.Members\.OperatorDocItem') type\. + +```csharp +public OperatorDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, IMethod method, System.Xml.Linq.XElement? documentation); +``` +#### Parameters + + + +`parent` [TypeDocItem](../../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') + +The [TypeDocItem](../../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') parent type of the operator\. + + + +`method` [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') + +The [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') of the operator\. + + + +`documentation` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') documentation element of the operator\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/OperatorDocItem/Parameters.md b/documentation/api/DefaultDocumentation/Models/Members/OperatorDocItem/Parameters.md new file mode 100644 index 00000000..afc41239 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/OperatorDocItem/Parameters.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[OperatorDocItem](index.md 'DefaultDocumentation\.Models\.Members\.OperatorDocItem') + +## OperatorDocItem\.Parameters Property + +Gets the [ParameterDocItem](../../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. + +```csharp +public System.Collections.Generic.IEnumerable Parameters { get; } +``` + +Implements [Parameters](../../IParameterizedDocItem/Parameters.md 'DefaultDocumentation\.Models\.IParameterizedDocItem\.Parameters') + +#### Property Value +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[ParameterDocItem](../../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/OperatorDocItem/index.md b/documentation/api/DefaultDocumentation/Models/Members/OperatorDocItem/index.md new file mode 100644 index 00000000..be613bae --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/OperatorDocItem/index.md @@ -0,0 +1,23 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members') + +## OperatorDocItem Class + +Represents an operator [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') documentation\. + +```csharp +public sealed class OperatorDocItem : DefaultDocumentation.Models.EntityDocItem, DefaultDocumentation.Models.IParameterizedDocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 [EntityDocItem](../../EntityDocItem/index.md 'DefaultDocumentation\.Models\.EntityDocItem') 🡒 OperatorDocItem + +Implements [IParameterizedDocItem](../../IParameterizedDocItem/index.md 'DefaultDocumentation\.Models\.IParameterizedDocItem') + +| Constructors | | +| :--- | :--- | +| [OperatorDocItem\(TypeDocItem, IMethod, XElement\)](OperatorDocItem(TypeDocItem,IMethod,XElement).md 'DefaultDocumentation\.Models\.Members\.OperatorDocItem\.OperatorDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IMethod, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [OperatorDocItem](DefaultDocumentation/Models/Members/OperatorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.OperatorDocItem') type\. | + +| Properties | | +| :--- | :--- | +| [Method](Method.md 'DefaultDocumentation\.Models\.Members\.OperatorDocItem\.Method') | Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') of the current instance\. | +| [Parameters](Parameters.md 'DefaultDocumentation\.Models\.Members\.OperatorDocItem\.Parameters') | Gets the [ParameterDocItem](../../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. | diff --git a/documentation/api/DefaultDocumentation/Models/Members/PropertyDocItem/Parameters.md b/documentation/api/DefaultDocumentation/Models/Members/PropertyDocItem/Parameters.md new file mode 100644 index 00000000..235cb073 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/PropertyDocItem/Parameters.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[PropertyDocItem](index.md 'DefaultDocumentation\.Models\.Members\.PropertyDocItem') + +## PropertyDocItem\.Parameters Property + +Gets the [ParameterDocItem](../../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. + +```csharp +public System.Collections.Generic.IEnumerable Parameters { get; } +``` + +Implements [Parameters](../../IParameterizedDocItem/Parameters.md 'DefaultDocumentation\.Models\.IParameterizedDocItem\.Parameters') + +#### Property Value +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[ParameterDocItem](../../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/PropertyDocItem/Property.md b/documentation/api/DefaultDocumentation/Models/Members/PropertyDocItem/Property.md new file mode 100644 index 00000000..34f20578 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/PropertyDocItem/Property.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[PropertyDocItem](index.md 'DefaultDocumentation\.Models\.Members\.PropertyDocItem') + +## PropertyDocItem\.Property Property + +Gets the [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IProperty') of the current instance\. + +```csharp +public IProperty Property { get; } +``` + +#### Property Value +[IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IProperty') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/PropertyDocItem/PropertyDocItem(TypeDocItem,IProperty,XElement).md b/documentation/api/DefaultDocumentation/Models/Members/PropertyDocItem/PropertyDocItem(TypeDocItem,IProperty,XElement).md new file mode 100644 index 00000000..5a869b0b --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/PropertyDocItem/PropertyDocItem(TypeDocItem,IProperty,XElement).md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members').[PropertyDocItem](index.md 'DefaultDocumentation\.Models\.Members\.PropertyDocItem') + +## PropertyDocItem\(TypeDocItem, IProperty, XElement\) Constructor + +Initialize a new instance of the [PropertyDocItem](index.md 'DefaultDocumentation\.Models\.Members\.PropertyDocItem') type\. + +```csharp +public PropertyDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, IProperty property, System.Xml.Linq.XElement? documentation); +``` +#### Parameters + + + +`parent` [TypeDocItem](../../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') + +The [TypeDocItem](../../Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') parent type of the property\. + + + +`property` [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IProperty') + +The [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IProperty') of the property\. + + + +`documentation` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') documentation element of the property\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Members/PropertyDocItem/index.md b/documentation/api/DefaultDocumentation/Models/Members/PropertyDocItem/index.md new file mode 100644 index 00000000..bec011b8 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Members/PropertyDocItem/index.md @@ -0,0 +1,23 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Members](../../../../index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation\.Models\.Members') + +## PropertyDocItem Class + +Represents an [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IProperty') documentation\. + +```csharp +public sealed class PropertyDocItem : DefaultDocumentation.Models.EntityDocItem, DefaultDocumentation.Models.IParameterizedDocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 [EntityDocItem](../../EntityDocItem/index.md 'DefaultDocumentation\.Models\.EntityDocItem') 🡒 PropertyDocItem + +Implements [IParameterizedDocItem](../../IParameterizedDocItem/index.md 'DefaultDocumentation\.Models\.IParameterizedDocItem') + +| Constructors | | +| :--- | :--- | +| [PropertyDocItem\(TypeDocItem, IProperty, XElement\)](PropertyDocItem(TypeDocItem,IProperty,XElement).md 'DefaultDocumentation\.Models\.Members\.PropertyDocItem\.PropertyDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IProperty, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [PropertyDocItem](DefaultDocumentation/Models/Members/PropertyDocItem/index.md 'DefaultDocumentation\.Models\.Members\.PropertyDocItem') type\. | + +| Properties | | +| :--- | :--- | +| [Parameters](Parameters.md 'DefaultDocumentation\.Models\.Members\.PropertyDocItem\.Parameters') | Gets the [ParameterDocItem](../../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. | +| [Property](Property.md 'DefaultDocumentation\.Models\.Members\.PropertyDocItem\.Property') | Gets the [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IProperty') of the current instance\. | diff --git a/documentation/api/DefaultDocumentation/Models/NamespaceDocItem/NamespaceDocItem(AssemblyDocItem,string,XElement).md b/documentation/api/DefaultDocumentation/Models/NamespaceDocItem/NamespaceDocItem(AssemblyDocItem,string,XElement).md new file mode 100644 index 00000000..084ef405 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/NamespaceDocItem/NamespaceDocItem(AssemblyDocItem,string,XElement).md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models').[NamespaceDocItem](index.md 'DefaultDocumentation\.Models\.NamespaceDocItem') + +## NamespaceDocItem\(AssemblyDocItem, string, XElement\) Constructor + +Initialize a new instance of the [NamespaceDocItem](index.md 'DefaultDocumentation\.Models\.NamespaceDocItem') type\. + +```csharp +public NamespaceDocItem(DefaultDocumentation.Models.AssemblyDocItem parent, string name, System.Xml.Linq.XElement? documentation); +``` +#### Parameters + + + +`parent` [AssemblyDocItem](../AssemblyDocItem/index.md 'DefaultDocumentation\.Models\.AssemblyDocItem') + +The [AssemblyDocItem](../AssemblyDocItem/index.md 'DefaultDocumentation\.Models\.AssemblyDocItem') parent assembly of the namespace\. + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The name of the namespace\. + + + +`documentation` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') documentation element of the namespace\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/NamespaceDocItem/index.md b/documentation/api/DefaultDocumentation/Models/NamespaceDocItem/index.md new file mode 100644 index 00000000..b3f78759 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/NamespaceDocItem/index.md @@ -0,0 +1,16 @@ +#### [DefaultDocumentation\.Api](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models') + +## NamespaceDocItem Class + +Represents a namespace documentation\. + +```csharp +public sealed class NamespaceDocItem : DefaultDocumentation.Models.DocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 NamespaceDocItem + +| Constructors | | +| :--- | :--- | +| [NamespaceDocItem\(AssemblyDocItem, string, XElement\)](NamespaceDocItem(AssemblyDocItem,string,XElement).md 'DefaultDocumentation\.Models\.NamespaceDocItem\.NamespaceDocItem\(DefaultDocumentation\.Models\.AssemblyDocItem, string, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [NamespaceDocItem](DefaultDocumentation/Models/NamespaceDocItem/index.md 'DefaultDocumentation\.Models\.NamespaceDocItem') type\. | diff --git a/documentation/api/DefaultDocumentation/Models/Parameters/ParameterDocItem/Parameter.md b/documentation/api/DefaultDocumentation/Models/Parameters/ParameterDocItem/Parameter.md new file mode 100644 index 00000000..bb43227d --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Parameters/ParameterDocItem/Parameter.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Parameters](../../../../index.md#DefaultDocumentation.Models.Parameters 'DefaultDocumentation\.Models\.Parameters').[ParameterDocItem](index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') + +## ParameterDocItem\.Parameter Property + +Gets the [IParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IParameter') of the current instance\. + +```csharp +public IParameter Parameter { get; } +``` + +#### Property Value +[IParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IParameter') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Parameters/ParameterDocItem/index.md b/documentation/api/DefaultDocumentation/Models/Parameters/ParameterDocItem/index.md new file mode 100644 index 00000000..2f976323 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Parameters/ParameterDocItem/index.md @@ -0,0 +1,16 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Parameters](../../../../index.md#DefaultDocumentation.Models.Parameters 'DefaultDocumentation\.Models\.Parameters') + +## ParameterDocItem Class + +Represents an [IParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IParameter') documentation\. + +```csharp +public sealed class ParameterDocItem : DefaultDocumentation.Models.DocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 ParameterDocItem + +| Properties | | +| :--- | :--- | +| [Parameter](Parameter.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem\.Parameter') | Gets the [IParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IParameter') of the current instance\. | diff --git a/documentation/api/DefaultDocumentation/Models/Parameters/TypeParameterDocItem/TypeParameter.md b/documentation/api/DefaultDocumentation/Models/Parameters/TypeParameterDocItem/TypeParameter.md new file mode 100644 index 00000000..8874eb8b --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Parameters/TypeParameterDocItem/TypeParameter.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Parameters](../../../../index.md#DefaultDocumentation.Models.Parameters 'DefaultDocumentation\.Models\.Parameters').[TypeParameterDocItem](index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') + +## TypeParameterDocItem\.TypeParameter Property + +Gets the [ITypeParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeParameter') of the current instance\. + +```csharp +public ITypeParameter TypeParameter { get; } +``` + +#### Property Value +[ITypeParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeParameter') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Parameters/TypeParameterDocItem/index.md b/documentation/api/DefaultDocumentation/Models/Parameters/TypeParameterDocItem/index.md new file mode 100644 index 00000000..ef6062d0 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Parameters/TypeParameterDocItem/index.md @@ -0,0 +1,16 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Parameters](../../../../index.md#DefaultDocumentation.Models.Parameters 'DefaultDocumentation\.Models\.Parameters') + +## TypeParameterDocItem Class + +Represents an [ITypeParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeParameter') documentation\. + +```csharp +public sealed class TypeParameterDocItem : DefaultDocumentation.Models.DocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 TypeParameterDocItem + +| Properties | | +| :--- | :--- | +| [TypeParameter](TypeParameter.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem\.TypeParameter') | Gets the [ITypeParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeParameter') of the current instance\. | diff --git a/documentation/api/DefaultDocumentation/Models/Types/ClassDocItem/ClassDocItem(DocItem,ITypeDefinition,XElement).md b/documentation/api/DefaultDocumentation/Models/Types/ClassDocItem/ClassDocItem(DocItem,ITypeDefinition,XElement).md new file mode 100644 index 00000000..f76c61f3 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Types/ClassDocItem/ClassDocItem(DocItem,ITypeDefinition,XElement).md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Types](../../../../index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation\.Models\.Types').[ClassDocItem](index.md 'DefaultDocumentation\.Models\.Types\.ClassDocItem') + +## ClassDocItem\(DocItem, ITypeDefinition, XElement\) Constructor + +Initialize a new instance of the [ClassDocItem](index.md 'DefaultDocumentation\.Models\.Types\.ClassDocItem') type\. + +```csharp +public ClassDocItem(DefaultDocumentation.Models.DocItem parent, ITypeDefinition type, System.Xml.Linq.XElement? documentation); +``` +#### Parameters + + + +`parent` [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') parent type or namespace of the class\. + + + +`type` [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') + +The [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') of the class\. + + + +`documentation` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') documentation element of the class\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Types/ClassDocItem/index.md b/documentation/api/DefaultDocumentation/Models/Types/ClassDocItem/index.md new file mode 100644 index 00000000..bed533c2 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Types/ClassDocItem/index.md @@ -0,0 +1,16 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Types](../../../../index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation\.Models\.Types') + +## ClassDocItem Class + +Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') of the [TypeKind\.Class](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.TypeKind\.Class') kind documentation\. + +```csharp +public sealed class ClassDocItem : DefaultDocumentation.Models.Types.TypeDocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 [EntityDocItem](../../EntityDocItem/index.md 'DefaultDocumentation\.Models\.EntityDocItem') 🡒 [TypeDocItem](../TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') 🡒 ClassDocItem + +| Constructors | | +| :--- | :--- | +| [ClassDocItem\(DocItem, ITypeDefinition, XElement\)](ClassDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation\.Models\.Types\.ClassDocItem\.ClassDocItem\(DefaultDocumentation\.Models\.DocItem, ITypeDefinition, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [ClassDocItem](DefaultDocumentation/Models/Types/ClassDocItem/index.md 'DefaultDocumentation\.Models\.Types\.ClassDocItem') type\. | diff --git a/documentation/api/DefaultDocumentation/Models/Types/DelegateDocItem/DelegateDocItem(DocItem,ITypeDefinition,XElement).md b/documentation/api/DefaultDocumentation/Models/Types/DelegateDocItem/DelegateDocItem(DocItem,ITypeDefinition,XElement).md new file mode 100644 index 00000000..c9ab3266 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Types/DelegateDocItem/DelegateDocItem(DocItem,ITypeDefinition,XElement).md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Types](../../../../index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation\.Models\.Types').[DelegateDocItem](index.md 'DefaultDocumentation\.Models\.Types\.DelegateDocItem') + +## DelegateDocItem\(DocItem, ITypeDefinition, XElement\) Constructor + +Initialize a new instance of the [StructDocItem](../StructDocItem/index.md 'DefaultDocumentation\.Models\.Types\.StructDocItem') type\. + +```csharp +public DelegateDocItem(DefaultDocumentation.Models.DocItem parent, ITypeDefinition type, System.Xml.Linq.XElement? documentation); +``` +#### Parameters + + + +`parent` [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') parent type or namespace of the delegate\. + + + +`type` [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') + +The [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') of the delegate\. + + + +`documentation` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') documentation element of the delegate\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Types/DelegateDocItem/InvokeMethod.md b/documentation/api/DefaultDocumentation/Models/Types/DelegateDocItem/InvokeMethod.md new file mode 100644 index 00000000..2716fb61 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Types/DelegateDocItem/InvokeMethod.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Types](../../../../index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation\.Models\.Types').[DelegateDocItem](index.md 'DefaultDocumentation\.Models\.Types\.DelegateDocItem') + +## DelegateDocItem\.InvokeMethod Property + +Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') of the current instance\. + +```csharp +public IMethod InvokeMethod { get; } +``` + +#### Property Value +[IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Types/DelegateDocItem/Parameters.md b/documentation/api/DefaultDocumentation/Models/Types/DelegateDocItem/Parameters.md new file mode 100644 index 00000000..1051f6d2 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Types/DelegateDocItem/Parameters.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Types](../../../../index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation\.Models\.Types').[DelegateDocItem](index.md 'DefaultDocumentation\.Models\.Types\.DelegateDocItem') + +## DelegateDocItem\.Parameters Property + +Gets the [ParameterDocItem](../../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. + +```csharp +public System.Collections.Generic.IEnumerable Parameters { get; } +``` + +Implements [Parameters](../../IParameterizedDocItem/Parameters.md 'DefaultDocumentation\.Models\.IParameterizedDocItem\.Parameters') + +#### Property Value +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[ParameterDocItem](../../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Types/DelegateDocItem/index.md b/documentation/api/DefaultDocumentation/Models/Types/DelegateDocItem/index.md new file mode 100644 index 00000000..d501ca8b --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Types/DelegateDocItem/index.md @@ -0,0 +1,23 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Types](../../../../index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation\.Models\.Types') + +## DelegateDocItem Class + +Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') of the [TypeKind\.Delegate](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.TypeKind\.Delegate') kind documentation\. + +```csharp +public sealed class DelegateDocItem : DefaultDocumentation.Models.Types.TypeDocItem, DefaultDocumentation.Models.IParameterizedDocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 [EntityDocItem](../../EntityDocItem/index.md 'DefaultDocumentation\.Models\.EntityDocItem') 🡒 [TypeDocItem](../TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') 🡒 DelegateDocItem + +Implements [IParameterizedDocItem](../../IParameterizedDocItem/index.md 'DefaultDocumentation\.Models\.IParameterizedDocItem') + +| Constructors | | +| :--- | :--- | +| [DelegateDocItem\(DocItem, ITypeDefinition, XElement\)](DelegateDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation\.Models\.Types\.DelegateDocItem\.DelegateDocItem\(DefaultDocumentation\.Models\.DocItem, ITypeDefinition, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [StructDocItem](../StructDocItem/index.md 'DefaultDocumentation\.Models\.Types\.StructDocItem') type\. | + +| Properties | | +| :--- | :--- | +| [InvokeMethod](InvokeMethod.md 'DefaultDocumentation\.Models\.Types\.DelegateDocItem\.InvokeMethod') | Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') of the current instance\. | +| [Parameters](Parameters.md 'DefaultDocumentation\.Models\.Types\.DelegateDocItem\.Parameters') | Gets the [ParameterDocItem](../../Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. | diff --git a/documentation/api/DefaultDocumentation/Models/Types/EnumDocItem/EnumDocItem(DocItem,ITypeDefinition,XElement).md b/documentation/api/DefaultDocumentation/Models/Types/EnumDocItem/EnumDocItem(DocItem,ITypeDefinition,XElement).md new file mode 100644 index 00000000..94f61f39 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Types/EnumDocItem/EnumDocItem(DocItem,ITypeDefinition,XElement).md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Types](../../../../index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation\.Models\.Types').[EnumDocItem](index.md 'DefaultDocumentation\.Models\.Types\.EnumDocItem') + +## EnumDocItem\(DocItem, ITypeDefinition, XElement\) Constructor + +Initialize a new instance of the [StructDocItem](../StructDocItem/index.md 'DefaultDocumentation\.Models\.Types\.StructDocItem') type\. + +```csharp +public EnumDocItem(DefaultDocumentation.Models.DocItem parent, ITypeDefinition type, System.Xml.Linq.XElement? documentation); +``` +#### Parameters + + + +`parent` [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') parent type or namespace of the enum\. + + + +`type` [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') + +The [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') of the enum\. + + + +`documentation` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') documentation element of the enum\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Types/EnumDocItem/index.md b/documentation/api/DefaultDocumentation/Models/Types/EnumDocItem/index.md new file mode 100644 index 00000000..b319da60 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Types/EnumDocItem/index.md @@ -0,0 +1,16 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Types](../../../../index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation\.Models\.Types') + +## EnumDocItem Class + +Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') of the [TypeKind\.Enum](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.TypeKind\.Enum') kind documentation\. + +```csharp +public sealed class EnumDocItem : DefaultDocumentation.Models.Types.TypeDocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 [EntityDocItem](../../EntityDocItem/index.md 'DefaultDocumentation\.Models\.EntityDocItem') 🡒 [TypeDocItem](../TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') 🡒 EnumDocItem + +| Constructors | | +| :--- | :--- | +| [EnumDocItem\(DocItem, ITypeDefinition, XElement\)](EnumDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation\.Models\.Types\.EnumDocItem\.EnumDocItem\(DefaultDocumentation\.Models\.DocItem, ITypeDefinition, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [StructDocItem](../StructDocItem/index.md 'DefaultDocumentation\.Models\.Types\.StructDocItem') type\. | diff --git a/documentation/api/DefaultDocumentation/Models/Types/InterfaceDocItem/InterfaceDocItem(DocItem,ITypeDefinition,XElement).md b/documentation/api/DefaultDocumentation/Models/Types/InterfaceDocItem/InterfaceDocItem(DocItem,ITypeDefinition,XElement).md new file mode 100644 index 00000000..d582c28f --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Types/InterfaceDocItem/InterfaceDocItem(DocItem,ITypeDefinition,XElement).md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Types](../../../../index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation\.Models\.Types').[InterfaceDocItem](index.md 'DefaultDocumentation\.Models\.Types\.InterfaceDocItem') + +## InterfaceDocItem\(DocItem, ITypeDefinition, XElement\) Constructor + +Initialize a new instance of the [StructDocItem](../StructDocItem/index.md 'DefaultDocumentation\.Models\.Types\.StructDocItem') type\. + +```csharp +public InterfaceDocItem(DefaultDocumentation.Models.DocItem parent, ITypeDefinition type, System.Xml.Linq.XElement? documentation); +``` +#### Parameters + + + +`parent` [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') parent type or namespace of the interface\. + + + +`type` [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') + +The [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') of the interface\. + + + +`documentation` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') documentation element of the interface\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Types/InterfaceDocItem/index.md b/documentation/api/DefaultDocumentation/Models/Types/InterfaceDocItem/index.md new file mode 100644 index 00000000..47b97771 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Types/InterfaceDocItem/index.md @@ -0,0 +1,16 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Types](../../../../index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation\.Models\.Types') + +## InterfaceDocItem Class + +Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') of the [TypeKind\.Interface](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.TypeKind\.Interface') kind documentation\. + +```csharp +public sealed class InterfaceDocItem : DefaultDocumentation.Models.Types.TypeDocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 [EntityDocItem](../../EntityDocItem/index.md 'DefaultDocumentation\.Models\.EntityDocItem') 🡒 [TypeDocItem](../TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') 🡒 InterfaceDocItem + +| Constructors | | +| :--- | :--- | +| [InterfaceDocItem\(DocItem, ITypeDefinition, XElement\)](InterfaceDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation\.Models\.Types\.InterfaceDocItem\.InterfaceDocItem\(DefaultDocumentation\.Models\.DocItem, ITypeDefinition, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [StructDocItem](../StructDocItem/index.md 'DefaultDocumentation\.Models\.Types\.StructDocItem') type\. | diff --git a/documentation/api/DefaultDocumentation/Models/Types/StructDocItem/StructDocItem(DocItem,ITypeDefinition,XElement).md b/documentation/api/DefaultDocumentation/Models/Types/StructDocItem/StructDocItem(DocItem,ITypeDefinition,XElement).md new file mode 100644 index 00000000..9af88b80 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Types/StructDocItem/StructDocItem(DocItem,ITypeDefinition,XElement).md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Types](../../../../index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation\.Models\.Types').[StructDocItem](index.md 'DefaultDocumentation\.Models\.Types\.StructDocItem') + +## StructDocItem\(DocItem, ITypeDefinition, XElement\) Constructor + +Initialize a new instance of the [StructDocItem](index.md 'DefaultDocumentation\.Models\.Types\.StructDocItem') type\. + +```csharp +public StructDocItem(DefaultDocumentation.Models.DocItem parent, ITypeDefinition type, System.Xml.Linq.XElement? documentation); +``` +#### Parameters + + + +`parent` [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') parent type or namespace of the class\. + + + +`type` [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') + +The [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') of the struct\. + + + +`documentation` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') documentation element of the struct\. \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Types/StructDocItem/index.md b/documentation/api/DefaultDocumentation/Models/Types/StructDocItem/index.md new file mode 100644 index 00000000..837b50ff --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Types/StructDocItem/index.md @@ -0,0 +1,16 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Types](../../../../index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation\.Models\.Types') + +## StructDocItem Class + +Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') of the [TypeKind\.Struct](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.TypeKind\.Struct') kind documentation\. + +```csharp +public sealed class StructDocItem : DefaultDocumentation.Models.Types.TypeDocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 [EntityDocItem](../../EntityDocItem/index.md 'DefaultDocumentation\.Models\.EntityDocItem') 🡒 [TypeDocItem](../TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') 🡒 StructDocItem + +| Constructors | | +| :--- | :--- | +| [StructDocItem\(DocItem, ITypeDefinition, XElement\)](StructDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation\.Models\.Types\.StructDocItem\.StructDocItem\(DefaultDocumentation\.Models\.DocItem, ITypeDefinition, System\.Xml\.Linq\.XElement\)') | Initialize a new instance of the [StructDocItem](DefaultDocumentation/Models/Types/StructDocItem/index.md 'DefaultDocumentation\.Models\.Types\.StructDocItem') type\. | diff --git a/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/Type.md b/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/Type.md new file mode 100644 index 00000000..bc68c8d0 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/Type.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Types](../../../../index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation\.Models\.Types').[TypeDocItem](index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') + +## TypeDocItem\.Type Property + +Gets the [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') of the current instance\. + +```csharp +public ITypeDefinition Type { get; } +``` + +#### Property Value +[ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/TypeParameters.md b/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/TypeParameters.md new file mode 100644 index 00000000..43ce1eb5 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/TypeParameters.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Types](../../../../index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation\.Models\.Types').[TypeDocItem](index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') + +## TypeDocItem\.TypeParameters Property + +Gets the [TypeParameterDocItem](../../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') of this instance\. + +```csharp +public System.Collections.Generic.IEnumerable TypeParameters { get; } +``` + +Implements [TypeParameters](../../ITypeParameterizedDocItem/TypeParameters.md 'DefaultDocumentation\.Models\.ITypeParameterizedDocItem\.TypeParameters') + +#### Property Value +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[TypeParameterDocItem](../../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') \ No newline at end of file diff --git a/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/index.md b/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/index.md new file mode 100644 index 00000000..039db534 --- /dev/null +++ b/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [DefaultDocumentation\.Models\.Types](../../../../index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation\.Models\.Types') + +## TypeDocItem Class + +Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') documentation\. + +```csharp +public abstract class TypeDocItem : DefaultDocumentation.Models.EntityDocItem, DefaultDocumentation.Models.ITypeParameterizedDocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](../../DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 [EntityDocItem](../../EntityDocItem/index.md 'DefaultDocumentation\.Models\.EntityDocItem') 🡒 TypeDocItem + +Derived +↳ [ClassDocItem](../ClassDocItem/index.md 'DefaultDocumentation\.Models\.Types\.ClassDocItem') +↳ [DelegateDocItem](../DelegateDocItem/index.md 'DefaultDocumentation\.Models\.Types\.DelegateDocItem') +↳ [EnumDocItem](../EnumDocItem/index.md 'DefaultDocumentation\.Models\.Types\.EnumDocItem') +↳ [InterfaceDocItem](../InterfaceDocItem/index.md 'DefaultDocumentation\.Models\.Types\.InterfaceDocItem') +↳ [StructDocItem](../StructDocItem/index.md 'DefaultDocumentation\.Models\.Types\.StructDocItem') + +Implements [ITypeParameterizedDocItem](../../ITypeParameterizedDocItem/index.md 'DefaultDocumentation\.Models\.ITypeParameterizedDocItem') + +| Properties | | +| :--- | :--- | +| [Type](Type.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem\.Type') | Gets the [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') of the current instance\. | +| [TypeParameters](TypeParameters.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem\.TypeParameters') | Gets the [TypeParameterDocItem](../../Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') of this instance\. | diff --git a/documentation/api/DelegateDocItem.DelegateDocItem(DocItem,ITypeDefinition,XElement).md b/documentation/api/DelegateDocItem.DelegateDocItem(DocItem,ITypeDefinition,XElement).md deleted file mode 100644 index 3a772d99..00000000 --- a/documentation/api/DelegateDocItem.DelegateDocItem(DocItem,ITypeDefinition,XElement).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Types](index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation.Models.Types').[DelegateDocItem](DelegateDocItem.md 'DefaultDocumentation.Models.Types.DelegateDocItem') - -## DelegateDocItem(DocItem, ITypeDefinition, XElement) Constructor - -Initialize a new instance of the [StructDocItem](StructDocItem.md 'DefaultDocumentation.Models.Types.StructDocItem') type. - -```csharp -public DelegateDocItem(DefaultDocumentation.Models.DocItem parent, ITypeDefinition type, System.Xml.Linq.XElement? documentation); -``` -#### Parameters - - - -`parent` [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') parent type or namespace of the delegate. - - - -`type` [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') - -The [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') of the delegate. - - - -`documentation` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') documentation element of the delegate. \ No newline at end of file diff --git a/documentation/api/DelegateDocItem.InvokeMethod.md b/documentation/api/DelegateDocItem.InvokeMethod.md deleted file mode 100644 index 8a490758..00000000 --- a/documentation/api/DelegateDocItem.InvokeMethod.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Types](index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation.Models.Types').[DelegateDocItem](DelegateDocItem.md 'DefaultDocumentation.Models.Types.DelegateDocItem') - -## DelegateDocItem.InvokeMethod Property - -Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') of the current instance. - -```csharp -public IMethod InvokeMethod { get; } -``` - -#### Property Value -[IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') \ No newline at end of file diff --git a/documentation/api/DelegateDocItem.Parameters.md b/documentation/api/DelegateDocItem.Parameters.md deleted file mode 100644 index b4ae94c0..00000000 --- a/documentation/api/DelegateDocItem.Parameters.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Types](index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation.Models.Types').[DelegateDocItem](DelegateDocItem.md 'DefaultDocumentation.Models.Types.DelegateDocItem') - -## DelegateDocItem.Parameters Property - -Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. - -```csharp -public System.Collections.Generic.IEnumerable Parameters { get; } -``` - -Implements [Parameters](IParameterizedDocItem.Parameters.md 'DefaultDocumentation.Models.IParameterizedDocItem.Parameters') - -#### Property Value -[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') \ No newline at end of file diff --git a/documentation/api/DelegateDocItem.md b/documentation/api/DelegateDocItem.md deleted file mode 100644 index 33a26f5f..00000000 --- a/documentation/api/DelegateDocItem.md +++ /dev/null @@ -1,24 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Types](index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation.Models.Types') - -## DelegateDocItem Class - -Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') of the [TypeKind.Delegate](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.TypeKind.Delegate') kind documentation. - -```csharp -public sealed class DelegateDocItem : DefaultDocumentation.Models.Types.TypeDocItem, -DefaultDocumentation.Models.IParameterizedDocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 [EntityDocItem](EntityDocItem.md 'DefaultDocumentation.Models.EntityDocItem') 🡒 [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') 🡒 DelegateDocItem - -Implements [IParameterizedDocItem](IParameterizedDocItem.md 'DefaultDocumentation.Models.IParameterizedDocItem') - -| Constructors | | -| :--- | :--- | -| [DelegateDocItem(DocItem, ITypeDefinition, XElement)](DelegateDocItem.DelegateDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation.Models.Types.DelegateDocItem.DelegateDocItem(DefaultDocumentation.Models.DocItem, ITypeDefinition, System.Xml.Linq.XElement)') | Initialize a new instance of the [StructDocItem](StructDocItem.md 'DefaultDocumentation.Models.Types.StructDocItem') type. | - -| Properties | | -| :--- | :--- | -| [InvokeMethod](DelegateDocItem.InvokeMethod.md 'DefaultDocumentation.Models.Types.DelegateDocItem.InvokeMethod') | Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') of the current instance. | -| [Parameters](DelegateDocItem.Parameters.md 'DefaultDocumentation.Models.Types.DelegateDocItem.Parameters') | Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. | diff --git a/documentation/api/DocItem.Documentation.md b/documentation/api/DocItem.Documentation.md deleted file mode 100644 index 42e904b0..00000000 --- a/documentation/api/DocItem.Documentation.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models').[DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -## DocItem.Documentation Property - -Gets the xml documentation node of the current instance. - -```csharp -public System.Xml.Linq.XElement? Documentation { get; } -``` - -#### Property Value -[System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') \ No newline at end of file diff --git a/documentation/api/DocItem.FullName.md b/documentation/api/DocItem.FullName.md deleted file mode 100644 index 71a8f195..00000000 --- a/documentation/api/DocItem.FullName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models').[DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -## DocItem.FullName Property - -Gets the full name of the current instance. - -```csharp -public string FullName { get; } -``` - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/api/DocItem.Id.md b/documentation/api/DocItem.Id.md deleted file mode 100644 index 43b457e8..00000000 --- a/documentation/api/DocItem.Id.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models').[DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -## DocItem.Id Property - -Gets the id of the current instance. - -```csharp -public string Id { get; } -``` - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/api/DocItem.Name.md b/documentation/api/DocItem.Name.md deleted file mode 100644 index dac9b3bb..00000000 --- a/documentation/api/DocItem.Name.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models').[DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -## DocItem.Name Property - -Gets the name of the current instance. - -```csharp -public string Name { get; } -``` - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/api/DocItem.Parent.md b/documentation/api/DocItem.Parent.md deleted file mode 100644 index 075efc3f..00000000 --- a/documentation/api/DocItem.Parent.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models').[DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -## DocItem.Parent Property - -Gets the [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') parent of the current instance (for members it is their declaring type, for types it is their namespace, ...). - -```csharp -public DefaultDocumentation.Models.DocItem? Parent { get; } -``` - -#### Property Value -[DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') \ No newline at end of file diff --git a/documentation/api/DocItem.md b/documentation/api/DocItem.md deleted file mode 100644 index 55a5677c..00000000 --- a/documentation/api/DocItem.md +++ /dev/null @@ -1,28 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models') - -## DocItem Class - -Represent a documentation item. - -```csharp -public abstract class DocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DocItem - -Derived -↳ [AssemblyDocItem](AssemblyDocItem.md 'DefaultDocumentation.Models.AssemblyDocItem') -↳ [EntityDocItem](EntityDocItem.md 'DefaultDocumentation.Models.EntityDocItem') -↳ [ExternDocItem](ExternDocItem.md 'DefaultDocumentation.Models.ExternDocItem') -↳ [NamespaceDocItem](NamespaceDocItem.md 'DefaultDocumentation.Models.NamespaceDocItem') -↳ [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') -↳ [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') - -| Properties | | -| :--- | :--- | -| [Documentation](DocItem.Documentation.md 'DefaultDocumentation.Models.DocItem.Documentation') | Gets the xml documentation node of the current instance. | -| [FullName](DocItem.FullName.md 'DefaultDocumentation.Models.DocItem.FullName') | Gets the full name of the current instance. | -| [Id](DocItem.Id.md 'DefaultDocumentation.Models.DocItem.Id') | Gets the id of the current instance. | -| [Name](DocItem.Name.md 'DefaultDocumentation.Models.DocItem.Name') | Gets the name of the current instance. | -| [Parent](DocItem.Parent.md 'DefaultDocumentation.Models.DocItem.Parent') | Gets the [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') parent of the current instance (for members it is their declaring type, for types it is their namespace, ...). | diff --git a/documentation/api/DocItemExtension.GetParents(thisDocItem).md b/documentation/api/DocItemExtension.GetParents(thisDocItem).md deleted file mode 100644 index 0a1f2bd7..00000000 --- a/documentation/api/DocItemExtension.GetParents(thisDocItem).md +++ /dev/null @@ -1,21 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models').[DocItemExtension](DocItemExtension.md 'DefaultDocumentation.Models.DocItemExtension') - -## DocItemExtension.GetParents(this DocItem) Method - -Returns all the parents of the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public static System.Collections.Generic.IEnumerable GetParents(this DefaultDocumentation.Models.DocItem item); -``` -#### Parameters - - - -`item` [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') for which parents should be returned. - -#### Returns -[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') -The parents of the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') from the top parent. \ No newline at end of file diff --git a/documentation/api/DocItemExtension.HasOwnPage(thisDocItem,IGeneralContext).md b/documentation/api/DocItemExtension.HasOwnPage(thisDocItem,IGeneralContext).md deleted file mode 100644 index f0c77bc9..00000000 --- a/documentation/api/DocItemExtension.HasOwnPage(thisDocItem,IGeneralContext).md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models').[DocItemExtension](DocItemExtension.md 'DefaultDocumentation.Models.DocItemExtension') - -## DocItemExtension.HasOwnPage(this DocItem, IGeneralContext) Method - -Gets wether the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') has its own page generated based on a [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext'). - -```csharp -public static bool HasOwnPage(this DefaultDocumentation.Models.DocItem item, DefaultDocumentation.IGeneralContext context); -``` -#### Parameters - - - -`item` [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') for which to get if it has its own page. - - - -`context` [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') used to generation the documentation. - -#### Returns -[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') -[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if the [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') has its own page, otherwise [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). \ No newline at end of file diff --git a/documentation/api/DocItemExtension.TryGetParameterDocItem(thisDocItem,string,ParameterDocItem).md b/documentation/api/DocItemExtension.TryGetParameterDocItem(thisDocItem,string,ParameterDocItem).md deleted file mode 100644 index 4e34ecc8..00000000 --- a/documentation/api/DocItemExtension.TryGetParameterDocItem(thisDocItem,string,ParameterDocItem).md +++ /dev/null @@ -1,33 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models').[DocItemExtension](DocItemExtension.md 'DefaultDocumentation.Models.DocItemExtension') - -## DocItemExtension.TryGetParameterDocItem(this DocItem, string, ParameterDocItem) Method - -Searchs recursively on the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') parent a [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') with the provided name. - -```csharp -public static bool TryGetParameterDocItem(this DefaultDocumentation.Models.DocItem? item, string name, out DefaultDocumentation.Models.Parameters.ParameterDocItem? parameterDocItem); -``` -#### Parameters - - - -`item` [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') starting point from which to look for a specific [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem'). - - - -`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The name of the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem'). - - - -`parameterDocItem` [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') - -The [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') if found, else [null](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/null 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/null'). - -#### Returns -[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') -[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') was found, else [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). \ No newline at end of file diff --git a/documentation/api/DocItemExtension.TryGetTypeParameterDocItem(thisDocItem,string,TypeParameterDocItem).md b/documentation/api/DocItemExtension.TryGetTypeParameterDocItem(thisDocItem,string,TypeParameterDocItem).md deleted file mode 100644 index 0ebfa97f..00000000 --- a/documentation/api/DocItemExtension.TryGetTypeParameterDocItem(thisDocItem,string,TypeParameterDocItem).md +++ /dev/null @@ -1,33 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models').[DocItemExtension](DocItemExtension.md 'DefaultDocumentation.Models.DocItemExtension') - -## DocItemExtension.TryGetTypeParameterDocItem(this DocItem, string, TypeParameterDocItem) Method - -Searchs recursively on the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') parent a [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') with the provided name. - -```csharp -public static bool TryGetTypeParameterDocItem(this DefaultDocumentation.Models.DocItem? item, string name, out DefaultDocumentation.Models.Parameters.TypeParameterDocItem? typeParameterDocItem); -``` -#### Parameters - - - -`item` [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') starting point from which to look for a specific [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem'). - - - -`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The name of the [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem'). - - - -`typeParameterDocItem` [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') - -The [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') if found, else [null](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/null 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/null'). - -#### Returns -[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') -[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if the [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') was found, else [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). \ No newline at end of file diff --git a/documentation/api/DocItemExtension.md b/documentation/api/DocItemExtension.md deleted file mode 100644 index fd71a9f7..00000000 --- a/documentation/api/DocItemExtension.md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models') - -## DocItemExtension Class - -Provides extension methods on the [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') type. - -```csharp -public static class DocItemExtension -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DocItemExtension - -| Methods | | -| :--- | :--- | -| [GetParents(this DocItem)](DocItemExtension.GetParents(thisDocItem).md 'DefaultDocumentation.Models.DocItemExtension.GetParents(this DefaultDocumentation.Models.DocItem)') | Returns all the parents of the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem'). | -| [HasOwnPage(this DocItem, IGeneralContext)](DocItemExtension.HasOwnPage(thisDocItem,IGeneralContext).md 'DefaultDocumentation.Models.DocItemExtension.HasOwnPage(this DefaultDocumentation.Models.DocItem, DefaultDocumentation.IGeneralContext)') | Gets wether the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') has its own page generated based on a [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext'). | -| [TryGetParameterDocItem(this DocItem, string, ParameterDocItem)](DocItemExtension.TryGetParameterDocItem(thisDocItem,string,ParameterDocItem).md 'DefaultDocumentation.Models.DocItemExtension.TryGetParameterDocItem(this DefaultDocumentation.Models.DocItem, string, DefaultDocumentation.Models.Parameters.ParameterDocItem)') | Searchs recursively on the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') parent a [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') with the provided name. | -| [TryGetTypeParameterDocItem(this DocItem, string, TypeParameterDocItem)](DocItemExtension.TryGetTypeParameterDocItem(thisDocItem,string,TypeParameterDocItem).md 'DefaultDocumentation.Models.DocItemExtension.TryGetTypeParameterDocItem(this DefaultDocumentation.Models.DocItem, string, DefaultDocumentation.Models.Parameters.TypeParameterDocItem)') | Searchs recursively on the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') parent a [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') with the provided name. | diff --git a/documentation/api/EntityDocItem.Entity.md b/documentation/api/EntityDocItem.Entity.md deleted file mode 100644 index dc86c6ac..00000000 --- a/documentation/api/EntityDocItem.Entity.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models').[EntityDocItem](EntityDocItem.md 'DefaultDocumentation.Models.EntityDocItem') - -## EntityDocItem.Entity Property - -Gets the [IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEntity') of the current instance. - -```csharp -public IEntity Entity { get; } -``` - -#### Property Value -[IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEntity') \ No newline at end of file diff --git a/documentation/api/EntityDocItem.md b/documentation/api/EntityDocItem.md deleted file mode 100644 index 9d1cc780..00000000 --- a/documentation/api/EntityDocItem.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models') - -## EntityDocItem Class - -Represent an [IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEntity') documentation. - -```csharp -public abstract class EntityDocItem : DefaultDocumentation.Models.DocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 EntityDocItem - -Derived -↳ [ConstructorDocItem](ConstructorDocItem.md 'DefaultDocumentation.Models.Members.ConstructorDocItem') -↳ [EnumFieldDocItem](EnumFieldDocItem.md 'DefaultDocumentation.Models.Members.EnumFieldDocItem') -↳ [EventDocItem](EventDocItem.md 'DefaultDocumentation.Models.Members.EventDocItem') -↳ [ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') -↳ [FieldDocItem](FieldDocItem.md 'DefaultDocumentation.Models.Members.FieldDocItem') -↳ [MethodDocItem](MethodDocItem.md 'DefaultDocumentation.Models.Members.MethodDocItem') -↳ [OperatorDocItem](OperatorDocItem.md 'DefaultDocumentation.Models.Members.OperatorDocItem') -↳ [PropertyDocItem](PropertyDocItem.md 'DefaultDocumentation.Models.Members.PropertyDocItem') -↳ [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') - -| Properties | | -| :--- | :--- | -| [Entity](EntityDocItem.Entity.md 'DefaultDocumentation.Models.EntityDocItem.Entity') | Gets the [IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEntity') of the current instance. | diff --git a/documentation/api/EnumDocItem.EnumDocItem(DocItem,ITypeDefinition,XElement).md b/documentation/api/EnumDocItem.EnumDocItem(DocItem,ITypeDefinition,XElement).md deleted file mode 100644 index 21778f87..00000000 --- a/documentation/api/EnumDocItem.EnumDocItem(DocItem,ITypeDefinition,XElement).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Types](index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation.Models.Types').[EnumDocItem](EnumDocItem.md 'DefaultDocumentation.Models.Types.EnumDocItem') - -## EnumDocItem(DocItem, ITypeDefinition, XElement) Constructor - -Initialize a new instance of the [StructDocItem](StructDocItem.md 'DefaultDocumentation.Models.Types.StructDocItem') type. - -```csharp -public EnumDocItem(DefaultDocumentation.Models.DocItem parent, ITypeDefinition type, System.Xml.Linq.XElement? documentation); -``` -#### Parameters - - - -`parent` [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') parent type or namespace of the enum. - - - -`type` [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') - -The [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') of the enum. - - - -`documentation` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') documentation element of the enum. \ No newline at end of file diff --git a/documentation/api/EnumDocItem.md b/documentation/api/EnumDocItem.md deleted file mode 100644 index 9e4835c4..00000000 --- a/documentation/api/EnumDocItem.md +++ /dev/null @@ -1,16 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Types](index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation.Models.Types') - -## EnumDocItem Class - -Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') of the [TypeKind.Enum](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.TypeKind.Enum') kind documentation. - -```csharp -public sealed class EnumDocItem : DefaultDocumentation.Models.Types.TypeDocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 [EntityDocItem](EntityDocItem.md 'DefaultDocumentation.Models.EntityDocItem') 🡒 [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') 🡒 EnumDocItem - -| Constructors | | -| :--- | :--- | -| [EnumDocItem(DocItem, ITypeDefinition, XElement)](EnumDocItem.EnumDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation.Models.Types.EnumDocItem.EnumDocItem(DefaultDocumentation.Models.DocItem, ITypeDefinition, System.Xml.Linq.XElement)') | Initialize a new instance of the [StructDocItem](StructDocItem.md 'DefaultDocumentation.Models.Types.StructDocItem') type. | diff --git a/documentation/api/EnumFieldDocItem.EnumFieldDocItem(EnumDocItem,IField,XElement).md b/documentation/api/EnumFieldDocItem.EnumFieldDocItem(EnumDocItem,IField,XElement).md deleted file mode 100644 index 98db4ab3..00000000 --- a/documentation/api/EnumFieldDocItem.EnumFieldDocItem(EnumDocItem,IField,XElement).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[EnumFieldDocItem](EnumFieldDocItem.md 'DefaultDocumentation.Models.Members.EnumFieldDocItem') - -## EnumFieldDocItem(EnumDocItem, IField, XElement) Constructor - -Initialize a new instance of the [EnumFieldDocItem](EnumFieldDocItem.md 'DefaultDocumentation.Models.Members.EnumFieldDocItem') type. - -```csharp -public EnumFieldDocItem(DefaultDocumentation.Models.Types.EnumDocItem parent, IField field, System.Xml.Linq.XElement? documentation); -``` -#### Parameters - - - -`parent` [EnumDocItem](EnumDocItem.md 'DefaultDocumentation.Models.Types.EnumDocItem') - -The [EnumDocItem](EnumDocItem.md 'DefaultDocumentation.Models.Types.EnumDocItem') parent enum of the enum field. - - - -`field` [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IField') - -The [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IField') of the enum field. - - - -`documentation` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') documentation element of the enum field. \ No newline at end of file diff --git a/documentation/api/EnumFieldDocItem.Field.md b/documentation/api/EnumFieldDocItem.Field.md deleted file mode 100644 index 0b1e73aa..00000000 --- a/documentation/api/EnumFieldDocItem.Field.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[EnumFieldDocItem](EnumFieldDocItem.md 'DefaultDocumentation.Models.Members.EnumFieldDocItem') - -## EnumFieldDocItem.Field Property - -Gets the [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IField') of the current instance. - -```csharp -public IField Field { get; } -``` - -#### Property Value -[IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IField') \ No newline at end of file diff --git a/documentation/api/EnumFieldDocItem.md b/documentation/api/EnumFieldDocItem.md deleted file mode 100644 index d6f8e134..00000000 --- a/documentation/api/EnumFieldDocItem.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members') - -## EnumFieldDocItem Class - -Represents an enum [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IField') documentation. - -```csharp -public sealed class EnumFieldDocItem : DefaultDocumentation.Models.EntityDocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 [EntityDocItem](EntityDocItem.md 'DefaultDocumentation.Models.EntityDocItem') 🡒 EnumFieldDocItem - -| Constructors | | -| :--- | :--- | -| [EnumFieldDocItem(EnumDocItem, IField, XElement)](EnumFieldDocItem.EnumFieldDocItem(EnumDocItem,IField,XElement).md 'DefaultDocumentation.Models.Members.EnumFieldDocItem.EnumFieldDocItem(DefaultDocumentation.Models.Types.EnumDocItem, IField, System.Xml.Linq.XElement)') | Initialize a new instance of the [EnumFieldDocItem](EnumFieldDocItem.md 'DefaultDocumentation.Models.Members.EnumFieldDocItem') type. | - -| Properties | | -| :--- | :--- | -| [Field](EnumFieldDocItem.Field.md 'DefaultDocumentation.Models.Members.EnumFieldDocItem.Field') | Gets the [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IField') of the current instance. | diff --git a/documentation/api/EventDocItem.Event.md b/documentation/api/EventDocItem.Event.md deleted file mode 100644 index f5f4e5f7..00000000 --- a/documentation/api/EventDocItem.Event.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[EventDocItem](EventDocItem.md 'DefaultDocumentation.Models.Members.EventDocItem') - -## EventDocItem.Event Property - -Gets the [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEvent') of the current instance. - -```csharp -public IEvent Event { get; } -``` - -#### Property Value -[IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEvent') \ No newline at end of file diff --git a/documentation/api/EventDocItem.EventDocItem(TypeDocItem,IEvent,XElement).md b/documentation/api/EventDocItem.EventDocItem(TypeDocItem,IEvent,XElement).md deleted file mode 100644 index 95afc8d6..00000000 --- a/documentation/api/EventDocItem.EventDocItem(TypeDocItem,IEvent,XElement).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[EventDocItem](EventDocItem.md 'DefaultDocumentation.Models.Members.EventDocItem') - -## EventDocItem(TypeDocItem, IEvent, XElement) Constructor - -Initialize a new instance of the [EventDocItem](EventDocItem.md 'DefaultDocumentation.Models.Members.EventDocItem') type. - -```csharp -public EventDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, IEvent @event, System.Xml.Linq.XElement? documentation); -``` -#### Parameters - - - -`parent` [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') - -The [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') parent type of the event. - - - -`event` [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEvent') - -The [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEvent') of the event. - - - -`documentation` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') documentation element of the event. \ No newline at end of file diff --git a/documentation/api/EventDocItem.md b/documentation/api/EventDocItem.md deleted file mode 100644 index e50d3a1d..00000000 --- a/documentation/api/EventDocItem.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members') - -## EventDocItem Class - -Represents an [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEvent') documentation. - -```csharp -public sealed class EventDocItem : DefaultDocumentation.Models.EntityDocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 [EntityDocItem](EntityDocItem.md 'DefaultDocumentation.Models.EntityDocItem') 🡒 EventDocItem - -| Constructors | | -| :--- | :--- | -| [EventDocItem(TypeDocItem, IEvent, XElement)](EventDocItem.EventDocItem(TypeDocItem,IEvent,XElement).md 'DefaultDocumentation.Models.Members.EventDocItem.EventDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IEvent, System.Xml.Linq.XElement)') | Initialize a new instance of the [EventDocItem](EventDocItem.md 'DefaultDocumentation.Models.Members.EventDocItem') type. | - -| Properties | | -| :--- | :--- | -| [Event](EventDocItem.Event.md 'DefaultDocumentation.Models.Members.EventDocItem.Event') | Gets the [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEvent') of the current instance. | diff --git a/documentation/api/ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(TypeDocItem,IEvent,XElement).md b/documentation/api/ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(TypeDocItem,IEvent,XElement).md deleted file mode 100644 index 2536e241..00000000 --- a/documentation/api/ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(TypeDocItem,IEvent,XElement).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') - -## ExplicitInterfaceImplementationDocItem(TypeDocItem, IEvent, XElement) Constructor - -Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') type. - -```csharp -public ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, IEvent @event, System.Xml.Linq.XElement? documentation); -``` -#### Parameters - - - -`parent` [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') - -The [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') parent type of the interface event explicitly implemented. - - - -`event` [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEvent') - -The [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEvent') of the interface event explicitly implemented. - - - -`documentation` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') documentation element of the interface event explicitly implemented. \ No newline at end of file diff --git a/documentation/api/ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(TypeDocItem,IMethod,XElement).md b/documentation/api/ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(TypeDocItem,IMethod,XElement).md deleted file mode 100644 index 1c1a8758..00000000 --- a/documentation/api/ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(TypeDocItem,IMethod,XElement).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') - -## ExplicitInterfaceImplementationDocItem(TypeDocItem, IMethod, XElement) Constructor - -Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') type. - -```csharp -public ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, IMethod method, System.Xml.Linq.XElement? documentation); -``` -#### Parameters - - - -`parent` [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') - -The [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') parent type of the interface method explicitly implemented. - - - -`method` [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') - -The [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') of the interface method explicitly implemented. - - - -`documentation` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') documentation element of the interface method explicitly implemented. \ No newline at end of file diff --git a/documentation/api/ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(TypeDocItem,IProperty,XElement).md b/documentation/api/ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(TypeDocItem,IProperty,XElement).md deleted file mode 100644 index bc241917..00000000 --- a/documentation/api/ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(TypeDocItem,IProperty,XElement).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') - -## ExplicitInterfaceImplementationDocItem(TypeDocItem, IProperty, XElement) Constructor - -Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') type. - -```csharp -public ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, IProperty property, System.Xml.Linq.XElement? documentation); -``` -#### Parameters - - - -`parent` [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') - -The [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') parent type of the interface property explicitly implemented. - - - -`property` [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IProperty') - -The [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IProperty') of the interface property explicitly implemented. - - - -`documentation` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') documentation element of the interface property explicitly implemented. \ No newline at end of file diff --git a/documentation/api/ExplicitInterfaceImplementationDocItem.Member.md b/documentation/api/ExplicitInterfaceImplementationDocItem.Member.md deleted file mode 100644 index 143d1054..00000000 --- a/documentation/api/ExplicitInterfaceImplementationDocItem.Member.md +++ /dev/null @@ -1,14 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') - -## ExplicitInterfaceImplementationDocItem.Member Property - -Gets the [IMember](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMember') of the current instance. -It can either be an [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEvent'), [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IProperty') or [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod'). - -```csharp -public IMember Member { get; } -``` - -#### Property Value -[IMember](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMember') \ No newline at end of file diff --git a/documentation/api/ExplicitInterfaceImplementationDocItem.Parameters.md b/documentation/api/ExplicitInterfaceImplementationDocItem.Parameters.md deleted file mode 100644 index 1a5db487..00000000 --- a/documentation/api/ExplicitInterfaceImplementationDocItem.Parameters.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') - -## ExplicitInterfaceImplementationDocItem.Parameters Property - -Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. - -```csharp -public System.Collections.Generic.IEnumerable Parameters { get; } -``` - -Implements [Parameters](IParameterizedDocItem.Parameters.md 'DefaultDocumentation.Models.IParameterizedDocItem.Parameters') - -#### Property Value -[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') \ No newline at end of file diff --git a/documentation/api/ExplicitInterfaceImplementationDocItem.TypeParameters.md b/documentation/api/ExplicitInterfaceImplementationDocItem.TypeParameters.md deleted file mode 100644 index 1598b051..00000000 --- a/documentation/api/ExplicitInterfaceImplementationDocItem.TypeParameters.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') - -## ExplicitInterfaceImplementationDocItem.TypeParameters Property - -Gets the [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') of this instance. - -```csharp -public System.Collections.Generic.IEnumerable TypeParameters { get; } -``` - -Implements [TypeParameters](ITypeParameterizedDocItem.TypeParameters.md 'DefaultDocumentation.Models.ITypeParameterizedDocItem.TypeParameters') - -#### Property Value -[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') \ No newline at end of file diff --git a/documentation/api/ExplicitInterfaceImplementationDocItem.md b/documentation/api/ExplicitInterfaceImplementationDocItem.md deleted file mode 100644 index 9aab527f..00000000 --- a/documentation/api/ExplicitInterfaceImplementationDocItem.md +++ /dev/null @@ -1,28 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members') - -## ExplicitInterfaceImplementationDocItem Class - -Represents an explicit interface implementation documentation. - -```csharp -public sealed class ExplicitInterfaceImplementationDocItem : DefaultDocumentation.Models.EntityDocItem, -DefaultDocumentation.Models.ITypeParameterizedDocItem, -DefaultDocumentation.Models.IParameterizedDocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 [EntityDocItem](EntityDocItem.md 'DefaultDocumentation.Models.EntityDocItem') 🡒 ExplicitInterfaceImplementationDocItem - -Implements [ITypeParameterizedDocItem](ITypeParameterizedDocItem.md 'DefaultDocumentation.Models.ITypeParameterizedDocItem'), [IParameterizedDocItem](IParameterizedDocItem.md 'DefaultDocumentation.Models.IParameterizedDocItem') - -| Constructors | | -| :--- | :--- | -| [ExplicitInterfaceImplementationDocItem(TypeDocItem, IEvent, XElement)](ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(TypeDocItem,IEvent,XElement).md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IEvent, System.Xml.Linq.XElement)') | Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') type. | -| [ExplicitInterfaceImplementationDocItem(TypeDocItem, IMethod, XElement)](ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(TypeDocItem,IMethod,XElement).md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IMethod, System.Xml.Linq.XElement)') | Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') type. | -| [ExplicitInterfaceImplementationDocItem(TypeDocItem, IProperty, XElement)](ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(TypeDocItem,IProperty,XElement).md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IProperty, System.Xml.Linq.XElement)') | Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') type. | - -| Properties | | -| :--- | :--- | -| [Member](ExplicitInterfaceImplementationDocItem.Member.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.Member') | Gets the [IMember](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMember') of the current instance.
It can either be an [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEvent'), [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IProperty') or [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod'). | -| [Parameters](ExplicitInterfaceImplementationDocItem.Parameters.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.Parameters') | Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. | -| [TypeParameters](ExplicitInterfaceImplementationDocItem.TypeParameters.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.TypeParameters') | Gets the [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') of this instance. | diff --git a/documentation/api/ExternDocItem.ExternDocItem(string,string,string).md b/documentation/api/ExternDocItem.ExternDocItem(string,string,string).md deleted file mode 100644 index 0c4ca890..00000000 --- a/documentation/api/ExternDocItem.ExternDocItem(string,string,string).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models').[ExternDocItem](ExternDocItem.md 'DefaultDocumentation.Models.ExternDocItem') - -## ExternDocItem(string, string, string) Constructor - -Initialize a new instance of the [ExternDocItem](ExternDocItem.md 'DefaultDocumentation.Models.ExternDocItem') type. - -```csharp -public ExternDocItem(string id, string url, string name); -``` -#### Parameters - - - -`id` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The id of the external item. - - - -`url` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The url of the documentation. - - - -`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The name of the external item. \ No newline at end of file diff --git a/documentation/api/ExternDocItem.Url.md b/documentation/api/ExternDocItem.Url.md deleted file mode 100644 index 88e94edd..00000000 --- a/documentation/api/ExternDocItem.Url.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models').[ExternDocItem](ExternDocItem.md 'DefaultDocumentation.Models.ExternDocItem') - -## ExternDocItem.Url Property - -Gets the url of the current instance. - -```csharp -public string Url { get; } -``` - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/api/ExternDocItem.md b/documentation/api/ExternDocItem.md deleted file mode 100644 index dbfa32fe..00000000 --- a/documentation/api/ExternDocItem.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models') - -## ExternDocItem Class - -Represent an external documentation. - -```csharp -public sealed class ExternDocItem : DefaultDocumentation.Models.DocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 ExternDocItem - -| Constructors | | -| :--- | :--- | -| [ExternDocItem(string, string, string)](ExternDocItem.ExternDocItem(string,string,string).md 'DefaultDocumentation.Models.ExternDocItem.ExternDocItem(string, string, string)') | Initialize a new instance of the [ExternDocItem](ExternDocItem.md 'DefaultDocumentation.Models.ExternDocItem') type. | - -| Properties | | -| :--- | :--- | -| [Url](ExternDocItem.Url.md 'DefaultDocumentation.Models.ExternDocItem.Url') | Gets the url of the current instance. | diff --git a/documentation/api/FieldDocItem.Field.md b/documentation/api/FieldDocItem.Field.md deleted file mode 100644 index 29fa5f2d..00000000 --- a/documentation/api/FieldDocItem.Field.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[FieldDocItem](FieldDocItem.md 'DefaultDocumentation.Models.Members.FieldDocItem') - -## FieldDocItem.Field Property - -Gets the [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IField') of the current instance. - -```csharp -public IField Field { get; } -``` - -#### Property Value -[IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IField') \ No newline at end of file diff --git a/documentation/api/FieldDocItem.FieldDocItem(TypeDocItem,IField,XElement).md b/documentation/api/FieldDocItem.FieldDocItem(TypeDocItem,IField,XElement).md deleted file mode 100644 index 2b42e2c3..00000000 --- a/documentation/api/FieldDocItem.FieldDocItem(TypeDocItem,IField,XElement).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[FieldDocItem](FieldDocItem.md 'DefaultDocumentation.Models.Members.FieldDocItem') - -## FieldDocItem(TypeDocItem, IField, XElement) Constructor - -Initialize a new instance of the [FieldDocItem](FieldDocItem.md 'DefaultDocumentation.Models.Members.FieldDocItem') type. - -```csharp -public FieldDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, IField field, System.Xml.Linq.XElement? documentation); -``` -#### Parameters - - - -`parent` [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') - -The [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') parent type of the field. - - - -`field` [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IField') - -The [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IField') of the field. - - - -`documentation` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') documentation element of the field. \ No newline at end of file diff --git a/documentation/api/FieldDocItem.md b/documentation/api/FieldDocItem.md deleted file mode 100644 index b6d7cb37..00000000 --- a/documentation/api/FieldDocItem.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members') - -## FieldDocItem Class - -Represents an [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IField') documentation. - -```csharp -public sealed class FieldDocItem : DefaultDocumentation.Models.EntityDocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 [EntityDocItem](EntityDocItem.md 'DefaultDocumentation.Models.EntityDocItem') 🡒 FieldDocItem - -| Constructors | | -| :--- | :--- | -| [FieldDocItem(TypeDocItem, IField, XElement)](FieldDocItem.FieldDocItem(TypeDocItem,IField,XElement).md 'DefaultDocumentation.Models.Members.FieldDocItem.FieldDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IField, System.Xml.Linq.XElement)') | Initialize a new instance of the [FieldDocItem](FieldDocItem.md 'DefaultDocumentation.Models.Members.FieldDocItem') type. | - -| Properties | | -| :--- | :--- | -| [Field](FieldDocItem.Field.md 'DefaultDocumentation.Models.Members.FieldDocItem.Field') | Gets the [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IField') of the current instance. | diff --git a/documentation/api/GeneratedAccessModifiers.md b/documentation/api/GeneratedAccessModifiers.md deleted file mode 100644 index 33bc2ffb..00000000 --- a/documentation/api/GeneratedAccessModifiers.md +++ /dev/null @@ -1,53 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation') - -## GeneratedAccessModifiers Enum - -Specifies a combination of access modifiers. - -```csharp -public enum GeneratedAccessModifiers -``` -### Fields - - - -`Default` 0 - -Generates documentation for all access modifiers. - - - -`Internal` 8 - -Generates documentation for 'internal' access modifier. - - - -`Private` 2 - -Generates documentation for 'private' access modifier. - - - -`PrivateProtected` 32 - -Generates documentation for 'private protected' access modifier. - - - -`Protected` 4 - -Generates documentation for 'protected' access modifier. - - - -`ProtectedInternal` 16 - -Generates documentation for 'protected internal' access modifier. - - - -`Public` 1 - -Generates documentation for 'public' access modifier. \ No newline at end of file diff --git a/documentation/api/GeneratedPages.md b/documentation/api/GeneratedPages.md deleted file mode 100644 index b7c1114b..00000000 --- a/documentation/api/GeneratedPages.md +++ /dev/null @@ -1,113 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation') - -## GeneratedPages Enum - -Specifies a combination of page kinds. - -```csharp -public enum GeneratedPages -``` -### Fields - - - -`Assembly` 1 - -Generates documentation page for the assembly. - - - -`Classes` 4 - -Generates documentation pages for the classes. - - - -`Constructors` 128 - -Generates documentation pages for the constructors. - - - -`Default` 0 - -Generates all documentation page kinds. - - - -`Delegates` 8 - -Generates documentation pages for the delegates. - - - -`Enums` 16 - -Generates documentation pages for the enums. - - - -`Events` 256 - -Generates documentation pages for the events. - - - -`ExplicitInterfaceImplementations` 8192 - -Generates documentation pages for the explicit interface implementations. - - - -`Fields` 512 - -Generates documentation pages for the fields. - - - -`Interfaces` 64 - -Generates documentation pages for the interfaces. - - - -`Members` 16256 - -Generates documentation pages for all member kinds (constructor, event, field, method, operator, property, explicit interface implementation). - - - -`Methods` 1024 - -Generates documentation pages for the methods. - - - -`Namespaces` 2 - -Generates documentation pages for the namespaces. - - - -`Operators` 2048 - -Generates documentation pages for the operators. - - - -`Properties` 4096 - -Generates documentation pages for the properties. - - - -`Structs` 32 - -Generates documentation pages for the structs. - - - -`Types` 124 - -Generates documentation pages for all type kinds (class, delegate, enum, struct, interface). \ No newline at end of file diff --git a/documentation/api/ICSharpCode/Decompiler/TypeSystem/IEntityExtensions/IsVisibleInDocumentation(thisIEntity,ISettings).md b/documentation/api/ICSharpCode/Decompiler/TypeSystem/IEntityExtensions/IsVisibleInDocumentation(thisIEntity,ISettings).md new file mode 100644 index 00000000..bebdf245 --- /dev/null +++ b/documentation/api/ICSharpCode/Decompiler/TypeSystem/IEntityExtensions/IsVisibleInDocumentation(thisIEntity,ISettings).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [ICSharpCode\.Decompiler\.TypeSystem](../../../../index.md#ICSharpCode.Decompiler.TypeSystem 'ICSharpCode\.Decompiler\.TypeSystem').[IEntityExtensions](index.md 'ICSharpCode\.Decompiler\.TypeSystem\.IEntityExtensions') + +## IEntityExtensions\.IsVisibleInDocumentation\(this IEntity, ISettings\) Method + +Returns wether an [IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEntity') should be part of the documentation or not based on its accessibility\. + +```csharp +public static bool IsVisibleInDocumentation(this IEntity? entity, DefaultDocumentation.ISettings settings); +``` +#### Parameters + + + +`entity` [IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEntity') + +The [IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEntity') to check\. + + + +`settings` [ISettings](../../../../DefaultDocumentation/ISettings/index.md 'DefaultDocumentation\.ISettings') + +The [ISettings](../../../../DefaultDocumentation/ISettings/index.md 'DefaultDocumentation\.ISettings') used to generate the documentation\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs\.microsoft\.com/en\-us/dotnet/csharp/language\-reference/builtin\-types/bool') if the entity should be part of the documentation; otherwise [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs\.microsoft\.com/en\-us/dotnet/csharp/language\-reference/builtin\-types/bool')\. \ No newline at end of file diff --git a/documentation/api/ICSharpCode/Decompiler/TypeSystem/IEntityExtensions/index.md b/documentation/api/ICSharpCode/Decompiler/TypeSystem/IEntityExtensions/index.md new file mode 100644 index 00000000..2a1144b3 --- /dev/null +++ b/documentation/api/ICSharpCode/Decompiler/TypeSystem/IEntityExtensions/index.md @@ -0,0 +1,16 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [ICSharpCode\.Decompiler\.TypeSystem](../../../../index.md#ICSharpCode.Decompiler.TypeSystem 'ICSharpCode\.Decompiler\.TypeSystem') + +## IEntityExtensions Class + +Provides extension methods on the [IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEntity') type\. + +```csharp +public static class IEntityExtensions +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 IEntityExtensions + +| Methods | | +| :--- | :--- | +| [IsVisibleInDocumentation\(this IEntity, ISettings\)](IsVisibleInDocumentation(thisIEntity,ISettings).md 'ICSharpCode\.Decompiler\.TypeSystem\.IEntityExtensions\.IsVisibleInDocumentation\(this IEntity, DefaultDocumentation\.ISettings\)') | Returns wether an [IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEntity') should be part of the documentation or not based on its accessibility\. | diff --git a/documentation/api/ICSharpCode/Decompiler/TypeSystem/ISymbolExtensions/ToString(thisISymbol,CSharpAmbience).md b/documentation/api/ICSharpCode/Decompiler/TypeSystem/ISymbolExtensions/ToString(thisISymbol,CSharpAmbience).md new file mode 100644 index 00000000..02177b68 --- /dev/null +++ b/documentation/api/ICSharpCode/Decompiler/TypeSystem/ISymbolExtensions/ToString(thisISymbol,CSharpAmbience).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [ICSharpCode\.Decompiler\.TypeSystem](../../../../index.md#ICSharpCode.Decompiler.TypeSystem 'ICSharpCode\.Decompiler\.TypeSystem').[ISymbolExtensions](index.md 'ICSharpCode\.Decompiler\.TypeSystem\.ISymbolExtensions') + +## ISymbolExtensions\.ToString\(this ISymbol, CSharpAmbience\) Method + +Converts a [ICSharpCode\.Decompiler\.TypeSystem\.ISymbol](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.TypeSystem.ISymbol 'ICSharpCode\.Decompiler\.TypeSystem\.ISymbol') into its string representation using the provided [ICSharpCode\.Decompiler\.CSharp\.OutputVisitor\.CSharpAmbience](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.CSharp.OutputVisitor.CSharpAmbience 'ICSharpCode\.Decompiler\.CSharp\.OutputVisitor\.CSharpAmbience')\. + +```csharp +public static string ToString(this ISymbol symbol, CSharpAmbience ambience); +``` +#### Parameters + + + +`symbol` [ICSharpCode\.Decompiler\.TypeSystem\.ISymbol](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.TypeSystem.ISymbol 'ICSharpCode\.Decompiler\.TypeSystem\.ISymbol') + +The symbol to convert into its string representation\. + + + +`ambience` [ICSharpCode\.Decompiler\.CSharp\.OutputVisitor\.CSharpAmbience](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.CSharp.OutputVisitor.CSharpAmbience 'ICSharpCode\.Decompiler\.CSharp\.OutputVisitor\.CSharpAmbience') + +The [ICSharpCode\.Decompiler\.CSharp\.OutputVisitor\.CSharpAmbience](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.CSharp.OutputVisitor.CSharpAmbience 'ICSharpCode\.Decompiler\.CSharp\.OutputVisitor\.CSharpAmbience') to use\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/api/ICSharpCode/Decompiler/TypeSystem/ISymbolExtensions/index.md b/documentation/api/ICSharpCode/Decompiler/TypeSystem/ISymbolExtensions/index.md new file mode 100644 index 00000000..e81875bc --- /dev/null +++ b/documentation/api/ICSharpCode/Decompiler/TypeSystem/ISymbolExtensions/index.md @@ -0,0 +1,16 @@ +#### [DefaultDocumentation\.Api](../../../../index.md 'index') +### [ICSharpCode\.Decompiler\.TypeSystem](../../../../index.md#ICSharpCode.Decompiler.TypeSystem 'ICSharpCode\.Decompiler\.TypeSystem') + +## ISymbolExtensions Class + +Provides extension methods on the [ICSharpCode\.Decompiler\.TypeSystem\.ISymbol](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.TypeSystem.ISymbol 'ICSharpCode\.Decompiler\.TypeSystem\.ISymbol') type\. + +```csharp +public static class ISymbolExtensions +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ISymbolExtensions + +| Methods | | +| :--- | :--- | +| [ToString\(this ISymbol, CSharpAmbience\)](ToString(thisISymbol,CSharpAmbience).md 'ICSharpCode\.Decompiler\.TypeSystem\.ISymbolExtensions\.ToString\(this ISymbol, CSharpAmbience\)') | Converts a [ICSharpCode\.Decompiler\.TypeSystem\.ISymbol](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.TypeSystem.ISymbol 'ICSharpCode\.Decompiler\.TypeSystem\.ISymbol') into its string representation using the provided [ICSharpCode\.Decompiler\.CSharp\.OutputVisitor\.CSharpAmbience](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.CSharp.OutputVisitor.CSharpAmbience 'ICSharpCode\.Decompiler\.CSharp\.OutputVisitor\.CSharpAmbience')\. | diff --git a/documentation/api/IContext.FileNameFactory.md b/documentation/api/IContext.FileNameFactory.md deleted file mode 100644 index 2b57382b..00000000 --- a/documentation/api/IContext.FileNameFactory.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[IContext](IContext.md 'DefaultDocumentation.IContext') - -## IContext.FileNameFactory Property - -Gets the [IFileNameFactory](IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') to use to generate a file for a documentation page. - -```csharp -DefaultDocumentation.Api.IFileNameFactory FileNameFactory { get; } -``` - -#### Property Value -[IFileNameFactory](IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') \ No newline at end of file diff --git a/documentation/api/IContext.GetSetting_T_(string).md b/documentation/api/IContext.GetSetting_T_(string).md deleted file mode 100644 index be4c77f1..00000000 --- a/documentation/api/IContext.GetSetting_T_(string).md +++ /dev/null @@ -1,28 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[IContext](IContext.md 'DefaultDocumentation.IContext') - -## IContext.GetSetting(string) Method - -Gets a [T](IContext.GetSetting_T_(string).md#DefaultDocumentation.IContext.GetSetting_T_(string).T 'DefaultDocumentation.IContext.GetSetting(string).T') setting with the given name. - -```csharp -T? GetSetting(string name); -``` -#### Type parameters - - - -`T` - -The type of the setting to get. -#### Parameters - - - -`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The name of the setting to get. - -#### Returns -[T](IContext.GetSetting_T_(string).md#DefaultDocumentation.IContext.GetSetting_T_(string).T 'DefaultDocumentation.IContext.GetSetting(string).T') -The setting if present, otherwise the default value of the type [T](IContext.GetSetting_T_(string).md#DefaultDocumentation.IContext.GetSetting_T_(string).T 'DefaultDocumentation.IContext.GetSetting(string).T'). \ No newline at end of file diff --git a/documentation/api/IContext.Sections.md b/documentation/api/IContext.Sections.md deleted file mode 100644 index 67141379..00000000 --- a/documentation/api/IContext.Sections.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[IContext](IContext.md 'DefaultDocumentation.IContext') - -## IContext.Sections Property - -Gets the [ISection](ISection.md 'DefaultDocumentation.Api.ISection') to use to generate a documentation page. - -```csharp -System.Collections.Generic.IEnumerable Sections { get; } -``` - -#### Property Value -[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[ISection](ISection.md 'DefaultDocumentation.Api.ISection')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') \ No newline at end of file diff --git a/documentation/api/IContext.md b/documentation/api/IContext.md deleted file mode 100644 index 301d9623..00000000 --- a/documentation/api/IContext.md +++ /dev/null @@ -1,22 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation') - -## IContext Interface - -Exposes settings used to generate documentation. - -```csharp -public interface IContext -``` - -Derived -↳ [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -| Properties | | -| :--- | :--- | -| [FileNameFactory](IContext.FileNameFactory.md 'DefaultDocumentation.IContext.FileNameFactory') | Gets the [IFileNameFactory](IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') to use to generate a file for a documentation page. | -| [Sections](IContext.Sections.md 'DefaultDocumentation.IContext.Sections') | Gets the [ISection](ISection.md 'DefaultDocumentation.Api.ISection') to use to generate a documentation page. | - -| Methods | | -| :--- | :--- | -| [GetSetting<T>(string)](IContext.GetSetting_T_(string).md 'DefaultDocumentation.IContext.GetSetting(string)') | Gets a [T](IContext.GetSetting_T_(string).md#DefaultDocumentation.IContext.GetSetting_T_(string).T 'DefaultDocumentation.IContext.GetSetting(string).T') setting with the given name. | diff --git a/documentation/api/IElement.Name.md b/documentation/api/IElement.Name.md deleted file mode 100644 index 13c6707b..00000000 --- a/documentation/api/IElement.Name.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[IElement](IElement.md 'DefaultDocumentation.Api.IElement') - -## IElement.Name Property - -Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. - -```csharp -string Name { get; } -``` - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/api/IElement.Write(IWriter,XElement).md b/documentation/api/IElement.Write(IWriter,XElement).md deleted file mode 100644 index 9b6da58d..00000000 --- a/documentation/api/IElement.Write(IWriter,XElement).md +++ /dev/null @@ -1,23 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[IElement](IElement.md 'DefaultDocumentation.Api.IElement') - -## IElement.Write(IWriter, XElement) Method - -Writes to a [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). - -```csharp -void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); -``` -#### Parameters - - - -`writer` [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - - - -`element` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') to write. \ No newline at end of file diff --git a/documentation/api/IElement.md b/documentation/api/IElement.md deleted file mode 100644 index 0f5f154c..00000000 --- a/documentation/api/IElement.md +++ /dev/null @@ -1,18 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api') - -## IElement Interface - -Exposes a method to handle a specific kind of [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') when writing documentation. - -```csharp -public interface IElement -``` - -| Properties | | -| :--- | :--- | -| [Name](IElement.Name.md 'DefaultDocumentation.Api.IElement.Name') | Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter, XElement)](IElement.Write(IWriter,XElement).md 'DefaultDocumentation.Api.IElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)') | Writes to a [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). | diff --git a/documentation/api/IFileNameFactory.Clean(IGeneralContext).md b/documentation/api/IFileNameFactory.Clean(IGeneralContext).md deleted file mode 100644 index 31ad64e6..00000000 --- a/documentation/api/IFileNameFactory.Clean(IGeneralContext).md +++ /dev/null @@ -1,17 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[IFileNameFactory](IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') - -## IFileNameFactory.Clean(IGeneralContext) Method - -Cleans the [OutputDirectory](ISettings.OutputDirectory.md 'DefaultDocumentation.ISettings.OutputDirectory') of the previously generated documentation files. - -```csharp -void Clean(DefaultDocumentation.IGeneralContext context); -``` -#### Parameters - - - -`context` [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. \ No newline at end of file diff --git a/documentation/api/IFileNameFactory.GetFileName(IGeneralContext,DocItem).md b/documentation/api/IFileNameFactory.GetFileName(IGeneralContext,DocItem).md deleted file mode 100644 index 3ada4c7a..00000000 --- a/documentation/api/IFileNameFactory.GetFileName(IGeneralContext,DocItem).md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[IFileNameFactory](IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') - -## IFileNameFactory.GetFileName(IGeneralContext, DocItem) Method - -Gets the documentation file name for the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -string GetFileName(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); -``` -#### Parameters - - - -`context` [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - - - -`item` [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') for which to get the documentation file name. - -#### Returns -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The documentation file name of the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem'). \ No newline at end of file diff --git a/documentation/api/IFileNameFactory.Name.md b/documentation/api/IFileNameFactory.Name.md deleted file mode 100644 index eb1e77fb..00000000 --- a/documentation/api/IFileNameFactory.Name.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[IFileNameFactory](IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') - -## IFileNameFactory.Name Property - -Gets the name of the factory, used to identify it at the configuration level. - -```csharp -string Name { get; } -``` - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/api/IFileNameFactory.md b/documentation/api/IFileNameFactory.md deleted file mode 100644 index f7d7a06e..00000000 --- a/documentation/api/IFileNameFactory.md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api') - -## IFileNameFactory Interface - -Exposes methods related to the documentation files cleaning and creation. - -```csharp -public interface IFileNameFactory -``` - -| Properties | | -| :--- | :--- | -| [Name](IFileNameFactory.Name.md 'DefaultDocumentation.Api.IFileNameFactory.Name') | Gets the name of the factory, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Clean(IGeneralContext)](IFileNameFactory.Clean(IGeneralContext).md 'DefaultDocumentation.Api.IFileNameFactory.Clean(DefaultDocumentation.IGeneralContext)') | Cleans the [OutputDirectory](ISettings.OutputDirectory.md 'DefaultDocumentation.ISettings.OutputDirectory') of the previously generated documentation files. | -| [GetFileName(IGeneralContext, DocItem)](IFileNameFactory.GetFileName(IGeneralContext,DocItem).md 'DefaultDocumentation.Api.IFileNameFactory.GetFileName(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)') | Gets the documentation file name for the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem'). | diff --git a/documentation/api/IGeneralContext.Elements.md b/documentation/api/IGeneralContext.Elements.md deleted file mode 100644 index b769a2a7..00000000 --- a/documentation/api/IGeneralContext.Elements.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -## IGeneralContext.Elements Property - -Gets the [IElement](IElement.md 'DefaultDocumentation.Api.IElement') used to render specific [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') from the documentation. - -```csharp -System.Collections.Generic.IReadOnlyDictionary Elements { get; } -``` - -#### Property Value -[System.Collections.Generic.IReadOnlyDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyDictionary-2 'System.Collections.Generic.IReadOnlyDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyDictionary-2 'System.Collections.Generic.IReadOnlyDictionary`2')[IElement](IElement.md 'DefaultDocumentation.Api.IElement')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyDictionary-2 'System.Collections.Generic.IReadOnlyDictionary`2') \ No newline at end of file diff --git a/documentation/api/IGeneralContext.GetContext(Type).md b/documentation/api/IGeneralContext.GetContext(Type).md deleted file mode 100644 index ca94a435..00000000 --- a/documentation/api/IGeneralContext.GetContext(Type).md +++ /dev/null @@ -1,21 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -## IGeneralContext.GetContext(Type) Method - -Gets the specific [IContext](IContext.md 'DefaultDocumentation.IContext') for the given [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type'). - -```csharp -DefaultDocumentation.IContext GetContext(System.Type type); -``` -#### Parameters - - - -`type` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type') - -The [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type') for which to get the specific [IContext](IContext.md 'DefaultDocumentation.IContext'). - -#### Returns -[IContext](IContext.md 'DefaultDocumentation.IContext') -The [IContext](IContext.md 'DefaultDocumentation.IContext') specific to the provided [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type'). \ No newline at end of file diff --git a/documentation/api/IGeneralContext.GetFileName(DocItem).md b/documentation/api/IGeneralContext.GetFileName(DocItem).md deleted file mode 100644 index f9a941c6..00000000 --- a/documentation/api/IGeneralContext.GetFileName(DocItem).md +++ /dev/null @@ -1,21 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -## IGeneralContext.GetFileName(DocItem) Method - -Gets the file name for the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -string GetFileName(DefaultDocumentation.Models.DocItem item); -``` -#### Parameters - - - -`item` [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') for which to get the page name. - -#### Returns -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The file name of the documentation page of the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem'). \ No newline at end of file diff --git a/documentation/api/IGeneralContext.GetUrl(string).md b/documentation/api/IGeneralContext.GetUrl(string).md deleted file mode 100644 index 2f5ffa6e..00000000 --- a/documentation/api/IGeneralContext.GetUrl(string).md +++ /dev/null @@ -1,21 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -## IGeneralContext.GetUrl(string) Method - -Gets the url of the given id. - -```csharp -string GetUrl(string id); -``` -#### Parameters - - - -`id` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The id to get the url for. - -#### Returns -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The url of the given id. \ No newline at end of file diff --git a/documentation/api/IGeneralContext.Items.md b/documentation/api/IGeneralContext.Items.md deleted file mode 100644 index 354573fd..00000000 --- a/documentation/api/IGeneralContext.Items.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -## IGeneralContext.Items Property - -Gets all the [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') known by this documentation generation context. - -```csharp -System.Collections.Generic.IReadOnlyDictionary Items { get; } -``` - -#### Property Value -[System.Collections.Generic.IReadOnlyDictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyDictionary-2 'System.Collections.Generic.IReadOnlyDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyDictionary-2 'System.Collections.Generic.IReadOnlyDictionary`2')[DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyDictionary-2 'System.Collections.Generic.IReadOnlyDictionary`2') \ No newline at end of file diff --git a/documentation/api/IGeneralContext.Settings.md b/documentation/api/IGeneralContext.Settings.md deleted file mode 100644 index 00a9091b..00000000 --- a/documentation/api/IGeneralContext.Settings.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -## IGeneralContext.Settings Property - -Gets the [ISettings](ISettings.md 'DefaultDocumentation.ISettings') of this documentation generation context. - -```csharp -DefaultDocumentation.ISettings Settings { get; } -``` - -#### Property Value -[ISettings](ISettings.md 'DefaultDocumentation.ISettings') \ No newline at end of file diff --git a/documentation/api/IGeneralContext.md b/documentation/api/IGeneralContext.md deleted file mode 100644 index 363197a9..00000000 --- a/documentation/api/IGeneralContext.md +++ /dev/null @@ -1,25 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation') - -## IGeneralContext Interface - -Exposes settings used to generate documentation. - -```csharp -public interface IGeneralContext : -DefaultDocumentation.IContext -``` - -Implements [IContext](IContext.md 'DefaultDocumentation.IContext') - -| Properties | | -| :--- | :--- | -| [Elements](IGeneralContext.Elements.md 'DefaultDocumentation.IGeneralContext.Elements') | Gets the [IElement](IElement.md 'DefaultDocumentation.Api.IElement') used to render specific [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') from the documentation. | -| [Items](IGeneralContext.Items.md 'DefaultDocumentation.IGeneralContext.Items') | Gets all the [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') known by this documentation generation context. | -| [Settings](IGeneralContext.Settings.md 'DefaultDocumentation.IGeneralContext.Settings') | Gets the [ISettings](ISettings.md 'DefaultDocumentation.ISettings') of this documentation generation context. | - -| Methods | | -| :--- | :--- | -| [GetContext(Type)](IGeneralContext.GetContext(Type).md 'DefaultDocumentation.IGeneralContext.GetContext(System.Type)') | Gets the specific [IContext](IContext.md 'DefaultDocumentation.IContext') for the given [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type'). | -| [GetFileName(DocItem)](IGeneralContext.GetFileName(DocItem).md 'DefaultDocumentation.IGeneralContext.GetFileName(DefaultDocumentation.Models.DocItem)') | Gets the file name for the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem'). | -| [GetUrl(string)](IGeneralContext.GetUrl(string).md 'DefaultDocumentation.IGeneralContext.GetUrl(string)') | Gets the url of the given id. | diff --git a/documentation/api/IGeneralContextExtension.GetContext(thisIGeneralContext,DocItem).md b/documentation/api/IGeneralContextExtension.GetContext(thisIGeneralContext,DocItem).md deleted file mode 100644 index a62e1e63..00000000 --- a/documentation/api/IGeneralContextExtension.GetContext(thisIGeneralContext,DocItem).md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContextExtension](IGeneralContextExtension.md 'DefaultDocumentation.IGeneralContextExtension') - -## IGeneralContextExtension.GetContext(this IGeneralContext, DocItem) Method - -Gets the specific [IContext](IContext.md 'DefaultDocumentation.IContext') for the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') kind. - -```csharp -public static DefaultDocumentation.IContext GetContext(this DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); -``` -#### Parameters - - - -`context` [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation file. - - - -`item` [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') for which to get a specific [IContext](IContext.md 'DefaultDocumentation.IContext'). - -#### Returns -[IContext](IContext.md 'DefaultDocumentation.IContext') -The [IContext](IContext.md 'DefaultDocumentation.IContext') specific to the provided [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem'). \ No newline at end of file diff --git a/documentation/api/IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,DocItem,Func_IContext,T_).md b/documentation/api/IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,DocItem,Func_IContext,T_).md deleted file mode 100644 index acd914c1..00000000 --- a/documentation/api/IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,DocItem,Func_IContext,T_).md +++ /dev/null @@ -1,43 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContextExtension](IGeneralContextExtension.md 'DefaultDocumentation.IGeneralContextExtension') - -## IGeneralContextExtension.GetSetting(this IGeneralContext, DocItem, Func) Method - -Gets a data from the specific [IContext](IContext.md 'DefaultDocumentation.IContext') of the provided [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') if it exists, else from the [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext'). - -```csharp -public static T? GetSetting(this DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item, System.Func getter); -``` -#### Type parameters - - - -`T` - -The type of the data to get. -#### Parameters - - - -`context` [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation file. - - - -`item` [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') for which to get a specific setting. - - - -`getter` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[IContext](IContext.md 'DefaultDocumentation.IContext')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[T](IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,DocItem,Func_IContext,T_).md#DefaultDocumentation.IGeneralContextExtension.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem,System.Func_DefaultDocumentation.IContext,T_).T 'DefaultDocumentation.IGeneralContextExtension.GetSetting(this DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem, System.Func).T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') - -The [System.Func<>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') used to get the setting from a [IContext](IContext.md 'DefaultDocumentation.IContext'). - -#### Returns -[T](IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,DocItem,Func_IContext,T_).md#DefaultDocumentation.IGeneralContextExtension.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem,System.Func_DefaultDocumentation.IContext,T_).T 'DefaultDocumentation.IGeneralContextExtension.GetSetting(this DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem, System.Func).T') -The [T](IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,DocItem,Func_IContext,T_).md#DefaultDocumentation.IGeneralContextExtension.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem,System.Func_DefaultDocumentation.IContext,T_).T 'DefaultDocumentation.IGeneralContextExtension.GetSetting(this DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem, System.Func).T') settings from the specific [IContext](IContext.md 'DefaultDocumentation.IContext') if it exists, otherwise from the [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext'). - -### Remarks -The [T](IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,DocItem,Func_IContext,T_).md#DefaultDocumentation.IGeneralContextExtension.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem,System.Func_DefaultDocumentation.IContext,T_).T 'DefaultDocumentation.IGeneralContextExtension.GetSetting(this DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem, System.Func).T') should be [System.Nullable<>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') for struct settings. \ No newline at end of file diff --git a/documentation/api/IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,Type,Func_IContext,T_).md b/documentation/api/IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,Type,Func_IContext,T_).md deleted file mode 100644 index 5a7e477a..00000000 --- a/documentation/api/IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,Type,Func_IContext,T_).md +++ /dev/null @@ -1,43 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContextExtension](IGeneralContextExtension.md 'DefaultDocumentation.IGeneralContextExtension') - -## IGeneralContextExtension.GetSetting(this IGeneralContext, Type, Func) Method - -Gets a data from the specific [IContext](IContext.md 'DefaultDocumentation.IContext') of the provided [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type') if it exists, else from the [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext'). - -```csharp -public static T? GetSetting(this DefaultDocumentation.IGeneralContext context, System.Type type, System.Func getter); -``` -#### Type parameters - - - -`T` - -The type of the data to get. -#### Parameters - - - -`context` [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation file. - - - -`type` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type') - -The [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type') for which to get a specific setting. - - - -`getter` [System.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[IContext](IContext.md 'DefaultDocumentation.IContext')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2')[T](IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,Type,Func_IContext,T_).md#DefaultDocumentation.IGeneralContextExtension.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,System.Type,System.Func_DefaultDocumentation.IContext,T_).T 'DefaultDocumentation.IGeneralContextExtension.GetSetting(this DefaultDocumentation.IGeneralContext, System.Type, System.Func).T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') - -The [System.Func<>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System.Func`2') used to get the setting from a [IContext](IContext.md 'DefaultDocumentation.IContext'). - -#### Returns -[T](IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,Type,Func_IContext,T_).md#DefaultDocumentation.IGeneralContextExtension.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,System.Type,System.Func_DefaultDocumentation.IContext,T_).T 'DefaultDocumentation.IGeneralContextExtension.GetSetting(this DefaultDocumentation.IGeneralContext, System.Type, System.Func).T') -The [T](IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,Type,Func_IContext,T_).md#DefaultDocumentation.IGeneralContextExtension.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,System.Type,System.Func_DefaultDocumentation.IContext,T_).T 'DefaultDocumentation.IGeneralContextExtension.GetSetting(this DefaultDocumentation.IGeneralContext, System.Type, System.Func).T') settings from the specific [IContext](IContext.md 'DefaultDocumentation.IContext') if it exists, otherwise from the [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext'). - -### Remarks -The [T](IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,Type,Func_IContext,T_).md#DefaultDocumentation.IGeneralContextExtension.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,System.Type,System.Func_DefaultDocumentation.IContext,T_).T 'DefaultDocumentation.IGeneralContextExtension.GetSetting(this DefaultDocumentation.IGeneralContext, System.Type, System.Func).T') should be [System.Nullable<>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') for struct settings. \ No newline at end of file diff --git a/documentation/api/IGeneralContextExtension.GetUrl(thisIGeneralContext,DocItem).md b/documentation/api/IGeneralContextExtension.GetUrl(thisIGeneralContext,DocItem).md deleted file mode 100644 index 7d8cedf3..00000000 --- a/documentation/api/IGeneralContextExtension.GetUrl(thisIGeneralContext,DocItem).md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContextExtension](IGeneralContextExtension.md 'DefaultDocumentation.IGeneralContextExtension') - -## IGeneralContextExtension.GetUrl(this IGeneralContext, DocItem) Method - -Gets the url of the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public static string GetUrl(this DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); -``` -#### Parameters - - - -`context` [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation file. - - - -`item` [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') for which to get the url. - -#### Returns -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The url of the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem'). \ No newline at end of file diff --git a/documentation/api/IGeneralContextExtension.md b/documentation/api/IGeneralContextExtension.md deleted file mode 100644 index 48b9c3a5..00000000 --- a/documentation/api/IGeneralContextExtension.md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation') - -## IGeneralContextExtension Class - -Provides extension methods on the [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') type. - -```csharp -public static class IGeneralContextExtension -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 IGeneralContextExtension - -| Methods | | -| :--- | :--- | -| [GetContext(this IGeneralContext, DocItem)](IGeneralContextExtension.GetContext(thisIGeneralContext,DocItem).md 'DefaultDocumentation.IGeneralContextExtension.GetContext(this DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)') | Gets the specific [IContext](IContext.md 'DefaultDocumentation.IContext') for the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') kind. | -| [GetSetting<T>(this IGeneralContext, DocItem, Func<IContext,T>)](IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,DocItem,Func_IContext,T_).md 'DefaultDocumentation.IGeneralContextExtension.GetSetting(this DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem, System.Func)') | Gets a data from the specific [IContext](IContext.md 'DefaultDocumentation.IContext') of the provided [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') if it exists, else from the [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext'). | -| [GetSetting<T>(this IGeneralContext, Type, Func<IContext,T>)](IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,Type,Func_IContext,T_).md 'DefaultDocumentation.IGeneralContextExtension.GetSetting(this DefaultDocumentation.IGeneralContext, System.Type, System.Func)') | Gets a data from the specific [IContext](IContext.md 'DefaultDocumentation.IContext') of the provided [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type') if it exists, else from the [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext'). | -| [GetUrl(this IGeneralContext, DocItem)](IGeneralContextExtension.GetUrl(thisIGeneralContext,DocItem).md 'DefaultDocumentation.IGeneralContextExtension.GetUrl(this DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)') | Gets the url of the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem'). | diff --git a/documentation/api/IParameterizedDocItem.Parameters.md b/documentation/api/IParameterizedDocItem.Parameters.md deleted file mode 100644 index 84b13085..00000000 --- a/documentation/api/IParameterizedDocItem.Parameters.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models').[IParameterizedDocItem](IParameterizedDocItem.md 'DefaultDocumentation.Models.IParameterizedDocItem') - -## IParameterizedDocItem.Parameters Property - -Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. - -```csharp -System.Collections.Generic.IEnumerable Parameters { get; } -``` - -#### Property Value -[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') \ No newline at end of file diff --git a/documentation/api/IParameterizedDocItem.md b/documentation/api/IParameterizedDocItem.md deleted file mode 100644 index 3d2c2369..00000000 --- a/documentation/api/IParameterizedDocItem.md +++ /dev/null @@ -1,22 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models') - -## IParameterizedDocItem Interface - -Exposes [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') instances. - -```csharp -public interface IParameterizedDocItem -``` - -Derived -↳ [ConstructorDocItem](ConstructorDocItem.md 'DefaultDocumentation.Models.Members.ConstructorDocItem') -↳ [ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') -↳ [MethodDocItem](MethodDocItem.md 'DefaultDocumentation.Models.Members.MethodDocItem') -↳ [OperatorDocItem](OperatorDocItem.md 'DefaultDocumentation.Models.Members.OperatorDocItem') -↳ [PropertyDocItem](PropertyDocItem.md 'DefaultDocumentation.Models.Members.PropertyDocItem') -↳ [DelegateDocItem](DelegateDocItem.md 'DefaultDocumentation.Models.Types.DelegateDocItem') - -| Properties | | -| :--- | :--- | -| [Parameters](IParameterizedDocItem.Parameters.md 'DefaultDocumentation.Models.IParameterizedDocItem.Parameters') | Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. | diff --git a/documentation/api/ISection.Name.md b/documentation/api/ISection.Name.md deleted file mode 100644 index b38062c6..00000000 --- a/documentation/api/ISection.Name.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[ISection](ISection.md 'DefaultDocumentation.Api.ISection') - -## ISection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -string Name { get; } -``` - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/api/ISection.Write(IWriter).md b/documentation/api/ISection.Write(IWriter).md deleted file mode 100644 index 30f19f73..00000000 --- a/documentation/api/ISection.Write(IWriter).md +++ /dev/null @@ -1,17 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[ISection](ISection.md 'DefaultDocumentation.Api.ISection') - -## ISection.Write(IWriter) Method - -Writes the section to a given [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. \ No newline at end of file diff --git a/documentation/api/ISection.md b/documentation/api/ISection.md deleted file mode 100644 index 595bd7c2..00000000 --- a/documentation/api/ISection.md +++ /dev/null @@ -1,18 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api') - -## ISection Interface - -Exposes a method to write a specific section when writing documentation. - -```csharp -public interface ISection -``` - -| Properties | | -| :--- | :--- | -| [Name](ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/api/ISettings.AssemblyFile.md b/documentation/api/ISettings.AssemblyFile.md deleted file mode 100644 index 92d0b6bc..00000000 --- a/documentation/api/ISettings.AssemblyFile.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](ISettings.md 'DefaultDocumentation.ISettings') - -## ISettings.AssemblyFile Property - -Gets the assembly file for which the documentation is being generated. - -```csharp -System.IO.FileInfo AssemblyFile { get; } -``` - -#### Property Value -[System.IO.FileInfo](https://docs.microsoft.com/en-us/dotnet/api/System.IO.FileInfo 'System.IO.FileInfo') \ No newline at end of file diff --git a/documentation/api/ISettings.AssemblyPageName.md b/documentation/api/ISettings.AssemblyPageName.md deleted file mode 100644 index 07899881..00000000 --- a/documentation/api/ISettings.AssemblyPageName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](ISettings.md 'DefaultDocumentation.ISettings') - -## ISettings.AssemblyPageName Property - -Gets the name of the assembly page name. - -```csharp -string? AssemblyPageName { get; } -``` - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/api/ISettings.DocumentationFile.md b/documentation/api/ISettings.DocumentationFile.md deleted file mode 100644 index 4e76cdd3..00000000 --- a/documentation/api/ISettings.DocumentationFile.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](ISettings.md 'DefaultDocumentation.ISettings') - -## ISettings.DocumentationFile Property - -Gets the xml documentation file of the [AssemblyFile](ISettings.AssemblyFile.md 'DefaultDocumentation.ISettings.AssemblyFile'). - -```csharp -System.IO.FileInfo DocumentationFile { get; } -``` - -#### Property Value -[System.IO.FileInfo](https://docs.microsoft.com/en-us/dotnet/api/System.IO.FileInfo 'System.IO.FileInfo') \ No newline at end of file diff --git a/documentation/api/ISettings.ExternLinksFiles.md b/documentation/api/ISettings.ExternLinksFiles.md deleted file mode 100644 index eff447cd..00000000 --- a/documentation/api/ISettings.ExternLinksFiles.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](ISettings.md 'DefaultDocumentation.ISettings') - -## ISettings.ExternLinksFiles Property - -Gets the links files of external items which are not part of the dotnet api. - -```csharp -System.Collections.Generic.IEnumerable ExternLinksFiles { get; } -``` - -#### Property Value -[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[System.IO.FileInfo](https://docs.microsoft.com/en-us/dotnet/api/System.IO.FileInfo 'System.IO.FileInfo')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') \ No newline at end of file diff --git a/documentation/api/ISettings.GeneratedAccessModifiers.md b/documentation/api/ISettings.GeneratedAccessModifiers.md deleted file mode 100644 index 17f8bc5f..00000000 --- a/documentation/api/ISettings.GeneratedAccessModifiers.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](ISettings.md 'DefaultDocumentation.ISettings') - -## ISettings.GeneratedAccessModifiers Property - -Gets the [GeneratedAccessModifiers](GeneratedAccessModifiers.md 'DefaultDocumentation.GeneratedAccessModifiers') flags stating which access modifiers should have their documentation generated. - -```csharp -DefaultDocumentation.GeneratedAccessModifiers GeneratedAccessModifiers { get; } -``` - -#### Property Value -[GeneratedAccessModifiers](GeneratedAccessModifiers.md 'DefaultDocumentation.GeneratedAccessModifiers') \ No newline at end of file diff --git a/documentation/api/ISettings.GeneratedPages.md b/documentation/api/ISettings.GeneratedPages.md deleted file mode 100644 index ca279231..00000000 --- a/documentation/api/ISettings.GeneratedPages.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](ISettings.md 'DefaultDocumentation.ISettings') - -## ISettings.GeneratedPages Property - -Gets the [GeneratedPages](GeneratedPages.md 'DefaultDocumentation.GeneratedPages') flags stating which kind should have their own page and which should be inlined. - -```csharp -DefaultDocumentation.GeneratedPages GeneratedPages { get; } -``` - -#### Property Value -[GeneratedPages](GeneratedPages.md 'DefaultDocumentation.GeneratedPages') \ No newline at end of file diff --git a/documentation/api/ISettings.IncludeUndocumentedItems.md b/documentation/api/ISettings.IncludeUndocumentedItems.md deleted file mode 100644 index 459a5680..00000000 --- a/documentation/api/ISettings.IncludeUndocumentedItems.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](ISettings.md 'DefaultDocumentation.ISettings') - -## ISettings.IncludeUndocumentedItems Property - -Gets wether item with no xml documentation should have their documentation generated or not. - -```csharp -bool IncludeUndocumentedItems { get; } -``` - -#### Property Value -[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') \ No newline at end of file diff --git a/documentation/api/ISettings.LinksBaseUrl.md b/documentation/api/ISettings.LinksBaseUrl.md deleted file mode 100644 index 19f297d6..00000000 --- a/documentation/api/ISettings.LinksBaseUrl.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](ISettings.md 'DefaultDocumentation.ISettings') - -## ISettings.LinksBaseUrl Property - -Gets the base url to prefix item url with when generating the links output file. - -```csharp -string? LinksBaseUrl { get; } -``` - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/api/ISettings.LinksOutputFile.md b/documentation/api/ISettings.LinksOutputFile.md deleted file mode 100644 index 588d98d1..00000000 --- a/documentation/api/ISettings.LinksOutputFile.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](ISettings.md 'DefaultDocumentation.ISettings') - -## ISettings.LinksOutputFile Property - -Gets the file name where all the url of the generated documentation should be writen to, to be used for referencing documentation generation. - -```csharp -System.IO.FileInfo? LinksOutputFile { get; } -``` - -#### Property Value -[System.IO.FileInfo](https://docs.microsoft.com/en-us/dotnet/api/System.IO.FileInfo 'System.IO.FileInfo') \ No newline at end of file diff --git a/documentation/api/ISettings.Logger.md b/documentation/api/ISettings.Logger.md deleted file mode 100644 index 747107dd..00000000 --- a/documentation/api/ISettings.Logger.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](ISettings.md 'DefaultDocumentation.ISettings') - -## ISettings.Logger Property - -Gets the [NLog.ILogger](https://docs.microsoft.com/en-us/dotnet/api/NLog.ILogger 'NLog.ILogger') of the process. - -```csharp -ILogger Logger { get; } -``` - -#### Property Value -[NLog.ILogger](https://docs.microsoft.com/en-us/dotnet/api/NLog.ILogger 'NLog.ILogger') \ No newline at end of file diff --git a/documentation/api/ISettings.OutputDirectory.md b/documentation/api/ISettings.OutputDirectory.md deleted file mode 100644 index e9982a80..00000000 --- a/documentation/api/ISettings.OutputDirectory.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](ISettings.md 'DefaultDocumentation.ISettings') - -## ISettings.OutputDirectory Property - -Gets the output directory where the documentation is being generated. - -```csharp -System.IO.DirectoryInfo OutputDirectory { get; } -``` - -#### Property Value -[System.IO.DirectoryInfo](https://docs.microsoft.com/en-us/dotnet/api/System.IO.DirectoryInfo 'System.IO.DirectoryInfo') \ No newline at end of file diff --git a/documentation/api/ISettings.ProjectDirectory.md b/documentation/api/ISettings.ProjectDirectory.md deleted file mode 100644 index d8bc06d7..00000000 --- a/documentation/api/ISettings.ProjectDirectory.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[ISettings](ISettings.md 'DefaultDocumentation.ISettings') - -## ISettings.ProjectDirectory Property - -Gets the root project directory where the sources of the [AssemblyFile](ISettings.AssemblyFile.md 'DefaultDocumentation.ISettings.AssemblyFile') are. - -```csharp -System.IO.DirectoryInfo? ProjectDirectory { get; } -``` - -#### Property Value -[System.IO.DirectoryInfo](https://docs.microsoft.com/en-us/dotnet/api/System.IO.DirectoryInfo 'System.IO.DirectoryInfo') \ No newline at end of file diff --git a/documentation/api/ISettings.md b/documentation/api/ISettings.md deleted file mode 100644 index f851b38d..00000000 --- a/documentation/api/ISettings.md +++ /dev/null @@ -1,25 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation') - -## ISettings Interface - -Exposes all the settings of the documentation generation process. - -```csharp -public interface ISettings -``` - -| Properties | | -| :--- | :--- | -| [AssemblyFile](ISettings.AssemblyFile.md 'DefaultDocumentation.ISettings.AssemblyFile') | Gets the assembly file for which the documentation is being generated. | -| [AssemblyPageName](ISettings.AssemblyPageName.md 'DefaultDocumentation.ISettings.AssemblyPageName') | Gets the name of the assembly page name. | -| [DocumentationFile](ISettings.DocumentationFile.md 'DefaultDocumentation.ISettings.DocumentationFile') | Gets the xml documentation file of the [AssemblyFile](ISettings.AssemblyFile.md 'DefaultDocumentation.ISettings.AssemblyFile'). | -| [ExternLinksFiles](ISettings.ExternLinksFiles.md 'DefaultDocumentation.ISettings.ExternLinksFiles') | Gets the links files of external items which are not part of the dotnet api. | -| [GeneratedAccessModifiers](ISettings.GeneratedAccessModifiers.md 'DefaultDocumentation.ISettings.GeneratedAccessModifiers') | Gets the [GeneratedAccessModifiers](GeneratedAccessModifiers.md 'DefaultDocumentation.GeneratedAccessModifiers') flags stating which access modifiers should have their documentation generated. | -| [GeneratedPages](ISettings.GeneratedPages.md 'DefaultDocumentation.ISettings.GeneratedPages') | Gets the [GeneratedPages](GeneratedPages.md 'DefaultDocumentation.GeneratedPages') flags stating which kind should have their own page and which should be inlined. | -| [IncludeUndocumentedItems](ISettings.IncludeUndocumentedItems.md 'DefaultDocumentation.ISettings.IncludeUndocumentedItems') | Gets wether item with no xml documentation should have their documentation generated or not. | -| [LinksBaseUrl](ISettings.LinksBaseUrl.md 'DefaultDocumentation.ISettings.LinksBaseUrl') | Gets the base url to prefix item url with when generating the links output file. | -| [LinksOutputFile](ISettings.LinksOutputFile.md 'DefaultDocumentation.ISettings.LinksOutputFile') | Gets the file name where all the url of the generated documentation should be writen to, to be used for referencing documentation generation. | -| [Logger](ISettings.Logger.md 'DefaultDocumentation.ISettings.Logger') | Gets the [NLog.ILogger](https://docs.microsoft.com/en-us/dotnet/api/NLog.ILogger 'NLog.ILogger') of the process. | -| [OutputDirectory](ISettings.OutputDirectory.md 'DefaultDocumentation.ISettings.OutputDirectory') | Gets the output directory where the documentation is being generated. | -| [ProjectDirectory](ISettings.ProjectDirectory.md 'DefaultDocumentation.ISettings.ProjectDirectory') | Gets the root project directory where the sources of the [AssemblyFile](ISettings.AssemblyFile.md 'DefaultDocumentation.ISettings.AssemblyFile') are. | diff --git a/documentation/api/ITypeParameterizedDocItem.TypeParameters.md b/documentation/api/ITypeParameterizedDocItem.TypeParameters.md deleted file mode 100644 index 7a2189f3..00000000 --- a/documentation/api/ITypeParameterizedDocItem.TypeParameters.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models').[ITypeParameterizedDocItem](ITypeParameterizedDocItem.md 'DefaultDocumentation.Models.ITypeParameterizedDocItem') - -## ITypeParameterizedDocItem.TypeParameters Property - -Gets the [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') of this instance. - -```csharp -System.Collections.Generic.IEnumerable TypeParameters { get; } -``` - -#### Property Value -[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') \ No newline at end of file diff --git a/documentation/api/ITypeParameterizedDocItem.md b/documentation/api/ITypeParameterizedDocItem.md deleted file mode 100644 index 0b9c8c55..00000000 --- a/documentation/api/ITypeParameterizedDocItem.md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models') - -## ITypeParameterizedDocItem Interface - -Exposes [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') instances. - -```csharp -public interface ITypeParameterizedDocItem -``` - -Derived -↳ [ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') -↳ [MethodDocItem](MethodDocItem.md 'DefaultDocumentation.Models.Members.MethodDocItem') -↳ [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') - -| Properties | | -| :--- | :--- | -| [TypeParameters](ITypeParameterizedDocItem.TypeParameters.md 'DefaultDocumentation.Models.ITypeParameterizedDocItem.TypeParameters') | Gets the [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') of this instance. | diff --git a/documentation/api/IUrlFactory.GetUrl(IGeneralContext,string).md b/documentation/api/IUrlFactory.GetUrl(IGeneralContext,string).md deleted file mode 100644 index b13144c6..00000000 --- a/documentation/api/IUrlFactory.GetUrl(IGeneralContext,string).md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[IUrlFactory](IUrlFactory.md 'DefaultDocumentation.Api.IUrlFactory') - -## IUrlFactory.GetUrl(IGeneralContext, string) Method - -Gets the url of the given id. Returns null of the instance does not know how to handle the provided id. - -```csharp -string? GetUrl(DefaultDocumentation.IGeneralContext context, string id); -``` -#### Parameters - - - -`context` [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - - - -`id` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The id to get the url for. - -#### Returns -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The url of the given id. \ No newline at end of file diff --git a/documentation/api/IUrlFactory.Name.md b/documentation/api/IUrlFactory.Name.md deleted file mode 100644 index 5d982ed4..00000000 --- a/documentation/api/IUrlFactory.Name.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[IUrlFactory](IUrlFactory.md 'DefaultDocumentation.Api.IUrlFactory') - -## IUrlFactory.Name Property - -Gets the name of the factory, used to identify it at the configuration level. - -```csharp -string Name { get; } -``` - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/api/IUrlFactory.md b/documentation/api/IUrlFactory.md deleted file mode 100644 index f2c422e6..00000000 --- a/documentation/api/IUrlFactory.md +++ /dev/null @@ -1,18 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api') - -## IUrlFactory Interface - -Exposes methods related to the documentation files url creation. - -```csharp -public interface IUrlFactory -``` - -| Properties | | -| :--- | :--- | -| [Name](IUrlFactory.Name.md 'DefaultDocumentation.Api.IUrlFactory.Name') | Gets the name of the factory, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [GetUrl(IGeneralContext, string)](IUrlFactory.GetUrl(IGeneralContext,string).md 'DefaultDocumentation.Api.IUrlFactory.GetUrl(DefaultDocumentation.IGeneralContext, string)') | Gets the url of the given id. Returns null of the instance does not know how to handle the provided id. | diff --git a/documentation/api/IWriter.Append(string).md b/documentation/api/IWriter.Append(string).md deleted file mode 100644 index f83f6dfa..00000000 --- a/documentation/api/IWriter.Append(string).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') - -## IWriter.Append(string) Method - -Appends a string at the end of the documentation text. - -```csharp -DefaultDocumentation.Api.IWriter Append(string value); -``` -#### Parameters - - - -`value` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -#### Returns -[IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') -The current [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/api/IWriter.AppendLine().md b/documentation/api/IWriter.AppendLine().md deleted file mode 100644 index 73f7eb08..00000000 --- a/documentation/api/IWriter.AppendLine().md +++ /dev/null @@ -1,14 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') - -## IWriter.AppendLine() Method - -Appends a [System.Environment.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System.Environment.NewLine') at the end of the documentation text. - -```csharp -DefaultDocumentation.Api.IWriter AppendLine(); -``` - -#### Returns -[IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') -The current [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/api/IWriter.Context.md b/documentation/api/IWriter.Context.md deleted file mode 100644 index 4a13da20..00000000 --- a/documentation/api/IWriter.Context.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') - -## IWriter.Context Property - -Gets the [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - -```csharp -DefaultDocumentation.IGeneralContext Context { get; } -``` - -#### Property Value -[IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') \ No newline at end of file diff --git a/documentation/api/IWriter.DocItem.md b/documentation/api/IWriter.DocItem.md deleted file mode 100644 index 356620c9..00000000 --- a/documentation/api/IWriter.DocItem.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') - -## IWriter.DocItem Property - -Gets the [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') for which the documentation is being generated. - -```csharp -DefaultDocumentation.Models.DocItem DocItem { get; } -``` - -#### Property Value -[DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') \ No newline at end of file diff --git a/documentation/api/IWriter.EndsWith(string).md b/documentation/api/IWriter.EndsWith(string).md deleted file mode 100644 index 74d8c122..00000000 --- a/documentation/api/IWriter.EndsWith(string).md +++ /dev/null @@ -1,21 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') - -## IWriter.EndsWith(string) Method - -Returns whether the documentation text ends with the given string. - -```csharp -bool EndsWith(string value); -``` -#### Parameters - - - -`value` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') to check. - -#### Returns -[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') -[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if the documentation text ends with [value](IWriter.EndsWith(string).md#DefaultDocumentation.Api.IWriter.EndsWith(string).value 'DefaultDocumentation.Api.IWriter.EndsWith(string).value'), else [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). \ No newline at end of file diff --git a/documentation/api/IWriter.Length.md b/documentation/api/IWriter.Length.md deleted file mode 100644 index 993b49df..00000000 --- a/documentation/api/IWriter.Length.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') - -## IWriter.Length Property - -Gets or sets the length of the documentation text currently produced. - -```csharp -int Length { get; set; } -``` - -#### Property Value -[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') \ No newline at end of file diff --git a/documentation/api/IWriter.md b/documentation/api/IWriter.md deleted file mode 100644 index 96f7df82..00000000 --- a/documentation/api/IWriter.md +++ /dev/null @@ -1,23 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api') - -## IWriter Interface - -Exposes properties and methods use to generate a documentation file for a specific [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public interface IWriter -``` - -| Properties | | -| :--- | :--- | -| [Context](IWriter.Context.md 'DefaultDocumentation.Api.IWriter.Context') | Gets the [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. | -| [DocItem](IWriter.DocItem.md 'DefaultDocumentation.Api.IWriter.DocItem') | Gets the [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') for which the documentation is being generated. | -| [Length](IWriter.Length.md 'DefaultDocumentation.Api.IWriter.Length') | Gets or sets the length of the documentation text currently produced. | -| [this[string]](IWriter.this[string].md 'DefaultDocumentation.Api.IWriter.this[string]') | Gets or sets extra data for the current [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') documentation generation. | - -| Methods | | -| :--- | :--- | -| [Append(string)](IWriter.Append(string).md 'DefaultDocumentation.Api.IWriter.Append(string)') | Appends a string at the end of the documentation text. | -| [AppendLine()](IWriter.AppendLine().md 'DefaultDocumentation.Api.IWriter.AppendLine()') | Appends a [System.Environment.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System.Environment.NewLine') at the end of the documentation text. | -| [EndsWith(string)](IWriter.EndsWith(string).md 'DefaultDocumentation.Api.IWriter.EndsWith(string)') | Returns whether the documentation text ends with the given string. | diff --git a/documentation/api/IWriter.this[string].md b/documentation/api/IWriter.this[string].md deleted file mode 100644 index bd4d61c1..00000000 --- a/documentation/api/IWriter.this[string].md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') - -## IWriter.this[string] Property - -Gets or sets extra data for the current [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') documentation generation. - -```csharp -object? this[string key] { get; set; } -``` -#### Parameters - - - -`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The key of the data. - -#### Property Value -[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') \ No newline at end of file diff --git a/documentation/api/IWriterExtension.Append(thisIWriter,XElement).md b/documentation/api/IWriterExtension.Append(thisIWriter,XElement).md deleted file mode 100644 index 2b41f94d..00000000 --- a/documentation/api/IWriterExtension.Append(thisIWriter,XElement).md +++ /dev/null @@ -1,28 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Api.IWriterExtension') - -## IWriterExtension.Append(this IWriter, XElement) Method - -Appends an [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') to a [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') by using the [Elements](IGeneralContext.Elements.md 'DefaultDocumentation.IGeneralContext.Elements') of [Context](IWriter.Context.md 'DefaultDocumentation.Api.IWriter.Context'). -If no [IElement](IElement.md 'DefaultDocumentation.Api.IElement') is found, the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') is appended as text directly. - -```csharp -public static DefaultDocumentation.Api.IWriter Append(this DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement? value); -``` -#### Parameters - - - -`writer` [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') to append to. - - - -`value` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') to append. - -#### Returns -[IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') -The given [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/api/IWriterExtension.AppendLine(thisIWriter,string).md b/documentation/api/IWriterExtension.AppendLine(thisIWriter,string).md deleted file mode 100644 index fff7f325..00000000 --- a/documentation/api/IWriterExtension.AppendLine(thisIWriter,string).md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Api.IWriterExtension') - -## IWriterExtension.AppendLine(this IWriter, string) Method - -Appends a line after writing the provided [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String'). - -```csharp -public static DefaultDocumentation.Api.IWriter AppendLine(this DefaultDocumentation.Api.IWriter writer, string value); -``` -#### Parameters - - - -`writer` [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') to append to. - - - -`value` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') to append before the line. - -#### Returns -[IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') -The given [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/api/IWriterExtension.TrimEnd(thisIWriter,string[]).md b/documentation/api/IWriterExtension.TrimEnd(thisIWriter,string[]).md deleted file mode 100644 index 671c0385..00000000 --- a/documentation/api/IWriterExtension.TrimEnd(thisIWriter,string[]).md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api').[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Api.IWriterExtension') - -## IWriterExtension.TrimEnd(this IWriter, string[]) Method - -Trims from the end of a [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') all the provided values. - -```csharp -public static DefaultDocumentation.Api.IWriter TrimEnd(this DefaultDocumentation.Api.IWriter writer, params string[] values); -``` -#### Parameters - - - -`writer` [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') to trim. - - - -`values` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') - -The [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') values to trim from the end. - -#### Returns -[IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') -The given [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/api/IWriterExtension.md b/documentation/api/IWriterExtension.md deleted file mode 100644 index 60a201ae..00000000 --- a/documentation/api/IWriterExtension.md +++ /dev/null @@ -1,18 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api') - -## IWriterExtension Class - -Provides extension methods on the [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') type. - -```csharp -public static class IWriterExtension -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 IWriterExtension - -| Methods | | -| :--- | :--- | -| [Append(this IWriter, XElement)](IWriterExtension.Append(thisIWriter,XElement).md 'DefaultDocumentation.Api.IWriterExtension.Append(this DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)') | Appends an [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') to a [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') by using the [Elements](IGeneralContext.Elements.md 'DefaultDocumentation.IGeneralContext.Elements') of [Context](IWriter.Context.md 'DefaultDocumentation.Api.IWriter.Context').
If no [IElement](IElement.md 'DefaultDocumentation.Api.IElement') is found, the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') is appended as text directly. | -| [AppendLine(this IWriter, string)](IWriterExtension.AppendLine(thisIWriter,string).md 'DefaultDocumentation.Api.IWriterExtension.AppendLine(this DefaultDocumentation.Api.IWriter, string)') | Appends a line after writing the provided [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String'). | -| [TrimEnd(this IWriter, string[])](IWriterExtension.TrimEnd(thisIWriter,string[]).md 'DefaultDocumentation.Api.IWriterExtension.TrimEnd(this DefaultDocumentation.Api.IWriter, string[])') | Trims from the end of a [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') all the provided values. | diff --git a/documentation/api/InterfaceDocItem.InterfaceDocItem(DocItem,ITypeDefinition,XElement).md b/documentation/api/InterfaceDocItem.InterfaceDocItem(DocItem,ITypeDefinition,XElement).md deleted file mode 100644 index 90f63ea1..00000000 --- a/documentation/api/InterfaceDocItem.InterfaceDocItem(DocItem,ITypeDefinition,XElement).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Types](index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation.Models.Types').[InterfaceDocItem](InterfaceDocItem.md 'DefaultDocumentation.Models.Types.InterfaceDocItem') - -## InterfaceDocItem(DocItem, ITypeDefinition, XElement) Constructor - -Initialize a new instance of the [StructDocItem](StructDocItem.md 'DefaultDocumentation.Models.Types.StructDocItem') type. - -```csharp -public InterfaceDocItem(DefaultDocumentation.Models.DocItem parent, ITypeDefinition type, System.Xml.Linq.XElement? documentation); -``` -#### Parameters - - - -`parent` [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') parent type or namespace of the interface. - - - -`type` [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') - -The [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') of the interface. - - - -`documentation` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') documentation element of the interface. \ No newline at end of file diff --git a/documentation/api/InterfaceDocItem.md b/documentation/api/InterfaceDocItem.md deleted file mode 100644 index b80e87c3..00000000 --- a/documentation/api/InterfaceDocItem.md +++ /dev/null @@ -1,16 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Types](index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation.Models.Types') - -## InterfaceDocItem Class - -Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') of the [TypeKind.Interface](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.TypeKind.Interface') kind documentation. - -```csharp -public sealed class InterfaceDocItem : DefaultDocumentation.Models.Types.TypeDocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 [EntityDocItem](EntityDocItem.md 'DefaultDocumentation.Models.EntityDocItem') 🡒 [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') 🡒 InterfaceDocItem - -| Constructors | | -| :--- | :--- | -| [InterfaceDocItem(DocItem, ITypeDefinition, XElement)](InterfaceDocItem.InterfaceDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation.Models.Types.InterfaceDocItem.InterfaceDocItem(DefaultDocumentation.Models.DocItem, ITypeDefinition, System.Xml.Linq.XElement)') | Initialize a new instance of the [StructDocItem](StructDocItem.md 'DefaultDocumentation.Models.Types.StructDocItem') type. | diff --git a/documentation/api/MethodDocItem.Method.md b/documentation/api/MethodDocItem.Method.md deleted file mode 100644 index 718e444e..00000000 --- a/documentation/api/MethodDocItem.Method.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[MethodDocItem](MethodDocItem.md 'DefaultDocumentation.Models.Members.MethodDocItem') - -## MethodDocItem.Method Property - -Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') of the current instance. - -```csharp -public IMethod Method { get; } -``` - -#### Property Value -[IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') \ No newline at end of file diff --git a/documentation/api/MethodDocItem.MethodDocItem(TypeDocItem,IMethod,XElement).md b/documentation/api/MethodDocItem.MethodDocItem(TypeDocItem,IMethod,XElement).md deleted file mode 100644 index a2e7beb5..00000000 --- a/documentation/api/MethodDocItem.MethodDocItem(TypeDocItem,IMethod,XElement).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[MethodDocItem](MethodDocItem.md 'DefaultDocumentation.Models.Members.MethodDocItem') - -## MethodDocItem(TypeDocItem, IMethod, XElement) Constructor - -Initialize a new instance of the [MethodDocItem](MethodDocItem.md 'DefaultDocumentation.Models.Members.MethodDocItem') type. - -```csharp -public MethodDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, IMethod method, System.Xml.Linq.XElement? documentation); -``` -#### Parameters - - - -`parent` [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') - -The [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') parent type of the method. - - - -`method` [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') - -The [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') of the method. - - - -`documentation` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') documentation element of the method. \ No newline at end of file diff --git a/documentation/api/MethodDocItem.Parameters.md b/documentation/api/MethodDocItem.Parameters.md deleted file mode 100644 index 883ec285..00000000 --- a/documentation/api/MethodDocItem.Parameters.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[MethodDocItem](MethodDocItem.md 'DefaultDocumentation.Models.Members.MethodDocItem') - -## MethodDocItem.Parameters Property - -Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. - -```csharp -public System.Collections.Generic.IEnumerable Parameters { get; } -``` - -Implements [Parameters](IParameterizedDocItem.Parameters.md 'DefaultDocumentation.Models.IParameterizedDocItem.Parameters') - -#### Property Value -[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') \ No newline at end of file diff --git a/documentation/api/MethodDocItem.TypeParameters.md b/documentation/api/MethodDocItem.TypeParameters.md deleted file mode 100644 index da94a517..00000000 --- a/documentation/api/MethodDocItem.TypeParameters.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[MethodDocItem](MethodDocItem.md 'DefaultDocumentation.Models.Members.MethodDocItem') - -## MethodDocItem.TypeParameters Property - -Gets the [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') of this instance. - -```csharp -public System.Collections.Generic.IEnumerable TypeParameters { get; } -``` - -Implements [TypeParameters](ITypeParameterizedDocItem.TypeParameters.md 'DefaultDocumentation.Models.ITypeParameterizedDocItem.TypeParameters') - -#### Property Value -[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') \ No newline at end of file diff --git a/documentation/api/MethodDocItem.md b/documentation/api/MethodDocItem.md deleted file mode 100644 index b91a9e47..00000000 --- a/documentation/api/MethodDocItem.md +++ /dev/null @@ -1,26 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members') - -## MethodDocItem Class - -Represents an [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') documentation. - -```csharp -public sealed class MethodDocItem : DefaultDocumentation.Models.EntityDocItem, -DefaultDocumentation.Models.ITypeParameterizedDocItem, -DefaultDocumentation.Models.IParameterizedDocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 [EntityDocItem](EntityDocItem.md 'DefaultDocumentation.Models.EntityDocItem') 🡒 MethodDocItem - -Implements [ITypeParameterizedDocItem](ITypeParameterizedDocItem.md 'DefaultDocumentation.Models.ITypeParameterizedDocItem'), [IParameterizedDocItem](IParameterizedDocItem.md 'DefaultDocumentation.Models.IParameterizedDocItem') - -| Constructors | | -| :--- | :--- | -| [MethodDocItem(TypeDocItem, IMethod, XElement)](MethodDocItem.MethodDocItem(TypeDocItem,IMethod,XElement).md 'DefaultDocumentation.Models.Members.MethodDocItem.MethodDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IMethod, System.Xml.Linq.XElement)') | Initialize a new instance of the [MethodDocItem](MethodDocItem.md 'DefaultDocumentation.Models.Members.MethodDocItem') type. | - -| Properties | | -| :--- | :--- | -| [Method](MethodDocItem.Method.md 'DefaultDocumentation.Models.Members.MethodDocItem.Method') | Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') of the current instance. | -| [Parameters](MethodDocItem.Parameters.md 'DefaultDocumentation.Models.Members.MethodDocItem.Parameters') | Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. | -| [TypeParameters](MethodDocItem.TypeParameters.md 'DefaultDocumentation.Models.Members.MethodDocItem.TypeParameters') | Gets the [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') of this instance. | diff --git a/documentation/api/NamespaceDocItem.NamespaceDocItem(AssemblyDocItem,string,XElement).md b/documentation/api/NamespaceDocItem.NamespaceDocItem(AssemblyDocItem,string,XElement).md deleted file mode 100644 index 01644fa2..00000000 --- a/documentation/api/NamespaceDocItem.NamespaceDocItem(AssemblyDocItem,string,XElement).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models').[NamespaceDocItem](NamespaceDocItem.md 'DefaultDocumentation.Models.NamespaceDocItem') - -## NamespaceDocItem(AssemblyDocItem, string, XElement) Constructor - -Initialize a new instance of the [NamespaceDocItem](NamespaceDocItem.md 'DefaultDocumentation.Models.NamespaceDocItem') type. - -```csharp -public NamespaceDocItem(DefaultDocumentation.Models.AssemblyDocItem parent, string name, System.Xml.Linq.XElement? documentation); -``` -#### Parameters - - - -`parent` [AssemblyDocItem](AssemblyDocItem.md 'DefaultDocumentation.Models.AssemblyDocItem') - -The [AssemblyDocItem](AssemblyDocItem.md 'DefaultDocumentation.Models.AssemblyDocItem') parent assembly of the namespace. - - - -`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The name of the namespace. - - - -`documentation` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') documentation element of the namespace. \ No newline at end of file diff --git a/documentation/api/NamespaceDocItem.md b/documentation/api/NamespaceDocItem.md deleted file mode 100644 index 5df92ac1..00000000 --- a/documentation/api/NamespaceDocItem.md +++ /dev/null @@ -1,16 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models') - -## NamespaceDocItem Class - -Represents a namespace documentation. - -```csharp -public sealed class NamespaceDocItem : DefaultDocumentation.Models.DocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 NamespaceDocItem - -| Constructors | | -| :--- | :--- | -| [NamespaceDocItem(AssemblyDocItem, string, XElement)](NamespaceDocItem.NamespaceDocItem(AssemblyDocItem,string,XElement).md 'DefaultDocumentation.Models.NamespaceDocItem.NamespaceDocItem(DefaultDocumentation.Models.AssemblyDocItem, string, System.Xml.Linq.XElement)') | Initialize a new instance of the [NamespaceDocItem](NamespaceDocItem.md 'DefaultDocumentation.Models.NamespaceDocItem') type. | diff --git a/documentation/api/OperatorDocItem.Method.md b/documentation/api/OperatorDocItem.Method.md deleted file mode 100644 index 8c76fba4..00000000 --- a/documentation/api/OperatorDocItem.Method.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[OperatorDocItem](OperatorDocItem.md 'DefaultDocumentation.Models.Members.OperatorDocItem') - -## OperatorDocItem.Method Property - -Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') of the current instance. - -```csharp -public IMethod Method { get; } -``` - -#### Property Value -[IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') \ No newline at end of file diff --git a/documentation/api/OperatorDocItem.OperatorDocItem(TypeDocItem,IMethod,XElement).md b/documentation/api/OperatorDocItem.OperatorDocItem(TypeDocItem,IMethod,XElement).md deleted file mode 100644 index 50abb2d6..00000000 --- a/documentation/api/OperatorDocItem.OperatorDocItem(TypeDocItem,IMethod,XElement).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[OperatorDocItem](OperatorDocItem.md 'DefaultDocumentation.Models.Members.OperatorDocItem') - -## OperatorDocItem(TypeDocItem, IMethod, XElement) Constructor - -Initialize a new instance of the [OperatorDocItem](OperatorDocItem.md 'DefaultDocumentation.Models.Members.OperatorDocItem') type. - -```csharp -public OperatorDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, IMethod method, System.Xml.Linq.XElement? documentation); -``` -#### Parameters - - - -`parent` [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') - -The [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') parent type of the operator. - - - -`method` [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') - -The [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') of the operator. - - - -`documentation` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') documentation element of the operator. \ No newline at end of file diff --git a/documentation/api/OperatorDocItem.Parameters.md b/documentation/api/OperatorDocItem.Parameters.md deleted file mode 100644 index 51dcd571..00000000 --- a/documentation/api/OperatorDocItem.Parameters.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[OperatorDocItem](OperatorDocItem.md 'DefaultDocumentation.Models.Members.OperatorDocItem') - -## OperatorDocItem.Parameters Property - -Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. - -```csharp -public System.Collections.Generic.IEnumerable Parameters { get; } -``` - -Implements [Parameters](IParameterizedDocItem.Parameters.md 'DefaultDocumentation.Models.IParameterizedDocItem.Parameters') - -#### Property Value -[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') \ No newline at end of file diff --git a/documentation/api/OperatorDocItem.md b/documentation/api/OperatorDocItem.md deleted file mode 100644 index e1fb1ccb..00000000 --- a/documentation/api/OperatorDocItem.md +++ /dev/null @@ -1,24 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members') - -## OperatorDocItem Class - -Represents an operator [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') documentation. - -```csharp -public sealed class OperatorDocItem : DefaultDocumentation.Models.EntityDocItem, -DefaultDocumentation.Models.IParameterizedDocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 [EntityDocItem](EntityDocItem.md 'DefaultDocumentation.Models.EntityDocItem') 🡒 OperatorDocItem - -Implements [IParameterizedDocItem](IParameterizedDocItem.md 'DefaultDocumentation.Models.IParameterizedDocItem') - -| Constructors | | -| :--- | :--- | -| [OperatorDocItem(TypeDocItem, IMethod, XElement)](OperatorDocItem.OperatorDocItem(TypeDocItem,IMethod,XElement).md 'DefaultDocumentation.Models.Members.OperatorDocItem.OperatorDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IMethod, System.Xml.Linq.XElement)') | Initialize a new instance of the [OperatorDocItem](OperatorDocItem.md 'DefaultDocumentation.Models.Members.OperatorDocItem') type. | - -| Properties | | -| :--- | :--- | -| [Method](OperatorDocItem.Method.md 'DefaultDocumentation.Models.Members.OperatorDocItem.Method') | Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') of the current instance. | -| [Parameters](OperatorDocItem.Parameters.md 'DefaultDocumentation.Models.Members.OperatorDocItem.Parameters') | Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. | diff --git a/documentation/api/ParameterDocItem.Parameter.md b/documentation/api/ParameterDocItem.Parameter.md deleted file mode 100644 index b4945554..00000000 --- a/documentation/api/ParameterDocItem.Parameter.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Parameters](index.md#DefaultDocumentation.Models.Parameters 'DefaultDocumentation.Models.Parameters').[ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') - -## ParameterDocItem.Parameter Property - -Gets the [IParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IParameter') of the current instance. - -```csharp -public IParameter Parameter { get; } -``` - -#### Property Value -[IParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IParameter') \ No newline at end of file diff --git a/documentation/api/ParameterDocItem.md b/documentation/api/ParameterDocItem.md deleted file mode 100644 index a514a3de..00000000 --- a/documentation/api/ParameterDocItem.md +++ /dev/null @@ -1,16 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Parameters](index.md#DefaultDocumentation.Models.Parameters 'DefaultDocumentation.Models.Parameters') - -## ParameterDocItem Class - -Represents an [IParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IParameter') documentation. - -```csharp -public sealed class ParameterDocItem : DefaultDocumentation.Models.DocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 ParameterDocItem - -| Properties | | -| :--- | :--- | -| [Parameter](ParameterDocItem.Parameter.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem.Parameter') | Gets the [IParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IParameter') of the current instance. | diff --git a/documentation/api/PropertyDocItem.Parameters.md b/documentation/api/PropertyDocItem.Parameters.md deleted file mode 100644 index 2fe6f1b3..00000000 --- a/documentation/api/PropertyDocItem.Parameters.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[PropertyDocItem](PropertyDocItem.md 'DefaultDocumentation.Models.Members.PropertyDocItem') - -## PropertyDocItem.Parameters Property - -Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. - -```csharp -public System.Collections.Generic.IEnumerable Parameters { get; } -``` - -Implements [Parameters](IParameterizedDocItem.Parameters.md 'DefaultDocumentation.Models.IParameterizedDocItem.Parameters') - -#### Property Value -[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') \ No newline at end of file diff --git a/documentation/api/PropertyDocItem.Property.md b/documentation/api/PropertyDocItem.Property.md deleted file mode 100644 index 63271ef0..00000000 --- a/documentation/api/PropertyDocItem.Property.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[PropertyDocItem](PropertyDocItem.md 'DefaultDocumentation.Models.Members.PropertyDocItem') - -## PropertyDocItem.Property Property - -Gets the [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IProperty') of the current instance. - -```csharp -public IProperty Property { get; } -``` - -#### Property Value -[IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IProperty') \ No newline at end of file diff --git a/documentation/api/PropertyDocItem.PropertyDocItem(TypeDocItem,IProperty,XElement).md b/documentation/api/PropertyDocItem.PropertyDocItem(TypeDocItem,IProperty,XElement).md deleted file mode 100644 index ff1fcf3a..00000000 --- a/documentation/api/PropertyDocItem.PropertyDocItem(TypeDocItem,IProperty,XElement).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members').[PropertyDocItem](PropertyDocItem.md 'DefaultDocumentation.Models.Members.PropertyDocItem') - -## PropertyDocItem(TypeDocItem, IProperty, XElement) Constructor - -Initialize a new instance of the [PropertyDocItem](PropertyDocItem.md 'DefaultDocumentation.Models.Members.PropertyDocItem') type. - -```csharp -public PropertyDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, IProperty property, System.Xml.Linq.XElement? documentation); -``` -#### Parameters - - - -`parent` [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') - -The [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') parent type of the property. - - - -`property` [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IProperty') - -The [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IProperty') of the property. - - - -`documentation` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') documentation element of the property. \ No newline at end of file diff --git a/documentation/api/PropertyDocItem.md b/documentation/api/PropertyDocItem.md deleted file mode 100644 index c46ac7dd..00000000 --- a/documentation/api/PropertyDocItem.md +++ /dev/null @@ -1,24 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Members](index.md#DefaultDocumentation.Models.Members 'DefaultDocumentation.Models.Members') - -## PropertyDocItem Class - -Represents an [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IProperty') documentation. - -```csharp -public sealed class PropertyDocItem : DefaultDocumentation.Models.EntityDocItem, -DefaultDocumentation.Models.IParameterizedDocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 [EntityDocItem](EntityDocItem.md 'DefaultDocumentation.Models.EntityDocItem') 🡒 PropertyDocItem - -Implements [IParameterizedDocItem](IParameterizedDocItem.md 'DefaultDocumentation.Models.IParameterizedDocItem') - -| Constructors | | -| :--- | :--- | -| [PropertyDocItem(TypeDocItem, IProperty, XElement)](PropertyDocItem.PropertyDocItem(TypeDocItem,IProperty,XElement).md 'DefaultDocumentation.Models.Members.PropertyDocItem.PropertyDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IProperty, System.Xml.Linq.XElement)') | Initialize a new instance of the [PropertyDocItem](PropertyDocItem.md 'DefaultDocumentation.Models.Members.PropertyDocItem') type. | - -| Properties | | -| :--- | :--- | -| [Parameters](PropertyDocItem.Parameters.md 'DefaultDocumentation.Models.Members.PropertyDocItem.Parameters') | Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. | -| [Property](PropertyDocItem.Property.md 'DefaultDocumentation.Models.Members.PropertyDocItem.Property') | Gets the [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IProperty') of the current instance. | diff --git a/documentation/api/StructDocItem.StructDocItem(DocItem,ITypeDefinition,XElement).md b/documentation/api/StructDocItem.StructDocItem(DocItem,ITypeDefinition,XElement).md deleted file mode 100644 index 7fd5f2d9..00000000 --- a/documentation/api/StructDocItem.StructDocItem(DocItem,ITypeDefinition,XElement).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Types](index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation.Models.Types').[StructDocItem](StructDocItem.md 'DefaultDocumentation.Models.Types.StructDocItem') - -## StructDocItem(DocItem, ITypeDefinition, XElement) Constructor - -Initialize a new instance of the [StructDocItem](StructDocItem.md 'DefaultDocumentation.Models.Types.StructDocItem') type. - -```csharp -public StructDocItem(DefaultDocumentation.Models.DocItem parent, ITypeDefinition type, System.Xml.Linq.XElement? documentation); -``` -#### Parameters - - - -`parent` [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') parent type or namespace of the class. - - - -`type` [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') - -The [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') of the struct. - - - -`documentation` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') documentation element of the struct. \ No newline at end of file diff --git a/documentation/api/StructDocItem.md b/documentation/api/StructDocItem.md deleted file mode 100644 index 70d250bc..00000000 --- a/documentation/api/StructDocItem.md +++ /dev/null @@ -1,16 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Types](index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation.Models.Types') - -## StructDocItem Class - -Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') of the [TypeKind.Struct](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.TypeKind.Struct') kind documentation. - -```csharp -public sealed class StructDocItem : DefaultDocumentation.Models.Types.TypeDocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 [EntityDocItem](EntityDocItem.md 'DefaultDocumentation.Models.EntityDocItem') 🡒 [TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') 🡒 StructDocItem - -| Constructors | | -| :--- | :--- | -| [StructDocItem(DocItem, ITypeDefinition, XElement)](StructDocItem.StructDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation.Models.Types.StructDocItem.StructDocItem(DefaultDocumentation.Models.DocItem, ITypeDefinition, System.Xml.Linq.XElement)') | Initialize a new instance of the [StructDocItem](StructDocItem.md 'DefaultDocumentation.Models.Types.StructDocItem') type. | diff --git a/documentation/api/TypeDocItem.Type.md b/documentation/api/TypeDocItem.Type.md deleted file mode 100644 index 19146d78..00000000 --- a/documentation/api/TypeDocItem.Type.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Types](index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation.Models.Types').[TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') - -## TypeDocItem.Type Property - -Gets the [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') of the current instance. - -```csharp -public ITypeDefinition Type { get; } -``` - -#### Property Value -[ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') \ No newline at end of file diff --git a/documentation/api/TypeDocItem.TypeParameters.md b/documentation/api/TypeDocItem.TypeParameters.md deleted file mode 100644 index 382838b8..00000000 --- a/documentation/api/TypeDocItem.TypeParameters.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Types](index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation.Models.Types').[TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem') - -## TypeDocItem.TypeParameters Property - -Gets the [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') of this instance. - -```csharp -public System.Collections.Generic.IEnumerable TypeParameters { get; } -``` - -Implements [TypeParameters](ITypeParameterizedDocItem.TypeParameters.md 'DefaultDocumentation.Models.ITypeParameterizedDocItem.TypeParameters') - -#### Property Value -[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') \ No newline at end of file diff --git a/documentation/api/TypeDocItem.md b/documentation/api/TypeDocItem.md deleted file mode 100644 index f633ea94..00000000 --- a/documentation/api/TypeDocItem.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Types](index.md#DefaultDocumentation.Models.Types 'DefaultDocumentation.Models.Types') - -## TypeDocItem Class - -Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') documentation. - -```csharp -public abstract class TypeDocItem : DefaultDocumentation.Models.EntityDocItem, -DefaultDocumentation.Models.ITypeParameterizedDocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 [EntityDocItem](EntityDocItem.md 'DefaultDocumentation.Models.EntityDocItem') 🡒 TypeDocItem - -Derived -↳ [ClassDocItem](ClassDocItem.md 'DefaultDocumentation.Models.Types.ClassDocItem') -↳ [DelegateDocItem](DelegateDocItem.md 'DefaultDocumentation.Models.Types.DelegateDocItem') -↳ [EnumDocItem](EnumDocItem.md 'DefaultDocumentation.Models.Types.EnumDocItem') -↳ [InterfaceDocItem](InterfaceDocItem.md 'DefaultDocumentation.Models.Types.InterfaceDocItem') -↳ [StructDocItem](StructDocItem.md 'DefaultDocumentation.Models.Types.StructDocItem') - -Implements [ITypeParameterizedDocItem](ITypeParameterizedDocItem.md 'DefaultDocumentation.Models.ITypeParameterizedDocItem') - -| Properties | | -| :--- | :--- | -| [Type](TypeDocItem.Type.md 'DefaultDocumentation.Models.Types.TypeDocItem.Type') | Gets the [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') of the current instance. | -| [TypeParameters](TypeDocItem.TypeParameters.md 'DefaultDocumentation.Models.Types.TypeDocItem.TypeParameters') | Gets the [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') of this instance. | diff --git a/documentation/api/TypeParameterDocItem.TypeParameter.md b/documentation/api/TypeParameterDocItem.TypeParameter.md deleted file mode 100644 index 8acaf736..00000000 --- a/documentation/api/TypeParameterDocItem.TypeParameter.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Parameters](index.md#DefaultDocumentation.Models.Parameters 'DefaultDocumentation.Models.Parameters').[TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') - -## TypeParameterDocItem.TypeParameter Property - -Gets the [ITypeParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeParameter') of the current instance. - -```csharp -public ITypeParameter TypeParameter { get; } -``` - -#### Property Value -[ITypeParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeParameter') \ No newline at end of file diff --git a/documentation/api/TypeParameterDocItem.md b/documentation/api/TypeParameterDocItem.md deleted file mode 100644 index 33120433..00000000 --- a/documentation/api/TypeParameterDocItem.md +++ /dev/null @@ -1,16 +0,0 @@ -#### [DefaultDocumentation.Api](index.md 'index') -### [DefaultDocumentation.Models.Parameters](index.md#DefaultDocumentation.Models.Parameters 'DefaultDocumentation.Models.Parameters') - -## TypeParameterDocItem Class - -Represents an [ITypeParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeParameter') documentation. - -```csharp -public sealed class TypeParameterDocItem : DefaultDocumentation.Models.DocItem -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') 🡒 TypeParameterDocItem - -| Properties | | -| :--- | :--- | -| [TypeParameter](TypeParameterDocItem.TypeParameter.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem.TypeParameter') | Gets the [ITypeParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeParameter') of the current instance. | diff --git a/documentation/api/index.md b/documentation/api/index.md index be3d6067..1793c1b9 100644 --- a/documentation/api/index.md +++ b/documentation/api/index.md @@ -1,190 +1,214 @@ -#### [DefaultDocumentation.Api](index.md 'index') +#### [DefaultDocumentation\.Api](index.md 'index') -## DefaultDocumentation.Api Assembly +## DefaultDocumentation\.Api Assembly -This is the full API documentation of DefaultDocumentation. +This is the full API documentation of DefaultDocumentation\. ### Namespaces ## DefaultDocumentation Namespace -- **[IGeneralContextExtension](IGeneralContextExtension.md 'DefaultDocumentation.IGeneralContextExtension')** `Class` Provides extension methods on the [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') type. - - **[GetContext(this IGeneralContext, DocItem)](IGeneralContextExtension.GetContext(thisIGeneralContext,DocItem).md 'DefaultDocumentation.IGeneralContextExtension.GetContext(this DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)')** `Method` Gets the specific [IContext](IContext.md 'DefaultDocumentation.IContext') for the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') kind. - - **[GetSetting<T>(this IGeneralContext, DocItem, Func<IContext,T>)](IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,DocItem,Func_IContext,T_).md 'DefaultDocumentation.IGeneralContextExtension.GetSetting(this DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem, System.Func)')** `Method` Gets a data from the specific [IContext](IContext.md 'DefaultDocumentation.IContext') of the provided [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') if it exists, else from the [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext'). - - **[GetSetting<T>(this IGeneralContext, Type, Func<IContext,T>)](IGeneralContextExtension.GetSetting_T_(thisIGeneralContext,Type,Func_IContext,T_).md 'DefaultDocumentation.IGeneralContextExtension.GetSetting(this DefaultDocumentation.IGeneralContext, System.Type, System.Func)')** `Method` Gets a data from the specific [IContext](IContext.md 'DefaultDocumentation.IContext') of the provided [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type') if it exists, else from the [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext'). - - **[GetUrl(this IGeneralContext, DocItem)](IGeneralContextExtension.GetUrl(thisIGeneralContext,DocItem).md 'DefaultDocumentation.IGeneralContextExtension.GetUrl(this DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)')** `Method` Gets the url of the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem'). -- **[IContext](IContext.md 'DefaultDocumentation.IContext')** `Interface` Exposes settings used to generate documentation. - - **[FileNameFactory](IContext.FileNameFactory.md 'DefaultDocumentation.IContext.FileNameFactory')** `Property` Gets the [IFileNameFactory](IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') to use to generate a file for a documentation page. - - **[Sections](IContext.Sections.md 'DefaultDocumentation.IContext.Sections')** `Property` Gets the [ISection](ISection.md 'DefaultDocumentation.Api.ISection') to use to generate a documentation page. - - **[GetSetting<T>(string)](IContext.GetSetting_T_(string).md 'DefaultDocumentation.IContext.GetSetting(string)')** `Method` Gets a T setting with the given name. -- **[IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext')** `Interface` Exposes settings used to generate documentation. - - **[Elements](IGeneralContext.Elements.md 'DefaultDocumentation.IGeneralContext.Elements')** `Property` Gets the [IElement](IElement.md 'DefaultDocumentation.Api.IElement') used to render specific [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') from the documentation. - - **[Items](IGeneralContext.Items.md 'DefaultDocumentation.IGeneralContext.Items')** `Property` Gets all the [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') known by this documentation generation context. - - **[Settings](IGeneralContext.Settings.md 'DefaultDocumentation.IGeneralContext.Settings')** `Property` Gets the [ISettings](ISettings.md 'DefaultDocumentation.ISettings') of this documentation generation context. - - **[GetContext(Type)](IGeneralContext.GetContext(Type).md 'DefaultDocumentation.IGeneralContext.GetContext(System.Type)')** `Method` Gets the specific [IContext](IContext.md 'DefaultDocumentation.IContext') for the given [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type'). - - **[GetFileName(DocItem)](IGeneralContext.GetFileName(DocItem).md 'DefaultDocumentation.IGeneralContext.GetFileName(DefaultDocumentation.Models.DocItem)')** `Method` Gets the file name for the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[GetUrl(string)](IGeneralContext.GetUrl(string).md 'DefaultDocumentation.IGeneralContext.GetUrl(string)')** `Method` Gets the url of the given id. -- **[ISettings](ISettings.md 'DefaultDocumentation.ISettings')** `Interface` Exposes all the settings of the documentation generation process. - - **[AssemblyFile](ISettings.AssemblyFile.md 'DefaultDocumentation.ISettings.AssemblyFile')** `Property` Gets the assembly file for which the documentation is being generated. - - **[AssemblyPageName](ISettings.AssemblyPageName.md 'DefaultDocumentation.ISettings.AssemblyPageName')** `Property` Gets the name of the assembly page name. - - **[DocumentationFile](ISettings.DocumentationFile.md 'DefaultDocumentation.ISettings.DocumentationFile')** `Property` Gets the xml documentation file of the [AssemblyFile](ISettings.AssemblyFile.md 'DefaultDocumentation.ISettings.AssemblyFile'). - - **[ExternLinksFiles](ISettings.ExternLinksFiles.md 'DefaultDocumentation.ISettings.ExternLinksFiles')** `Property` Gets the links files of external items which are not part of the dotnet api. - - **[GeneratedAccessModifiers](ISettings.GeneratedAccessModifiers.md 'DefaultDocumentation.ISettings.GeneratedAccessModifiers')** `Property` Gets the [GeneratedAccessModifiers](GeneratedAccessModifiers.md 'DefaultDocumentation.GeneratedAccessModifiers') flags stating which access modifiers should have their documentation generated. - - **[GeneratedPages](ISettings.GeneratedPages.md 'DefaultDocumentation.ISettings.GeneratedPages')** `Property` Gets the [GeneratedPages](GeneratedPages.md 'DefaultDocumentation.GeneratedPages') flags stating which kind should have their own page and which should be inlined. - - **[IncludeUndocumentedItems](ISettings.IncludeUndocumentedItems.md 'DefaultDocumentation.ISettings.IncludeUndocumentedItems')** `Property` Gets wether item with no xml documentation should have their documentation generated or not. - - **[LinksBaseUrl](ISettings.LinksBaseUrl.md 'DefaultDocumentation.ISettings.LinksBaseUrl')** `Property` Gets the base url to prefix item url with when generating the links output file. - - **[LinksOutputFile](ISettings.LinksOutputFile.md 'DefaultDocumentation.ISettings.LinksOutputFile')** `Property` Gets the file name where all the url of the generated documentation should be writen to, to be used for referencing documentation generation. - - **[Logger](ISettings.Logger.md 'DefaultDocumentation.ISettings.Logger')** `Property` Gets the [NLog.ILogger](https://docs.microsoft.com/en-us/dotnet/api/NLog.ILogger 'NLog.ILogger') of the process. - - **[OutputDirectory](ISettings.OutputDirectory.md 'DefaultDocumentation.ISettings.OutputDirectory')** `Property` Gets the output directory where the documentation is being generated. - - **[ProjectDirectory](ISettings.ProjectDirectory.md 'DefaultDocumentation.ISettings.ProjectDirectory')** `Property` Gets the root project directory where the sources of the [AssemblyFile](ISettings.AssemblyFile.md 'DefaultDocumentation.ISettings.AssemblyFile') are. -- **[GeneratedAccessModifiers](GeneratedAccessModifiers.md 'DefaultDocumentation.GeneratedAccessModifiers')** `Enum` Specifies a combination of access modifiers. - - **[Default](GeneratedAccessModifiers.md#DefaultDocumentation.GeneratedAccessModifiers.Default 'DefaultDocumentation.GeneratedAccessModifiers.Default')** `Field` Generates documentation for all access modifiers. - - **[Internal](GeneratedAccessModifiers.md#DefaultDocumentation.GeneratedAccessModifiers.Internal 'DefaultDocumentation.GeneratedAccessModifiers.Internal')** `Field` Generates documentation for 'internal' access modifier. - - **[Private](GeneratedAccessModifiers.md#DefaultDocumentation.GeneratedAccessModifiers.Private 'DefaultDocumentation.GeneratedAccessModifiers.Private')** `Field` Generates documentation for 'private' access modifier. - - **[PrivateProtected](GeneratedAccessModifiers.md#DefaultDocumentation.GeneratedAccessModifiers.PrivateProtected 'DefaultDocumentation.GeneratedAccessModifiers.PrivateProtected')** `Field` Generates documentation for 'private protected' access modifier. - - **[Protected](GeneratedAccessModifiers.md#DefaultDocumentation.GeneratedAccessModifiers.Protected 'DefaultDocumentation.GeneratedAccessModifiers.Protected')** `Field` Generates documentation for 'protected' access modifier. - - **[ProtectedInternal](GeneratedAccessModifiers.md#DefaultDocumentation.GeneratedAccessModifiers.ProtectedInternal 'DefaultDocumentation.GeneratedAccessModifiers.ProtectedInternal')** `Field` Generates documentation for 'protected internal' access modifier. - - **[Public](GeneratedAccessModifiers.md#DefaultDocumentation.GeneratedAccessModifiers.Public 'DefaultDocumentation.GeneratedAccessModifiers.Public')** `Field` Generates documentation for 'public' access modifier. -- **[GeneratedPages](GeneratedPages.md 'DefaultDocumentation.GeneratedPages')** `Enum` Specifies a combination of page kinds. - - **[Assembly](GeneratedPages.md#DefaultDocumentation.GeneratedPages.Assembly 'DefaultDocumentation.GeneratedPages.Assembly')** `Field` Generates documentation page for the assembly. - - **[Classes](GeneratedPages.md#DefaultDocumentation.GeneratedPages.Classes 'DefaultDocumentation.GeneratedPages.Classes')** `Field` Generates documentation pages for the classes. - - **[Constructors](GeneratedPages.md#DefaultDocumentation.GeneratedPages.Constructors 'DefaultDocumentation.GeneratedPages.Constructors')** `Field` Generates documentation pages for the constructors. - - **[Default](GeneratedPages.md#DefaultDocumentation.GeneratedPages.Default 'DefaultDocumentation.GeneratedPages.Default')** `Field` Generates all documentation page kinds. - - **[Delegates](GeneratedPages.md#DefaultDocumentation.GeneratedPages.Delegates 'DefaultDocumentation.GeneratedPages.Delegates')** `Field` Generates documentation pages for the delegates. - - **[Enums](GeneratedPages.md#DefaultDocumentation.GeneratedPages.Enums 'DefaultDocumentation.GeneratedPages.Enums')** `Field` Generates documentation pages for the enums. - - **[Events](GeneratedPages.md#DefaultDocumentation.GeneratedPages.Events 'DefaultDocumentation.GeneratedPages.Events')** `Field` Generates documentation pages for the events. - - **[ExplicitInterfaceImplementations](GeneratedPages.md#DefaultDocumentation.GeneratedPages.ExplicitInterfaceImplementations 'DefaultDocumentation.GeneratedPages.ExplicitInterfaceImplementations')** `Field` Generates documentation pages for the explicit interface implementations. - - **[Fields](GeneratedPages.md#DefaultDocumentation.GeneratedPages.Fields 'DefaultDocumentation.GeneratedPages.Fields')** `Field` Generates documentation pages for the fields. - - **[Interfaces](GeneratedPages.md#DefaultDocumentation.GeneratedPages.Interfaces 'DefaultDocumentation.GeneratedPages.Interfaces')** `Field` Generates documentation pages for the interfaces. - - **[Members](GeneratedPages.md#DefaultDocumentation.GeneratedPages.Members 'DefaultDocumentation.GeneratedPages.Members')** `Field` Generates documentation pages for all member kinds (constructor, event, field, method, operator, property, explicit interface implementation). - - **[Methods](GeneratedPages.md#DefaultDocumentation.GeneratedPages.Methods 'DefaultDocumentation.GeneratedPages.Methods')** `Field` Generates documentation pages for the methods. - - **[Namespaces](GeneratedPages.md#DefaultDocumentation.GeneratedPages.Namespaces 'DefaultDocumentation.GeneratedPages.Namespaces')** `Field` Generates documentation pages for the namespaces. - - **[Operators](GeneratedPages.md#DefaultDocumentation.GeneratedPages.Operators 'DefaultDocumentation.GeneratedPages.Operators')** `Field` Generates documentation pages for the operators. - - **[Properties](GeneratedPages.md#DefaultDocumentation.GeneratedPages.Properties 'DefaultDocumentation.GeneratedPages.Properties')** `Field` Generates documentation pages for the properties. - - **[Structs](GeneratedPages.md#DefaultDocumentation.GeneratedPages.Structs 'DefaultDocumentation.GeneratedPages.Structs')** `Field` Generates documentation pages for the structs. - - **[Types](GeneratedPages.md#DefaultDocumentation.GeneratedPages.Types 'DefaultDocumentation.GeneratedPages.Types')** `Field` Generates documentation pages for all type kinds (class, delegate, enum, struct, interface). +- **[IGeneralContextExtensions](DefaultDocumentation/IGeneralContextExtensions/index.md 'DefaultDocumentation\.IGeneralContextExtensions')** `Class` Provides extension methods on the [IGeneralContext](DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') type\. + - **[GetContext\(this IGeneralContext, DocItem\)](DefaultDocumentation/IGeneralContextExtensions/GetContext(thisIGeneralContext,DocItem).md 'DefaultDocumentation\.IGeneralContextExtensions\.GetContext\(this DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the specific [IContext](DefaultDocumentation/IContext/index.md 'DefaultDocumentation\.IContext') for the given [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') kind\. + - **[GetSetting<T>\(this IGeneralContext, DocItem, Func<IContext,T>\)](DefaultDocumentation/IGeneralContextExtensions/GetSetting.md#DefaultDocumentation.IGeneralContextExtensions.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem,System.Func_DefaultDocumentation.IContext,T_) 'DefaultDocumentation\.IGeneralContextExtensions\.GetSetting\\(this DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem, System\.Func\\)')** `Method` Gets a data from the specific [IContext](DefaultDocumentation/IContext/index.md 'DefaultDocumentation\.IContext') of the provided [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') if it exists, else from the [IGeneralContext](DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext')\. + - **[GetSetting<T>\(this IGeneralContext, Type, Func<IContext,T>\)](DefaultDocumentation/IGeneralContextExtensions/GetSetting.md#DefaultDocumentation.IGeneralContextExtensions.GetSetting_T_(thisDefaultDocumentation.IGeneralContext,System.Type,System.Func_DefaultDocumentation.IContext,T_) 'DefaultDocumentation\.IGeneralContextExtensions\.GetSetting\\(this DefaultDocumentation\.IGeneralContext, System\.Type, System\.Func\\)')** `Method` Gets a data from the specific [IContext](DefaultDocumentation/IContext/index.md 'DefaultDocumentation\.IContext') of the provided [System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') if it exists, else from the [IGeneralContext](DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext')\. +- **[IPageContextExtensions](DefaultDocumentation/IPageContextExtensions/index.md 'DefaultDocumentation\.IPageContextExtensions')** `Class` Provides extension methods on the [IPageContext](DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext') type\. + - **[GetUrl\(this IPageContext, DocItem\)](DefaultDocumentation/IPageContextExtensions/GetUrl.md#DefaultDocumentation.IPageContextExtensions.GetUrl(thisDefaultDocumentation.IPageContext,DefaultDocumentation.Models.DocItem) 'DefaultDocumentation\.IPageContextExtensions\.GetUrl\(this DefaultDocumentation\.IPageContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the url of the given [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') in a specific page\. + - **[GetUrl\(this IPageContext, string\)](DefaultDocumentation/IPageContextExtensions/GetUrl.md#DefaultDocumentation.IPageContextExtensions.GetUrl(thisDefaultDocumentation.IPageContext,string) 'DefaultDocumentation\.IPageContextExtensions\.GetUrl\(this DefaultDocumentation\.IPageContext, string\)')** `Method` Gets the url of the given id in a specific page\. +- **[IContext](DefaultDocumentation/IContext/index.md 'DefaultDocumentation\.IContext')** `Interface` Exposes settings used to generate documentation for a given [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') type\. + - **[FileNameFactory](DefaultDocumentation/IContext/FileNameFactory.md 'DefaultDocumentation\.IContext\.FileNameFactory')** `Property` Gets the [IFileNameFactory](DefaultDocumentation/Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory') to use to generate a file for a documentation page\. + - **[Sections](DefaultDocumentation/IContext/Sections.md 'DefaultDocumentation\.IContext\.Sections')** `Property` Gets the [ISection](DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') to use to generate a documentation page\. + - **[GetSetting<T>\(string\)](DefaultDocumentation/IContext/GetSetting_T_(string).md 'DefaultDocumentation\.IContext\.GetSetting\\(string\)')** `Method` Gets a T setting with the given name\. +- **[IDocItemsContext](DefaultDocumentation/IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext')** `Interface` Exposes properties and methods used to impact the [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') that will be generated, used by [IDocItemGenerator](DefaultDocumentation/Api/IDocItemGenerator/index.md 'DefaultDocumentation\.Api\.IDocItemGenerator') + - **[Items](DefaultDocumentation/IDocItemsContext/Items.md 'DefaultDocumentation\.IDocItemsContext\.Items')** `Property` Gets all the [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') known by this documentation generation context\. + - **[ItemsWithOwnPage](DefaultDocumentation/IDocItemsContext/ItemsWithOwnPage.md 'DefaultDocumentation\.IDocItemsContext\.ItemsWithOwnPage')** `Property` Gets all the [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') that should generate their own documentation page\. + - **[Settings](DefaultDocumentation/IDocItemsContext/Settings.md 'DefaultDocumentation\.IDocItemsContext\.Settings')** `Property` Gets the [ISettings](DefaultDocumentation/ISettings/index.md 'DefaultDocumentation\.ISettings') of this documentation generation context\. + - **[GetSetting<T>\(string\)](DefaultDocumentation/IDocItemsContext/GetSetting.md#DefaultDocumentation.IDocItemsContext.GetSetting_T_(string) 'DefaultDocumentation\.IDocItemsContext\.GetSetting\\(string\)')** `Method` Gets a T setting with the given name\. + - **[GetSetting<T>\(Type, string\)](DefaultDocumentation/IDocItemsContext/GetSetting.md#DefaultDocumentation.IDocItemsContext.GetSetting_T_(System.Type,string) 'DefaultDocumentation\.IDocItemsContext\.GetSetting\\(System\.Type, string\)')** `Method` Gets a T setting with the given name for the given [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')[System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type')\. +- **[IGeneralContext](DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext')** `Interface` Exposes settings used to generate documentation\. + - **[Elements](DefaultDocumentation/IGeneralContext/Elements.md 'DefaultDocumentation\.IGeneralContext\.Elements')** `Property` Gets the [IElement](DefaultDocumentation/Api/IElement/index.md 'DefaultDocumentation\.Api\.IElement') used to render specific [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') from the documentation\. + - **[Items](DefaultDocumentation/IGeneralContext/Items.md 'DefaultDocumentation\.IGeneralContext\.Items')** `Property` Gets all the [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') known by this documentation generation context\. + - **[ItemsWithOwnPage](DefaultDocumentation/IGeneralContext/ItemsWithOwnPage.md 'DefaultDocumentation\.IGeneralContext\.ItemsWithOwnPage')** `Property` Gets all the [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') that should generate their own documentation page\. + - **[Settings](DefaultDocumentation/IGeneralContext/Settings.md 'DefaultDocumentation\.IGeneralContext\.Settings')** `Property` Gets the [ISettings](DefaultDocumentation/ISettings/index.md 'DefaultDocumentation\.ISettings') of this documentation generation context\. + - **[UrlFactories](DefaultDocumentation/IGeneralContext/UrlFactories.md 'DefaultDocumentation\.IGeneralContext\.UrlFactories')** `Property` Gets the [IUrlFactory](DefaultDocumentation/Api/IUrlFactory/index.md 'DefaultDocumentation\.Api\.IUrlFactory') used to create the documentation urls\. + - **[GetContext\(Type\)](DefaultDocumentation/IGeneralContext/GetContext(Type).md 'DefaultDocumentation\.IGeneralContext\.GetContext\(System\.Type\)')** `Method` Gets the specific [IContext](DefaultDocumentation/IContext/index.md 'DefaultDocumentation\.IContext') for the given [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')[System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type')\. + - **[GetFileName\(DocItem\)](DefaultDocumentation/IGeneralContext/GetFileName(DocItem).md 'DefaultDocumentation\.IGeneralContext\.GetFileName\(DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the file name for the given [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. +- **[IPageContext](DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext')** `Interface` Exposes settings used to generate documentation for a specific [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[DocItem](DefaultDocumentation/IPageContext/DocItem.md 'DefaultDocumentation\.IPageContext\.DocItem')** `Property` Gets the [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which the documentation is being generated\. + - **[this\[string\]](DefaultDocumentation/IPageContext/this[string].md 'DefaultDocumentation\.IPageContext\.this\[string\]')** `Property` Gets or sets extra data for the current [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') documentation generation\. +- **[ISettings](DefaultDocumentation/ISettings/index.md 'DefaultDocumentation\.ISettings')** `Interface` Exposes all the settings of the documentation generation process\. + - **[AssemblyFile](DefaultDocumentation/ISettings/AssemblyFile.md 'DefaultDocumentation\.ISettings\.AssemblyFile')** `Property` Gets the assembly file for which the documentation is being generated\. + - **[AssemblyPageName](DefaultDocumentation/ISettings/AssemblyPageName.md 'DefaultDocumentation\.ISettings\.AssemblyPageName')** `Property` Gets the name of the assembly page name\. + - **[DocumentationFile](DefaultDocumentation/ISettings/DocumentationFile.md 'DefaultDocumentation\.ISettings\.DocumentationFile')** `Property` Gets the xml documentation file of the [AssemblyFile](DefaultDocumentation/ISettings/AssemblyFile.md 'DefaultDocumentation\.ISettings\.AssemblyFile')\. + - **[ExternLinksFiles](DefaultDocumentation/ISettings/ExternLinksFiles.md 'DefaultDocumentation\.ISettings\.ExternLinksFiles')** `Property` Gets the links files of external items which are not part of the dotnet api\. + - **[GeneratedAccessModifiers](DefaultDocumentation/ISettings/GeneratedAccessModifiers.md 'DefaultDocumentation\.ISettings\.GeneratedAccessModifiers')** `Property` Gets the [GeneratedAccessModifiers](DefaultDocumentation/GeneratedAccessModifiers/index.md 'DefaultDocumentation\.GeneratedAccessModifiers') flags stating which access modifiers should have their documentation generated\. + - **[GeneratedPages](DefaultDocumentation/ISettings/GeneratedPages.md 'DefaultDocumentation\.ISettings\.GeneratedPages')** `Property` Gets the [GeneratedPages](DefaultDocumentation/GeneratedPages/index.md 'DefaultDocumentation\.GeneratedPages') flags stating which kind should have their own page and which should be inlined\. + - **[IncludeUndocumentedItems](DefaultDocumentation/ISettings/IncludeUndocumentedItems.md 'DefaultDocumentation\.ISettings\.IncludeUndocumentedItems')** `Property` Gets wether item with no xml documentation should have their documentation generated or not\. + - **[LinksBaseUrl](DefaultDocumentation/ISettings/LinksBaseUrl.md 'DefaultDocumentation\.ISettings\.LinksBaseUrl')** `Property` Gets the base url to prefix item url with when generating the links output file\. + - **[LinksOutputFile](DefaultDocumentation/ISettings/LinksOutputFile.md 'DefaultDocumentation\.ISettings\.LinksOutputFile')** `Property` Gets the file name where all the url of the generated documentation should be writen to, to be used for referencing documentation generation\. + - **[Logger](DefaultDocumentation/ISettings/Logger.md 'DefaultDocumentation\.ISettings\.Logger')** `Property` Gets the [NLog\.ILogger](https://docs.microsoft.com/en-us/dotnet/api/NLog.ILogger 'NLog\.ILogger') of the process\. + - **[OutputDirectory](DefaultDocumentation/ISettings/OutputDirectory.md 'DefaultDocumentation\.ISettings\.OutputDirectory')** `Property` Gets the output directory where the documentation is being generated\. + - **[ProjectDirectory](DefaultDocumentation/ISettings/ProjectDirectory.md 'DefaultDocumentation\.ISettings\.ProjectDirectory')** `Property` Gets the root project directory where the sources of the [AssemblyFile](DefaultDocumentation/ISettings/AssemblyFile.md 'DefaultDocumentation\.ISettings\.AssemblyFile') are\. +- **[GeneratedAccessModifiers](DefaultDocumentation/GeneratedAccessModifiers/index.md 'DefaultDocumentation\.GeneratedAccessModifiers')** `Enum` Specifies a combination of access modifiers\. + - **[Api](DefaultDocumentation/GeneratedAccessModifiers/index.md#DefaultDocumentation.GeneratedAccessModifiers.Api 'DefaultDocumentation\.GeneratedAccessModifiers\.Api')** `Field` Generates documentation for 'public', 'protected' and 'protected internal' access modifier\. + - **[Default](DefaultDocumentation/GeneratedAccessModifiers/index.md#DefaultDocumentation.GeneratedAccessModifiers.Default 'DefaultDocumentation\.GeneratedAccessModifiers\.Default')** `Field` Generates documentation for all access modifiers\. + - **[Internal](DefaultDocumentation/GeneratedAccessModifiers/index.md#DefaultDocumentation.GeneratedAccessModifiers.Internal 'DefaultDocumentation\.GeneratedAccessModifiers\.Internal')** `Field` Generates documentation for 'internal' access modifier\. + - **[Private](DefaultDocumentation/GeneratedAccessModifiers/index.md#DefaultDocumentation.GeneratedAccessModifiers.Private 'DefaultDocumentation\.GeneratedAccessModifiers\.Private')** `Field` Generates documentation for 'private' access modifier\. + - **[PrivateProtected](DefaultDocumentation/GeneratedAccessModifiers/index.md#DefaultDocumentation.GeneratedAccessModifiers.PrivateProtected 'DefaultDocumentation\.GeneratedAccessModifiers\.PrivateProtected')** `Field` Generates documentation for 'private protected' access modifier\. + - **[Protected](DefaultDocumentation/GeneratedAccessModifiers/index.md#DefaultDocumentation.GeneratedAccessModifiers.Protected 'DefaultDocumentation\.GeneratedAccessModifiers\.Protected')** `Field` Generates documentation for 'protected' access modifier\. + - **[ProtectedInternal](DefaultDocumentation/GeneratedAccessModifiers/index.md#DefaultDocumentation.GeneratedAccessModifiers.ProtectedInternal 'DefaultDocumentation\.GeneratedAccessModifiers\.ProtectedInternal')** `Field` Generates documentation for 'protected internal' access modifier\. + - **[Public](DefaultDocumentation/GeneratedAccessModifiers/index.md#DefaultDocumentation.GeneratedAccessModifiers.Public 'DefaultDocumentation\.GeneratedAccessModifiers\.Public')** `Field` Generates documentation for 'public' access modifier\. +- **[GeneratedPages](DefaultDocumentation/GeneratedPages/index.md 'DefaultDocumentation\.GeneratedPages')** `Enum` Specifies a combination of page kinds\. + - **[Assembly](DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Assembly 'DefaultDocumentation\.GeneratedPages\.Assembly')** `Field` Generates documentation page for the assembly\. + - **[Classes](DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Classes 'DefaultDocumentation\.GeneratedPages\.Classes')** `Field` Generates documentation pages for the classes\. + - **[Constructors](DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Constructors 'DefaultDocumentation\.GeneratedPages\.Constructors')** `Field` Generates documentation pages for the constructors\. + - **[Default](DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Default 'DefaultDocumentation\.GeneratedPages\.Default')** `Field` Generates all documentation page kinds\. + - **[Delegates](DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Delegates 'DefaultDocumentation\.GeneratedPages\.Delegates')** `Field` Generates documentation pages for the delegates\. + - **[Enums](DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Enums 'DefaultDocumentation\.GeneratedPages\.Enums')** `Field` Generates documentation pages for the enums\. + - **[Events](DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Events 'DefaultDocumentation\.GeneratedPages\.Events')** `Field` Generates documentation pages for the events\. + - **[ExplicitInterfaceImplementations](DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.ExplicitInterfaceImplementations 'DefaultDocumentation\.GeneratedPages\.ExplicitInterfaceImplementations')** `Field` Generates documentation pages for the explicit interface implementations\. + - **[Fields](DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Fields 'DefaultDocumentation\.GeneratedPages\.Fields')** `Field` Generates documentation pages for the fields\. + - **[Interfaces](DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Interfaces 'DefaultDocumentation\.GeneratedPages\.Interfaces')** `Field` Generates documentation pages for the interfaces\. + - **[Members](DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Members 'DefaultDocumentation\.GeneratedPages\.Members')** `Field` Generates documentation pages for all member kinds \(constructor, event, field, method, operator, property, explicit interface implementation\)\. + - **[Methods](DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Methods 'DefaultDocumentation\.GeneratedPages\.Methods')** `Field` Generates documentation pages for the methods\. + - **[Namespaces](DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Namespaces 'DefaultDocumentation\.GeneratedPages\.Namespaces')** `Field` Generates documentation pages for the namespaces\. + - **[Operators](DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Operators 'DefaultDocumentation\.GeneratedPages\.Operators')** `Field` Generates documentation pages for the operators\. + - **[Properties](DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Properties 'DefaultDocumentation\.GeneratedPages\.Properties')** `Field` Generates documentation pages for the properties\. + - **[Structs](DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Structs 'DefaultDocumentation\.GeneratedPages\.Structs')** `Field` Generates documentation pages for the structs\. + - **[Types](DefaultDocumentation/GeneratedPages/index.md#DefaultDocumentation.GeneratedPages.Types 'DefaultDocumentation\.GeneratedPages\.Types')** `Field` Generates documentation pages for all type kinds \(class, delegate, enum, struct, interface\)\. -## DefaultDocumentation.Api Namespace - -The [DefaultDocumentation.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation.Api') namespace contains interfaces that can be used to add custom features to the documentation generation. -- **[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Api.IWriterExtension')** `Class` Provides extension methods on the [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') type. - - **[Append(this IWriter, XElement)](IWriterExtension.Append(thisIWriter,XElement).md 'DefaultDocumentation.Api.IWriterExtension.Append(this DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)')** `Method` Appends an [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') to a [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') by using the [Elements](IGeneralContext.Elements.md 'DefaultDocumentation.IGeneralContext.Elements') of [Context](IWriter.Context.md 'DefaultDocumentation.Api.IWriter.Context'). - If no [IElement](IElement.md 'DefaultDocumentation.Api.IElement') is found, the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') is appended as text directly. - - **[AppendLine(this IWriter, string)](IWriterExtension.AppendLine(thisIWriter,string).md 'DefaultDocumentation.Api.IWriterExtension.AppendLine(this DefaultDocumentation.Api.IWriter, string)')** `Method` Appends a line after writing the provided [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String'). - - **[TrimEnd(this IWriter, string[])](IWriterExtension.TrimEnd(thisIWriter,string[]).md 'DefaultDocumentation.Api.IWriterExtension.TrimEnd(this DefaultDocumentation.Api.IWriter, string[])')** `Method` Trims from the end of a [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') all the provided values. -- **[IElement](IElement.md 'DefaultDocumentation.Api.IElement')** `Interface` Exposes a method to handle a specific kind of [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') when writing documentation. - - **[Name](IElement.Name.md 'DefaultDocumentation.Api.IElement.Name')** `Property` Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. - - **[Write(IWriter, XElement)](IElement.Write(IWriter,XElement).md 'DefaultDocumentation.Api.IElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)')** `Method` Writes to a [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). -- **[IFileNameFactory](IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory')** `Interface` Exposes methods related to the documentation files cleaning and creation. - - **[Name](IFileNameFactory.Name.md 'DefaultDocumentation.Api.IFileNameFactory.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level. - - **[Clean(IGeneralContext)](IFileNameFactory.Clean(IGeneralContext).md 'DefaultDocumentation.Api.IFileNameFactory.Clean(DefaultDocumentation.IGeneralContext)')** `Method` Cleans the [OutputDirectory](ISettings.OutputDirectory.md 'DefaultDocumentation.ISettings.OutputDirectory') of the previously generated documentation files. - - **[GetFileName(IGeneralContext, DocItem)](IFileNameFactory.GetFileName(IGeneralContext,DocItem).md 'DefaultDocumentation.Api.IFileNameFactory.GetFileName(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)')** `Method` Gets the documentation file name for the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem'). -- **[ISection](ISection.md 'DefaultDocumentation.Api.ISection')** `Interface` Exposes a method to write a specific section when writing documentation. - - **[Name](ISection.Name.md 'DefaultDocumentation.Api.ISection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[IUrlFactory](IUrlFactory.md 'DefaultDocumentation.Api.IUrlFactory')** `Interface` Exposes methods related to the documentation files url creation. - - **[Name](IUrlFactory.Name.md 'DefaultDocumentation.Api.IUrlFactory.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level. - - **[GetUrl(IGeneralContext, string)](IUrlFactory.GetUrl(IGeneralContext,string).md 'DefaultDocumentation.Api.IUrlFactory.GetUrl(DefaultDocumentation.IGeneralContext, string)')** `Method` Gets the url of the given id. Returns null of the instance does not know how to handle the provided id. -- **[IWriter](IWriter.md 'DefaultDocumentation.Api.IWriter')** `Interface` Exposes properties and methods use to generate a documentation file for a specific [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[Context](IWriter.Context.md 'DefaultDocumentation.Api.IWriter.Context')** `Property` Gets the [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - - **[DocItem](IWriter.DocItem.md 'DefaultDocumentation.Api.IWriter.DocItem')** `Property` Gets the [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') for which the documentation is being generated. - - **[Length](IWriter.Length.md 'DefaultDocumentation.Api.IWriter.Length')** `Property` Gets or sets the length of the documentation text currently produced. - - **[this[string]](IWriter.this[string].md 'DefaultDocumentation.Api.IWriter.this[string]')** `Property` Gets or sets extra data for the current [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') documentation generation. - - **[Append(string)](IWriter.Append(string).md 'DefaultDocumentation.Api.IWriter.Append(string)')** `Method` Appends a string at the end of the documentation text. - - **[AppendLine()](IWriter.AppendLine().md 'DefaultDocumentation.Api.IWriter.AppendLine()')** `Method` Appends a [System.Environment.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System.Environment.NewLine') at the end of the documentation text. - - **[EndsWith(string)](IWriter.EndsWith(string).md 'DefaultDocumentation.Api.IWriter.EndsWith(string)')** `Method` Returns whether the documentation text ends with the given string. +## DefaultDocumentation\.Api Namespace + +The [DefaultDocumentation\.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api') namespace contains interfaces that can be used to add custom features to the documentation generation\. +- **[IWriterExtensions](DefaultDocumentation/Api/IWriterExtensions/index.md 'DefaultDocumentation\.Api\.IWriterExtensions')** `Class` Provides extension methods on the [IWriter](DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') type\. + - **[Append\(this IWriter, XElement\)](DefaultDocumentation/Api/IWriterExtensions/Append(thisIWriter,XElement).md 'DefaultDocumentation\.Api\.IWriterExtensions\.Append\(this DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)')** `Method` Appends an [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') to a [IWriter](DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') by using the [Elements](DefaultDocumentation/IGeneralContext/Elements.md 'DefaultDocumentation\.IGeneralContext\.Elements') of [Context](DefaultDocumentation/Api/IWriter/Context.md 'DefaultDocumentation\.Api\.IWriter\.Context')\. If no [IElement](DefaultDocumentation/Api/IElement/index.md 'DefaultDocumentation\.Api\.IElement') is found, the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') is appended as text directly\. + - **[AppendFormat\(this IWriter, string, object\[\]\)](DefaultDocumentation/Api/IWriterExtensions/AppendFormat(thisIWriter,string,object[]).md 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendFormat\(this DefaultDocumentation\.Api\.IWriter, string, object\[\]\)')** `Method` Appends a formatted string to a [IWriter](DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + - **[AppendLine\(this IWriter, string\)](DefaultDocumentation/Api/IWriterExtensions/AppendLine(thisIWriter,string).md 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendLine\(this DefaultDocumentation\.Api\.IWriter, string\)')** `Method` Appends a line after writing the provided [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')\. + - **[TrimEnd\(this IWriter, string\[\]\)](DefaultDocumentation/Api/IWriterExtensions/TrimEnd(thisIWriter,string[]).md 'DefaultDocumentation\.Api\.IWriterExtensions\.TrimEnd\(this DefaultDocumentation\.Api\.IWriter, string\[\]\)')** `Method` Trims from the end of a [IWriter](DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') all the provided values\. +- **[IDocItemGenerator](DefaultDocumentation/Api/IDocItemGenerator/index.md 'DefaultDocumentation\.Api\.IDocItemGenerator')** `Interface` Exposes a method to generate the known [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') of the documentation\. + - **[Name](DefaultDocumentation/Api/IDocItemGenerator/Name.md 'DefaultDocumentation\.Api\.IDocItemGenerator\.Name')** `Property` Gets the name of the generator, used to identify it at the configuration level\. + - **[Generate\(IDocItemsContext\)](DefaultDocumentation/Api/IDocItemGenerator/Generate(IDocItemsContext).md 'DefaultDocumentation\.Api\.IDocItemGenerator\.Generate\(DefaultDocumentation\.IDocItemsContext\)')** `Method` Modified the known [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') of the [IDocItemsContext](DefaultDocumentation/IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext')\. +- **[IElement](DefaultDocumentation/Api/IElement/index.md 'DefaultDocumentation\.Api\.IElement')** `Interface` Exposes a method to handle a specific kind of [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') when writing documentation\. + - **[Name](DefaultDocumentation/Api/IElement/Name.md 'DefaultDocumentation\.Api\.IElement\.Name')** `Property` Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + - **[Write\(IWriter, XElement\)](DefaultDocumentation/Api/IElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Api\.IElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)')** `Method` Writes to a [IWriter](DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. +- **[IFileNameFactory](DefaultDocumentation/Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory')** `Interface` Exposes methods related to the documentation files cleaning and creation\. + - **[Name](DefaultDocumentation/Api/IFileNameFactory/Name.md 'DefaultDocumentation\.Api\.IFileNameFactory\.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level\. + - **[Clean\(IGeneralContext\)](DefaultDocumentation/Api/IFileNameFactory/Clean(IGeneralContext).md 'DefaultDocumentation\.Api\.IFileNameFactory\.Clean\(DefaultDocumentation\.IGeneralContext\)')** `Method` Cleans the [OutputDirectory](DefaultDocumentation/ISettings/OutputDirectory.md 'DefaultDocumentation\.ISettings\.OutputDirectory') of the previously generated documentation files\. + - **[GetFileName\(IGeneralContext, DocItem\)](DefaultDocumentation/Api/IFileNameFactory/GetFileName(IGeneralContext,DocItem).md 'DefaultDocumentation\.Api\.IFileNameFactory\.GetFileName\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the documentation file name for the given [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. +- **[ISection](DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection')** `Interface` Exposes a method to write a specific section when writing documentation\. + - **[Name](DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[IUrlFactory](DefaultDocumentation/Api/IUrlFactory/index.md 'DefaultDocumentation\.Api\.IUrlFactory')** `Interface` Exposes methods related to the documentation files url creation\. + - **[Name](DefaultDocumentation/Api/IUrlFactory/Name.md 'DefaultDocumentation\.Api\.IUrlFactory\.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level\. + - **[GetUrl\(IPageContext, string\)](DefaultDocumentation/Api/IUrlFactory/GetUrl(IPageContext,string).md 'DefaultDocumentation\.Api\.IUrlFactory\.GetUrl\(DefaultDocumentation\.IPageContext, string\)')** `Method` Gets the url of the given id\. Returns null of the instance does not know how to handle the provided id\. +- **[IWriter](DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')** `Interface` Exposes properties and methods use to generate a documentation file for a specific [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[Context](DefaultDocumentation/Api/IWriter/Context.md 'DefaultDocumentation\.Api\.IWriter\.Context')** `Property` Gets the [IPageContext](DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext') of the current documentation generation process\. + - **[Length](DefaultDocumentation/Api/IWriter/Length.md 'DefaultDocumentation\.Api\.IWriter\.Length')** `Property` Gets or sets the length of the documentation text currently produced\. + - **[Append\(string\)](DefaultDocumentation/Api/IWriter/Append(string).md 'DefaultDocumentation\.Api\.IWriter\.Append\(string\)')** `Method` Appends a string at the end of the documentation text\. + - **[AppendLine\(\)](DefaultDocumentation/Api/IWriter/AppendLine().md 'DefaultDocumentation\.Api\.IWriter\.AppendLine\(\)')** `Method` Appends a [System\.Environment\.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System\.Environment\.NewLine') at the end of the documentation text\. + - **[EndsWith\(string\)](DefaultDocumentation/Api/IWriter/EndsWith(string).md 'DefaultDocumentation\.Api\.IWriter\.EndsWith\(string\)')** `Method` Returns whether the documentation text ends with the given string\. -## DefaultDocumentation.Models Namespace -- **[AssemblyDocItem](AssemblyDocItem.md 'DefaultDocumentation.Models.AssemblyDocItem')** `Class` Represents an assembly documentation. - - **[AssemblyDocItem(string, string, XElement)](AssemblyDocItem.AssemblyDocItem(string,string,XElement).md 'DefaultDocumentation.Models.AssemblyDocItem.AssemblyDocItem(string, string, System.Xml.Linq.XElement)')** `Constructor` Initialize a new instance of the [AssemblyDocItem](AssemblyDocItem.md 'DefaultDocumentation.Models.AssemblyDocItem') type. -- **[DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem')** `Class` Represent a documentation item. - - **[Documentation](DocItem.Documentation.md 'DefaultDocumentation.Models.DocItem.Documentation')** `Property` Gets the xml documentation node of the current instance. - - **[FullName](DocItem.FullName.md 'DefaultDocumentation.Models.DocItem.FullName')** `Property` Gets the full name of the current instance. - - **[Id](DocItem.Id.md 'DefaultDocumentation.Models.DocItem.Id')** `Property` Gets the id of the current instance. - - **[Name](DocItem.Name.md 'DefaultDocumentation.Models.DocItem.Name')** `Property` Gets the name of the current instance. - - **[Parent](DocItem.Parent.md 'DefaultDocumentation.Models.DocItem.Parent')** `Property` Gets the [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') parent of the current instance (for members it is their declaring type, for types it is their namespace, ...). -- **[DocItemExtension](DocItemExtension.md 'DefaultDocumentation.Models.DocItemExtension')** `Class` Provides extension methods on the [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') type. - - **[GetParents(this DocItem)](DocItemExtension.GetParents(thisDocItem).md 'DefaultDocumentation.Models.DocItemExtension.GetParents(this DefaultDocumentation.Models.DocItem)')** `Method` Returns all the parents of the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[HasOwnPage(this DocItem, IGeneralContext)](DocItemExtension.HasOwnPage(thisDocItem,IGeneralContext).md 'DefaultDocumentation.Models.DocItemExtension.HasOwnPage(this DefaultDocumentation.Models.DocItem, DefaultDocumentation.IGeneralContext)')** `Method` Gets wether the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') has its own page generated based on a [IGeneralContext](IGeneralContext.md 'DefaultDocumentation.IGeneralContext'). - - **[TryGetParameterDocItem(this DocItem, string, ParameterDocItem)](DocItemExtension.TryGetParameterDocItem(thisDocItem,string,ParameterDocItem).md 'DefaultDocumentation.Models.DocItemExtension.TryGetParameterDocItem(this DefaultDocumentation.Models.DocItem, string, DefaultDocumentation.Models.Parameters.ParameterDocItem)')** `Method` Searchs recursively on the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') parent a [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') with the provided name. - - **[TryGetTypeParameterDocItem(this DocItem, string, TypeParameterDocItem)](DocItemExtension.TryGetTypeParameterDocItem(thisDocItem,string,TypeParameterDocItem).md 'DefaultDocumentation.Models.DocItemExtension.TryGetTypeParameterDocItem(this DefaultDocumentation.Models.DocItem, string, DefaultDocumentation.Models.Parameters.TypeParameterDocItem)')** `Method` Searchs recursively on the given [DocItem](DocItem.md 'DefaultDocumentation.Models.DocItem') parent a [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') with the provided name. -- **[EntityDocItem](EntityDocItem.md 'DefaultDocumentation.Models.EntityDocItem')** `Class` Represent an [IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEntity') documentation. - - **[Entity](EntityDocItem.Entity.md 'DefaultDocumentation.Models.EntityDocItem.Entity')** `Property` Gets the [IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEntity') of the current instance. -- **[ExternDocItem](ExternDocItem.md 'DefaultDocumentation.Models.ExternDocItem')** `Class` Represent an external documentation. - - **[ExternDocItem(string, string, string)](ExternDocItem.ExternDocItem(string,string,string).md 'DefaultDocumentation.Models.ExternDocItem.ExternDocItem(string, string, string)')** `Constructor` Initialize a new instance of the [ExternDocItem](ExternDocItem.md 'DefaultDocumentation.Models.ExternDocItem') type. - - **[Url](ExternDocItem.Url.md 'DefaultDocumentation.Models.ExternDocItem.Url')** `Property` Gets the url of the current instance. -- **[NamespaceDocItem](NamespaceDocItem.md 'DefaultDocumentation.Models.NamespaceDocItem')** `Class` Represents a namespace documentation. - - **[NamespaceDocItem(AssemblyDocItem, string, XElement)](NamespaceDocItem.NamespaceDocItem(AssemblyDocItem,string,XElement).md 'DefaultDocumentation.Models.NamespaceDocItem.NamespaceDocItem(DefaultDocumentation.Models.AssemblyDocItem, string, System.Xml.Linq.XElement)')** `Constructor` Initialize a new instance of the [NamespaceDocItem](NamespaceDocItem.md 'DefaultDocumentation.Models.NamespaceDocItem') type. -- **[IParameterizedDocItem](IParameterizedDocItem.md 'DefaultDocumentation.Models.IParameterizedDocItem')** `Interface` Exposes [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') instances. - - **[Parameters](IParameterizedDocItem.Parameters.md 'DefaultDocumentation.Models.IParameterizedDocItem.Parameters')** `Property` Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. -- **[ITypeParameterizedDocItem](ITypeParameterizedDocItem.md 'DefaultDocumentation.Models.ITypeParameterizedDocItem')** `Interface` Exposes [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') instances. - - **[TypeParameters](ITypeParameterizedDocItem.TypeParameters.md 'DefaultDocumentation.Models.ITypeParameterizedDocItem.TypeParameters')** `Property` Gets the [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') of this instance. +## DefaultDocumentation\.Models Namespace +- **[AssemblyDocItem](DefaultDocumentation/Models/AssemblyDocItem/index.md 'DefaultDocumentation\.Models\.AssemblyDocItem')** `Class` Represents an assembly documentation\. + - **[AssemblyDocItem\(string, string, XElement\)](DefaultDocumentation/Models/AssemblyDocItem/AssemblyDocItem(string,string,XElement).md 'DefaultDocumentation\.Models\.AssemblyDocItem\.AssemblyDocItem\(string, string, System\.Xml\.Linq\.XElement\)')** `Constructor` Initialize a new instance of the [AssemblyDocItem](DefaultDocumentation/Models/AssemblyDocItem/index.md 'DefaultDocumentation\.Models\.AssemblyDocItem') type\. +- **[DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')** `Class` Represent a documentation item\. + - **[DocItem\(DocItem, string, string, string, XElement\)](DefaultDocumentation/Models/DocItem/DocItem(DocItem,string,string,string,XElement).md 'DefaultDocumentation\.Models\.DocItem\.DocItem\(DefaultDocumentation\.Models\.DocItem, string, string, string, System\.Xml\.Linq\.XElement\)')** `Constructor` Initialize a new instance of the [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') type\. + - **[Documentation](DefaultDocumentation/Models/DocItem/Documentation.md 'DefaultDocumentation\.Models\.DocItem\.Documentation')** `Property` Gets the xml documentation node of the current instance\. + - **[FullName](DefaultDocumentation/Models/DocItem/FullName.md 'DefaultDocumentation\.Models\.DocItem\.FullName')** `Property` Gets the full name of the current instance\. + - **[Id](DefaultDocumentation/Models/DocItem/Id.md 'DefaultDocumentation\.Models\.DocItem\.Id')** `Property` Gets the id of the current instance\. + - **[Name](DefaultDocumentation/Models/DocItem/Name.md 'DefaultDocumentation\.Models\.DocItem\.Name')** `Property` Gets the name of the current instance\. + - **[Parent](DefaultDocumentation/Models/DocItem/Parent.md 'DefaultDocumentation\.Models\.DocItem\.Parent')** `Property` Gets the [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') parent of the current instance \(for members it is their declaring type, for types it is their namespace, \.\.\.\)\. +- **[DocItemExtensions](DefaultDocumentation/Models/DocItemExtensions/index.md 'DefaultDocumentation\.Models\.DocItemExtensions')** `Class` Provides extension methods on the [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') type\. + - **[GetParents\(this DocItem\)](DefaultDocumentation/Models/DocItemExtensions/GetParents(thisDocItem).md 'DefaultDocumentation\.Models\.DocItemExtensions\.GetParents\(this DefaultDocumentation\.Models\.DocItem\)')** `Method` Returns all the parents of the given [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[TryGetParameterDocItem\(this DocItem, string, ParameterDocItem\)](DefaultDocumentation/Models/DocItemExtensions/TryGetParameterDocItem(thisDocItem,string,ParameterDocItem).md 'DefaultDocumentation\.Models\.DocItemExtensions\.TryGetParameterDocItem\(this DefaultDocumentation\.Models\.DocItem, string, DefaultDocumentation\.Models\.Parameters\.ParameterDocItem\)')** `Method` Searchs recursively on the given [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') parent a [ParameterDocItem](DefaultDocumentation/Models/Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') with the provided name\. + - **[TryGetTypeParameterDocItem\(this DocItem, string, TypeParameterDocItem\)](DefaultDocumentation/Models/DocItemExtensions/TryGetTypeParameterDocItem(thisDocItem,string,TypeParameterDocItem).md 'DefaultDocumentation\.Models\.DocItemExtensions\.TryGetTypeParameterDocItem\(this DefaultDocumentation\.Models\.DocItem, string, DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem\)')** `Method` Searchs recursively on the given [DocItem](DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') parent a [TypeParameterDocItem](DefaultDocumentation/Models/Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') with the provided name\. +- **[EntityDocItem](DefaultDocumentation/Models/EntityDocItem/index.md 'DefaultDocumentation\.Models\.EntityDocItem')** `Class` Represent an [IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEntity') documentation\. + - **[Entity](DefaultDocumentation/Models/EntityDocItem/Entity.md 'DefaultDocumentation\.Models\.EntityDocItem\.Entity')** `Property` Gets the [IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEntity') of the current instance\. +- **[ExternDocItem](DefaultDocumentation/Models/ExternDocItem/index.md 'DefaultDocumentation\.Models\.ExternDocItem')** `Class` Represent an external documentation\. + - **[ExternDocItem\(string, string, string\)](DefaultDocumentation/Models/ExternDocItem/ExternDocItem(string,string,string).md 'DefaultDocumentation\.Models\.ExternDocItem\.ExternDocItem\(string, string, string\)')** `Constructor` Initialize a new instance of the [ExternDocItem](DefaultDocumentation/Models/ExternDocItem/index.md 'DefaultDocumentation\.Models\.ExternDocItem') type\. + - **[Url](DefaultDocumentation/Models/ExternDocItem/Url.md 'DefaultDocumentation\.Models\.ExternDocItem\.Url')** `Property` Gets the url of the current instance\. +- **[NamespaceDocItem](DefaultDocumentation/Models/NamespaceDocItem/index.md 'DefaultDocumentation\.Models\.NamespaceDocItem')** `Class` Represents a namespace documentation\. + - **[NamespaceDocItem\(AssemblyDocItem, string, XElement\)](DefaultDocumentation/Models/NamespaceDocItem/NamespaceDocItem(AssemblyDocItem,string,XElement).md 'DefaultDocumentation\.Models\.NamespaceDocItem\.NamespaceDocItem\(DefaultDocumentation\.Models\.AssemblyDocItem, string, System\.Xml\.Linq\.XElement\)')** `Constructor` Initialize a new instance of the [NamespaceDocItem](DefaultDocumentation/Models/NamespaceDocItem/index.md 'DefaultDocumentation\.Models\.NamespaceDocItem') type\. +- **[IParameterizedDocItem](DefaultDocumentation/Models/IParameterizedDocItem/index.md 'DefaultDocumentation\.Models\.IParameterizedDocItem')** `Interface` Exposes [ParameterDocItem](DefaultDocumentation/Models/Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') instances\. + - **[Parameters](DefaultDocumentation/Models/IParameterizedDocItem/Parameters.md 'DefaultDocumentation\.Models\.IParameterizedDocItem\.Parameters')** `Property` Gets the [ParameterDocItem](DefaultDocumentation/Models/Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. +- **[ITypeParameterizedDocItem](DefaultDocumentation/Models/ITypeParameterizedDocItem/index.md 'DefaultDocumentation\.Models\.ITypeParameterizedDocItem')** `Interface` Exposes [TypeParameterDocItem](DefaultDocumentation/Models/Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') instances\. + - **[TypeParameters](DefaultDocumentation/Models/ITypeParameterizedDocItem/TypeParameters.md 'DefaultDocumentation\.Models\.ITypeParameterizedDocItem\.TypeParameters')** `Property` Gets the [TypeParameterDocItem](DefaultDocumentation/Models/Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') of this instance\. -## DefaultDocumentation.Models.Members Namespace -- **[ConstructorDocItem](ConstructorDocItem.md 'DefaultDocumentation.Models.Members.ConstructorDocItem')** `Class` Represents a constructor [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') documentation. - - **[ConstructorDocItem(TypeDocItem, IMethod, XElement)](ConstructorDocItem.ConstructorDocItem(TypeDocItem,IMethod,XElement).md 'DefaultDocumentation.Models.Members.ConstructorDocItem.ConstructorDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IMethod, System.Xml.Linq.XElement)')** `Constructor` Initialize a new instance of the [ConstructorDocItem](ConstructorDocItem.md 'DefaultDocumentation.Models.Members.ConstructorDocItem') type. - - **[Method](ConstructorDocItem.Method.md 'DefaultDocumentation.Models.Members.ConstructorDocItem.Method')** `Property` Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') of the current instance. - - **[Parameters](ConstructorDocItem.Parameters.md 'DefaultDocumentation.Models.Members.ConstructorDocItem.Parameters')** `Property` Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. -- **[EnumFieldDocItem](EnumFieldDocItem.md 'DefaultDocumentation.Models.Members.EnumFieldDocItem')** `Class` Represents an enum [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IField') documentation. - - **[EnumFieldDocItem(EnumDocItem, IField, XElement)](EnumFieldDocItem.EnumFieldDocItem(EnumDocItem,IField,XElement).md 'DefaultDocumentation.Models.Members.EnumFieldDocItem.EnumFieldDocItem(DefaultDocumentation.Models.Types.EnumDocItem, IField, System.Xml.Linq.XElement)')** `Constructor` Initialize a new instance of the [EnumFieldDocItem](EnumFieldDocItem.md 'DefaultDocumentation.Models.Members.EnumFieldDocItem') type. - - **[Field](EnumFieldDocItem.Field.md 'DefaultDocumentation.Models.Members.EnumFieldDocItem.Field')** `Property` Gets the [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IField') of the current instance. -- **[EventDocItem](EventDocItem.md 'DefaultDocumentation.Models.Members.EventDocItem')** `Class` Represents an [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEvent') documentation. - - **[EventDocItem(TypeDocItem, IEvent, XElement)](EventDocItem.EventDocItem(TypeDocItem,IEvent,XElement).md 'DefaultDocumentation.Models.Members.EventDocItem.EventDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IEvent, System.Xml.Linq.XElement)')** `Constructor` Initialize a new instance of the [EventDocItem](EventDocItem.md 'DefaultDocumentation.Models.Members.EventDocItem') type. - - **[Event](EventDocItem.Event.md 'DefaultDocumentation.Models.Members.EventDocItem.Event')** `Property` Gets the [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEvent') of the current instance. -- **[ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem')** `Class` Represents an explicit interface implementation documentation. - - **[ExplicitInterfaceImplementationDocItem(TypeDocItem, IEvent, XElement)](ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(TypeDocItem,IEvent,XElement).md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IEvent, System.Xml.Linq.XElement)')** `Constructor` Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') type. - - **[ExplicitInterfaceImplementationDocItem(TypeDocItem, IMethod, XElement)](ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(TypeDocItem,IMethod,XElement).md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IMethod, System.Xml.Linq.XElement)')** `Constructor` Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') type. - - **[ExplicitInterfaceImplementationDocItem(TypeDocItem, IProperty, XElement)](ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(TypeDocItem,IProperty,XElement).md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IProperty, System.Xml.Linq.XElement)')** `Constructor` Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') type. - - **[Member](ExplicitInterfaceImplementationDocItem.Member.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.Member')** `Property` Gets the [IMember](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMember') of the current instance. - It can either be an [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IEvent'), [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IProperty') or [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod'). - - **[Parameters](ExplicitInterfaceImplementationDocItem.Parameters.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.Parameters')** `Property` Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. - - **[TypeParameters](ExplicitInterfaceImplementationDocItem.TypeParameters.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.TypeParameters')** `Property` Gets the [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') of this instance. -- **[FieldDocItem](FieldDocItem.md 'DefaultDocumentation.Models.Members.FieldDocItem')** `Class` Represents an [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IField') documentation. - - **[FieldDocItem(TypeDocItem, IField, XElement)](FieldDocItem.FieldDocItem(TypeDocItem,IField,XElement).md 'DefaultDocumentation.Models.Members.FieldDocItem.FieldDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IField, System.Xml.Linq.XElement)')** `Constructor` Initialize a new instance of the [FieldDocItem](FieldDocItem.md 'DefaultDocumentation.Models.Members.FieldDocItem') type. - - **[Field](FieldDocItem.Field.md 'DefaultDocumentation.Models.Members.FieldDocItem.Field')** `Property` Gets the [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IField') of the current instance. -- **[MethodDocItem](MethodDocItem.md 'DefaultDocumentation.Models.Members.MethodDocItem')** `Class` Represents an [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') documentation. - - **[MethodDocItem(TypeDocItem, IMethod, XElement)](MethodDocItem.MethodDocItem(TypeDocItem,IMethod,XElement).md 'DefaultDocumentation.Models.Members.MethodDocItem.MethodDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IMethod, System.Xml.Linq.XElement)')** `Constructor` Initialize a new instance of the [MethodDocItem](MethodDocItem.md 'DefaultDocumentation.Models.Members.MethodDocItem') type. - - **[Method](MethodDocItem.Method.md 'DefaultDocumentation.Models.Members.MethodDocItem.Method')** `Property` Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') of the current instance. - - **[Parameters](MethodDocItem.Parameters.md 'DefaultDocumentation.Models.Members.MethodDocItem.Parameters')** `Property` Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. - - **[TypeParameters](MethodDocItem.TypeParameters.md 'DefaultDocumentation.Models.Members.MethodDocItem.TypeParameters')** `Property` Gets the [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') of this instance. -- **[OperatorDocItem](OperatorDocItem.md 'DefaultDocumentation.Models.Members.OperatorDocItem')** `Class` Represents an operator [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') documentation. - - **[OperatorDocItem(TypeDocItem, IMethod, XElement)](OperatorDocItem.OperatorDocItem(TypeDocItem,IMethod,XElement).md 'DefaultDocumentation.Models.Members.OperatorDocItem.OperatorDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IMethod, System.Xml.Linq.XElement)')** `Constructor` Initialize a new instance of the [OperatorDocItem](OperatorDocItem.md 'DefaultDocumentation.Models.Members.OperatorDocItem') type. - - **[Method](OperatorDocItem.Method.md 'DefaultDocumentation.Models.Members.OperatorDocItem.Method')** `Property` Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') of the current instance. - - **[Parameters](OperatorDocItem.Parameters.md 'DefaultDocumentation.Models.Members.OperatorDocItem.Parameters')** `Property` Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. -- **[PropertyDocItem](PropertyDocItem.md 'DefaultDocumentation.Models.Members.PropertyDocItem')** `Class` Represents an [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IProperty') documentation. - - **[PropertyDocItem(TypeDocItem, IProperty, XElement)](PropertyDocItem.PropertyDocItem(TypeDocItem,IProperty,XElement).md 'DefaultDocumentation.Models.Members.PropertyDocItem.PropertyDocItem(DefaultDocumentation.Models.Types.TypeDocItem, IProperty, System.Xml.Linq.XElement)')** `Constructor` Initialize a new instance of the [PropertyDocItem](PropertyDocItem.md 'DefaultDocumentation.Models.Members.PropertyDocItem') type. - - **[Parameters](PropertyDocItem.Parameters.md 'DefaultDocumentation.Models.Members.PropertyDocItem.Parameters')** `Property` Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. - - **[Property](PropertyDocItem.Property.md 'DefaultDocumentation.Models.Members.PropertyDocItem.Property')** `Property` Gets the [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IProperty') of the current instance. +## DefaultDocumentation\.Models\.Members Namespace +- **[ConstructorDocItem](DefaultDocumentation/Models/Members/ConstructorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem')** `Class` Represents a constructor [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') documentation\. + - **[ConstructorDocItem\(TypeDocItem, IMethod, XElement\)](DefaultDocumentation/Models/Members/ConstructorDocItem/ConstructorDocItem(TypeDocItem,IMethod,XElement).md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem\.ConstructorDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IMethod, System\.Xml\.Linq\.XElement\)')** `Constructor` Initialize a new instance of the [ConstructorDocItem](DefaultDocumentation/Models/Members/ConstructorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem') type\. + - **[Method](DefaultDocumentation/Models/Members/ConstructorDocItem/Method.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem\.Method')** `Property` Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') of the current instance\. + - **[Parameters](DefaultDocumentation/Models/Members/ConstructorDocItem/Parameters.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem\.Parameters')** `Property` Gets the [ParameterDocItem](DefaultDocumentation/Models/Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. +- **[EnumFieldDocItem](DefaultDocumentation/Models/Members/EnumFieldDocItem/index.md 'DefaultDocumentation\.Models\.Members\.EnumFieldDocItem')** `Class` Represents an enum [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IField') documentation\. + - **[EnumFieldDocItem\(EnumDocItem, IField, XElement\)](DefaultDocumentation/Models/Members/EnumFieldDocItem/EnumFieldDocItem(EnumDocItem,IField,XElement).md 'DefaultDocumentation\.Models\.Members\.EnumFieldDocItem\.EnumFieldDocItem\(DefaultDocumentation\.Models\.Types\.EnumDocItem, IField, System\.Xml\.Linq\.XElement\)')** `Constructor` Initialize a new instance of the [EnumFieldDocItem](DefaultDocumentation/Models/Members/EnumFieldDocItem/index.md 'DefaultDocumentation\.Models\.Members\.EnumFieldDocItem') type\. + - **[Field](DefaultDocumentation/Models/Members/EnumFieldDocItem/Field.md 'DefaultDocumentation\.Models\.Members\.EnumFieldDocItem\.Field')** `Property` Gets the [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IField') of the current instance\. +- **[EventDocItem](DefaultDocumentation/Models/Members/EventDocItem/index.md 'DefaultDocumentation\.Models\.Members\.EventDocItem')** `Class` Represents an [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEvent') documentation\. + - **[EventDocItem\(TypeDocItem, IEvent, XElement\)](DefaultDocumentation/Models/Members/EventDocItem/EventDocItem(TypeDocItem,IEvent,XElement).md 'DefaultDocumentation\.Models\.Members\.EventDocItem\.EventDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IEvent, System\.Xml\.Linq\.XElement\)')** `Constructor` Initialize a new instance of the [EventDocItem](DefaultDocumentation/Models/Members/EventDocItem/index.md 'DefaultDocumentation\.Models\.Members\.EventDocItem') type\. + - **[Event](DefaultDocumentation/Models/Members/EventDocItem/Event.md 'DefaultDocumentation\.Models\.Members\.EventDocItem\.Event')** `Property` Gets the [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEvent') of the current instance\. +- **[ExplicitInterfaceImplementationDocItem](DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem')** `Class` Represents an explicit interface implementation documentation\. + - **[ExplicitInterfaceImplementationDocItem\(TypeDocItem, IEvent, XElement\)](DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/ExplicitInterfaceImplementationDocItem.md#DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem,IEvent,System.Xml.Linq.XElement) 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem\.ExplicitInterfaceImplementationDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IEvent, System\.Xml\.Linq\.XElement\)')** `Constructor` Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') type\. + - **[ExplicitInterfaceImplementationDocItem\(TypeDocItem, IMethod, XElement\)](DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/ExplicitInterfaceImplementationDocItem.md#DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem,IMethod,System.Xml.Linq.XElement) 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem\.ExplicitInterfaceImplementationDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IMethod, System\.Xml\.Linq\.XElement\)')** `Constructor` Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') type\. + - **[ExplicitInterfaceImplementationDocItem\(TypeDocItem, IProperty, XElement\)](DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/ExplicitInterfaceImplementationDocItem.md#DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem.ExplicitInterfaceImplementationDocItem(DefaultDocumentation.Models.Types.TypeDocItem,IProperty,System.Xml.Linq.XElement) 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem\.ExplicitInterfaceImplementationDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IProperty, System\.Xml\.Linq\.XElement\)')** `Constructor` Initialize a new instance of the [ExplicitInterfaceImplementationDocItem](DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') type\. + - **[Member](DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/Member.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem\.Member')** `Property` Gets the [IMember](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMember') of the current instance\. It can either be an [IEvent](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEvent'), [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IProperty') or [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod')\. + - **[Parameters](DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/Parameters.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem\.Parameters')** `Property` Gets the [ParameterDocItem](DefaultDocumentation/Models/Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. + - **[TypeParameters](DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/TypeParameters.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem\.TypeParameters')** `Property` Gets the [TypeParameterDocItem](DefaultDocumentation/Models/Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') of this instance\. +- **[FieldDocItem](DefaultDocumentation/Models/Members/FieldDocItem/index.md 'DefaultDocumentation\.Models\.Members\.FieldDocItem')** `Class` Represents an [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IField') documentation\. + - **[FieldDocItem\(TypeDocItem, IField, XElement\)](DefaultDocumentation/Models/Members/FieldDocItem/FieldDocItem(TypeDocItem,IField,XElement).md 'DefaultDocumentation\.Models\.Members\.FieldDocItem\.FieldDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IField, System\.Xml\.Linq\.XElement\)')** `Constructor` Initialize a new instance of the [FieldDocItem](DefaultDocumentation/Models/Members/FieldDocItem/index.md 'DefaultDocumentation\.Models\.Members\.FieldDocItem') type\. + - **[Field](DefaultDocumentation/Models/Members/FieldDocItem/Field.md 'DefaultDocumentation\.Models\.Members\.FieldDocItem\.Field')** `Property` Gets the [IField](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IField') of the current instance\. +- **[MethodDocItem](DefaultDocumentation/Models/Members/MethodDocItem/index.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem')** `Class` Represents an [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') documentation\. + - **[MethodDocItem\(TypeDocItem, IMethod, XElement\)](DefaultDocumentation/Models/Members/MethodDocItem/MethodDocItem(TypeDocItem,IMethod,XElement).md 'DefaultDocumentation\.Models\.Members\.MethodDocItem\.MethodDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IMethod, System\.Xml\.Linq\.XElement\)')** `Constructor` Initialize a new instance of the [MethodDocItem](DefaultDocumentation/Models/Members/MethodDocItem/index.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem') type\. + - **[Method](DefaultDocumentation/Models/Members/MethodDocItem/Method.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem\.Method')** `Property` Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') of the current instance\. + - **[Parameters](DefaultDocumentation/Models/Members/MethodDocItem/Parameters.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem\.Parameters')** `Property` Gets the [ParameterDocItem](DefaultDocumentation/Models/Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. + - **[TypeParameters](DefaultDocumentation/Models/Members/MethodDocItem/TypeParameters.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem\.TypeParameters')** `Property` Gets the [TypeParameterDocItem](DefaultDocumentation/Models/Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') of this instance\. +- **[OperatorDocItem](DefaultDocumentation/Models/Members/OperatorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.OperatorDocItem')** `Class` Represents an operator [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') documentation\. + - **[OperatorDocItem\(TypeDocItem, IMethod, XElement\)](DefaultDocumentation/Models/Members/OperatorDocItem/OperatorDocItem(TypeDocItem,IMethod,XElement).md 'DefaultDocumentation\.Models\.Members\.OperatorDocItem\.OperatorDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IMethod, System\.Xml\.Linq\.XElement\)')** `Constructor` Initialize a new instance of the [OperatorDocItem](DefaultDocumentation/Models/Members/OperatorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.OperatorDocItem') type\. + - **[Method](DefaultDocumentation/Models/Members/OperatorDocItem/Method.md 'DefaultDocumentation\.Models\.Members\.OperatorDocItem\.Method')** `Property` Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') of the current instance\. + - **[Parameters](DefaultDocumentation/Models/Members/OperatorDocItem/Parameters.md 'DefaultDocumentation\.Models\.Members\.OperatorDocItem\.Parameters')** `Property` Gets the [ParameterDocItem](DefaultDocumentation/Models/Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. +- **[PropertyDocItem](DefaultDocumentation/Models/Members/PropertyDocItem/index.md 'DefaultDocumentation\.Models\.Members\.PropertyDocItem')** `Class` Represents an [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IProperty') documentation\. + - **[PropertyDocItem\(TypeDocItem, IProperty, XElement\)](DefaultDocumentation/Models/Members/PropertyDocItem/PropertyDocItem(TypeDocItem,IProperty,XElement).md 'DefaultDocumentation\.Models\.Members\.PropertyDocItem\.PropertyDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, IProperty, System\.Xml\.Linq\.XElement\)')** `Constructor` Initialize a new instance of the [PropertyDocItem](DefaultDocumentation/Models/Members/PropertyDocItem/index.md 'DefaultDocumentation\.Models\.Members\.PropertyDocItem') type\. + - **[Parameters](DefaultDocumentation/Models/Members/PropertyDocItem/Parameters.md 'DefaultDocumentation\.Models\.Members\.PropertyDocItem\.Parameters')** `Property` Gets the [ParameterDocItem](DefaultDocumentation/Models/Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. + - **[Property](DefaultDocumentation/Models/Members/PropertyDocItem/Property.md 'DefaultDocumentation\.Models\.Members\.PropertyDocItem\.Property')** `Property` Gets the [IProperty](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IProperty') of the current instance\. -## DefaultDocumentation.Models.Parameters Namespace -- **[ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem')** `Class` Represents an [IParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IParameter') documentation. - - **[Parameter](ParameterDocItem.Parameter.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem.Parameter')** `Property` Gets the [IParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IParameter') of the current instance. -- **[TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem')** `Class` Represents an [ITypeParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeParameter') documentation. - - **[TypeParameter](TypeParameterDocItem.TypeParameter.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem.TypeParameter')** `Property` Gets the [ITypeParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeParameter') of the current instance. +## DefaultDocumentation\.Models\.Parameters Namespace +- **[ParameterDocItem](DefaultDocumentation/Models/Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem')** `Class` Represents an [IParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IParameter') documentation\. + - **[Parameter](DefaultDocumentation/Models/Parameters/ParameterDocItem/Parameter.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem\.Parameter')** `Property` Gets the [IParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IParameter') of the current instance\. +- **[TypeParameterDocItem](DefaultDocumentation/Models/Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem')** `Class` Represents an [ITypeParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeParameter') documentation\. + - **[TypeParameter](DefaultDocumentation/Models/Parameters/TypeParameterDocItem/TypeParameter.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem\.TypeParameter')** `Property` Gets the [ITypeParameter](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeParameter') of the current instance\. -## DefaultDocumentation.Models.Types Namespace -- **[ClassDocItem](ClassDocItem.md 'DefaultDocumentation.Models.Types.ClassDocItem')** `Class` Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') of the [TypeKind.Class](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.TypeKind.Class') kind documentation. - - **[ClassDocItem(DocItem, ITypeDefinition, XElement)](ClassDocItem.ClassDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation.Models.Types.ClassDocItem.ClassDocItem(DefaultDocumentation.Models.DocItem, ITypeDefinition, System.Xml.Linq.XElement)')** `Constructor` Initialize a new instance of the [ClassDocItem](ClassDocItem.md 'DefaultDocumentation.Models.Types.ClassDocItem') type. -- **[DelegateDocItem](DelegateDocItem.md 'DefaultDocumentation.Models.Types.DelegateDocItem')** `Class` Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') of the [TypeKind.Delegate](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.TypeKind.Delegate') kind documentation. - - **[DelegateDocItem(DocItem, ITypeDefinition, XElement)](DelegateDocItem.DelegateDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation.Models.Types.DelegateDocItem.DelegateDocItem(DefaultDocumentation.Models.DocItem, ITypeDefinition, System.Xml.Linq.XElement)')** `Constructor` Initialize a new instance of the [StructDocItem](StructDocItem.md 'DefaultDocumentation.Models.Types.StructDocItem') type. - - **[InvokeMethod](DelegateDocItem.InvokeMethod.md 'DefaultDocumentation.Models.Types.DelegateDocItem.InvokeMethod')** `Property` Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.IMethod') of the current instance. - - **[Parameters](DelegateDocItem.Parameters.md 'DefaultDocumentation.Models.Types.DelegateDocItem.Parameters')** `Property` Gets the [ParameterDocItem](ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') of this instance. -- **[EnumDocItem](EnumDocItem.md 'DefaultDocumentation.Models.Types.EnumDocItem')** `Class` Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') of the [TypeKind.Enum](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.TypeKind.Enum') kind documentation. - - **[EnumDocItem(DocItem, ITypeDefinition, XElement)](EnumDocItem.EnumDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation.Models.Types.EnumDocItem.EnumDocItem(DefaultDocumentation.Models.DocItem, ITypeDefinition, System.Xml.Linq.XElement)')** `Constructor` Initialize a new instance of the [StructDocItem](StructDocItem.md 'DefaultDocumentation.Models.Types.StructDocItem') type. -- **[InterfaceDocItem](InterfaceDocItem.md 'DefaultDocumentation.Models.Types.InterfaceDocItem')** `Class` Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') of the [TypeKind.Interface](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.TypeKind.Interface') kind documentation. - - **[InterfaceDocItem(DocItem, ITypeDefinition, XElement)](InterfaceDocItem.InterfaceDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation.Models.Types.InterfaceDocItem.InterfaceDocItem(DefaultDocumentation.Models.DocItem, ITypeDefinition, System.Xml.Linq.XElement)')** `Constructor` Initialize a new instance of the [StructDocItem](StructDocItem.md 'DefaultDocumentation.Models.Types.StructDocItem') type. -- **[StructDocItem](StructDocItem.md 'DefaultDocumentation.Models.Types.StructDocItem')** `Class` Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') of the [TypeKind.Struct](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.TypeKind.Struct') kind documentation. - - **[StructDocItem(DocItem, ITypeDefinition, XElement)](StructDocItem.StructDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation.Models.Types.StructDocItem.StructDocItem(DefaultDocumentation.Models.DocItem, ITypeDefinition, System.Xml.Linq.XElement)')** `Constructor` Initialize a new instance of the [StructDocItem](StructDocItem.md 'DefaultDocumentation.Models.Types.StructDocItem') type. -- **[TypeDocItem](TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem')** `Class` Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') documentation. - - **[Type](TypeDocItem.Type.md 'DefaultDocumentation.Models.Types.TypeDocItem.Type')** `Property` Gets the [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode.Decompiler.TypeSystem.ITypeDefinition') of the current instance. - - **[TypeParameters](TypeDocItem.TypeParameters.md 'DefaultDocumentation.Models.Types.TypeDocItem.TypeParameters')** `Property` Gets the [TypeParameterDocItem](TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') of this instance. \ No newline at end of file +## DefaultDocumentation\.Models\.Types Namespace +- **[ClassDocItem](DefaultDocumentation/Models/Types/ClassDocItem/index.md 'DefaultDocumentation\.Models\.Types\.ClassDocItem')** `Class` Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') of the [TypeKind\.Class](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.TypeKind\.Class') kind documentation\. + - **[ClassDocItem\(DocItem, ITypeDefinition, XElement\)](DefaultDocumentation/Models/Types/ClassDocItem/ClassDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation\.Models\.Types\.ClassDocItem\.ClassDocItem\(DefaultDocumentation\.Models\.DocItem, ITypeDefinition, System\.Xml\.Linq\.XElement\)')** `Constructor` Initialize a new instance of the [ClassDocItem](DefaultDocumentation/Models/Types/ClassDocItem/index.md 'DefaultDocumentation\.Models\.Types\.ClassDocItem') type\. +- **[DelegateDocItem](DefaultDocumentation/Models/Types/DelegateDocItem/index.md 'DefaultDocumentation\.Models\.Types\.DelegateDocItem')** `Class` Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') of the [TypeKind\.Delegate](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.TypeKind\.Delegate') kind documentation\. + - **[DelegateDocItem\(DocItem, ITypeDefinition, XElement\)](DefaultDocumentation/Models/Types/DelegateDocItem/DelegateDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation\.Models\.Types\.DelegateDocItem\.DelegateDocItem\(DefaultDocumentation\.Models\.DocItem, ITypeDefinition, System\.Xml\.Linq\.XElement\)')** `Constructor` Initialize a new instance of the [StructDocItem](DefaultDocumentation/Models/Types/StructDocItem/index.md 'DefaultDocumentation\.Models\.Types\.StructDocItem') type\. + - **[InvokeMethod](DefaultDocumentation/Models/Types/DelegateDocItem/InvokeMethod.md 'DefaultDocumentation\.Models\.Types\.DelegateDocItem\.InvokeMethod')** `Property` Gets the [IMethod](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IMethod') of the current instance\. + - **[Parameters](DefaultDocumentation/Models/Types/DelegateDocItem/Parameters.md 'DefaultDocumentation\.Models\.Types\.DelegateDocItem\.Parameters')** `Property` Gets the [ParameterDocItem](DefaultDocumentation/Models/Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') of this instance\. +- **[EnumDocItem](DefaultDocumentation/Models/Types/EnumDocItem/index.md 'DefaultDocumentation\.Models\.Types\.EnumDocItem')** `Class` Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') of the [TypeKind\.Enum](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.TypeKind\.Enum') kind documentation\. + - **[EnumDocItem\(DocItem, ITypeDefinition, XElement\)](DefaultDocumentation/Models/Types/EnumDocItem/EnumDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation\.Models\.Types\.EnumDocItem\.EnumDocItem\(DefaultDocumentation\.Models\.DocItem, ITypeDefinition, System\.Xml\.Linq\.XElement\)')** `Constructor` Initialize a new instance of the [StructDocItem](DefaultDocumentation/Models/Types/StructDocItem/index.md 'DefaultDocumentation\.Models\.Types\.StructDocItem') type\. +- **[InterfaceDocItem](DefaultDocumentation/Models/Types/InterfaceDocItem/index.md 'DefaultDocumentation\.Models\.Types\.InterfaceDocItem')** `Class` Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') of the [TypeKind\.Interface](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.TypeKind\.Interface') kind documentation\. + - **[InterfaceDocItem\(DocItem, ITypeDefinition, XElement\)](DefaultDocumentation/Models/Types/InterfaceDocItem/InterfaceDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation\.Models\.Types\.InterfaceDocItem\.InterfaceDocItem\(DefaultDocumentation\.Models\.DocItem, ITypeDefinition, System\.Xml\.Linq\.XElement\)')** `Constructor` Initialize a new instance of the [StructDocItem](DefaultDocumentation/Models/Types/StructDocItem/index.md 'DefaultDocumentation\.Models\.Types\.StructDocItem') type\. +- **[StructDocItem](DefaultDocumentation/Models/Types/StructDocItem/index.md 'DefaultDocumentation\.Models\.Types\.StructDocItem')** `Class` Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') of the [TypeKind\.Struct](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.TypeKind\.Struct') kind documentation\. + - **[StructDocItem\(DocItem, ITypeDefinition, XElement\)](DefaultDocumentation/Models/Types/StructDocItem/StructDocItem(DocItem,ITypeDefinition,XElement).md 'DefaultDocumentation\.Models\.Types\.StructDocItem\.StructDocItem\(DefaultDocumentation\.Models\.DocItem, ITypeDefinition, System\.Xml\.Linq\.XElement\)')** `Constructor` Initialize a new instance of the [StructDocItem](DefaultDocumentation/Models/Types/StructDocItem/index.md 'DefaultDocumentation\.Models\.Types\.StructDocItem') type\. +- **[TypeDocItem](DefaultDocumentation/Models/Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem')** `Class` Represents a [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') documentation\. + - **[Type](DefaultDocumentation/Models/Types/TypeDocItem/Type.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem\.Type')** `Property` Gets the [ITypeDefinition](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.ITypeDefinition') of the current instance\. + - **[TypeParameters](DefaultDocumentation/Models/Types/TypeDocItem/TypeParameters.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem\.TypeParameters')** `Property` Gets the [TypeParameterDocItem](DefaultDocumentation/Models/Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') of this instance\. + + + +## ICSharpCode\.Decompiler\.TypeSystem Namespace +- **[IEntityExtensions](ICSharpCode/Decompiler/TypeSystem/IEntityExtensions/index.md 'ICSharpCode\.Decompiler\.TypeSystem\.IEntityExtensions')** `Class` Provides extension methods on the [IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEntity') type\. + - **[IsVisibleInDocumentation\(this IEntity, ISettings\)](ICSharpCode/Decompiler/TypeSystem/IEntityExtensions/IsVisibleInDocumentation(thisIEntity,ISettings).md 'ICSharpCode\.Decompiler\.TypeSystem\.IEntityExtensions\.IsVisibleInDocumentation\(this IEntity, DefaultDocumentation\.ISettings\)')** `Method` Returns wether an [IEntity](https://github.com/icsharpcode/ILSpy 'ICSharpCode\.Decompiler\.TypeSystem\.IEntity') should be part of the documentation or not based on its accessibility\. +- **[ISymbolExtensions](ICSharpCode/Decompiler/TypeSystem/ISymbolExtensions/index.md 'ICSharpCode\.Decompiler\.TypeSystem\.ISymbolExtensions')** `Class` Provides extension methods on the [ICSharpCode\.Decompiler\.TypeSystem\.ISymbol](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.TypeSystem.ISymbol 'ICSharpCode\.Decompiler\.TypeSystem\.ISymbol') type\. + - **[ToString\(this ISymbol, CSharpAmbience\)](ICSharpCode/Decompiler/TypeSystem/ISymbolExtensions/ToString(thisISymbol,CSharpAmbience).md 'ICSharpCode\.Decompiler\.TypeSystem\.ISymbolExtensions\.ToString\(this ISymbol, CSharpAmbience\)')** `Method` Converts a [ICSharpCode\.Decompiler\.TypeSystem\.ISymbol](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.TypeSystem.ISymbol 'ICSharpCode\.Decompiler\.TypeSystem\.ISymbol') into its string representation using the provided [ICSharpCode\.Decompiler\.CSharp\.OutputVisitor\.CSharpAmbience](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.CSharp.OutputVisitor.CSharpAmbience 'ICSharpCode\.Decompiler\.CSharp\.OutputVisitor\.CSharpAmbience')\. + +--- +Generated by [DefaultDocumentation](https://github.com/Doraku/DefaultDocumentation 'https://github\.com/Doraku/DefaultDocumentation') \ No newline at end of file diff --git a/documentation/markdown/AMarkdownFactory.Clean(IGeneralContext).md b/documentation/markdown/AMarkdownFactory.Clean(IGeneralContext).md deleted file mode 100644 index 35cceb49..00000000 --- a/documentation/markdown/AMarkdownFactory.Clean(IGeneralContext).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[AMarkdownFactory](AMarkdownFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory') - -## AMarkdownFactory.Clean(IGeneralContext) Method - -Cleans the [OutputDirectory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISettings.OutputDirectory.md 'DefaultDocumentation.ISettings.OutputDirectory') of the previously generated documentation files. - -```csharp -public void Clean(DefaultDocumentation.IGeneralContext context); -``` -#### Parameters - - - -`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - -Implements [Clean(IGeneralContext)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.Clean(IGeneralContext).md 'DefaultDocumentation.Api.IFileNameFactory.Clean(DefaultDocumentation.IGeneralContext)') \ No newline at end of file diff --git a/documentation/markdown/AMarkdownFactory.GetFileName(IGeneralContext,DocItem).md b/documentation/markdown/AMarkdownFactory.GetFileName(IGeneralContext,DocItem).md deleted file mode 100644 index d52f35d0..00000000 --- a/documentation/markdown/AMarkdownFactory.GetFileName(IGeneralContext,DocItem).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[AMarkdownFactory](AMarkdownFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory') - -## AMarkdownFactory.GetFileName(IGeneralContext, DocItem) Method - -Gets the documentation file name for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public string GetFileName(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); -``` -#### Parameters - - - -`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - - - -`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which to get the documentation file name. - -Implements [GetFileName(IGeneralContext, DocItem)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.GetFileName(IGeneralContext,DocItem).md 'DefaultDocumentation.Api.IFileNameFactory.GetFileName(DefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem)') - -#### Returns -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The documentation file name of the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). \ No newline at end of file diff --git a/documentation/markdown/AMarkdownFactory.GetMarkdownFileName(IGeneralContext,DocItem).md b/documentation/markdown/AMarkdownFactory.GetMarkdownFileName(IGeneralContext,DocItem).md deleted file mode 100644 index d1b2b6b8..00000000 --- a/documentation/markdown/AMarkdownFactory.GetMarkdownFileName(IGeneralContext,DocItem).md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[AMarkdownFactory](AMarkdownFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory') - -## AMarkdownFactory.GetMarkdownFileName(IGeneralContext, DocItem) Method - -Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -protected abstract string GetMarkdownFileName(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); -``` -#### Parameters - - - -`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - - - -`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which to get the documentation file name. - -#### Returns -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The file name to use. \ No newline at end of file diff --git a/documentation/markdown/AMarkdownFactory.Name.md b/documentation/markdown/AMarkdownFactory.Name.md deleted file mode 100644 index 024e6318..00000000 --- a/documentation/markdown/AMarkdownFactory.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[AMarkdownFactory](AMarkdownFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory') - -## AMarkdownFactory.Name Property - -Gets the name of the factory, used to identify it at the configuration level. - -```csharp -public abstract string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.Name.md 'DefaultDocumentation.Api.IFileNameFactory.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/AMarkdownFactory.md b/documentation/markdown/AMarkdownFactory.md deleted file mode 100644 index 896a74ee..00000000 --- a/documentation/markdown/AMarkdownFactory.md +++ /dev/null @@ -1,32 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories') - -## AMarkdownFactory Class - -Base implementation of the [IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') to generate file with a `.md` extension. -It will also replace invalid char that may be present with the [Markdown.InvalidCharReplacement](https://github.com/Doraku/DefaultDocumentation#invalidcharreplacement 'https://github.com/Doraku/DefaultDocumentation#invalidcharreplacement') setting. - -```csharp -public abstract class AMarkdownFactory : -DefaultDocumentation.Api.IFileNameFactory -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 AMarkdownFactory - -Derived -↳ [FullNameFactory](FullNameFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory') -↳ [Md5Factory](Md5Factory.md 'DefaultDocumentation.Markdown.FileNameFactories.Md5Factory') -↳ [NameAndMd5MixFactory](NameAndMd5MixFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory') -↳ [NameFactory](NameFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.NameFactory') - -Implements [IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') - -| Properties | | -| :--- | :--- | -| [Name](AMarkdownFactory.Name.md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.Name') | Gets the name of the factory, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Clean(IGeneralContext)](AMarkdownFactory.Clean(IGeneralContext).md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.Clean(DefaultDocumentation.IGeneralContext)') | Cleans the [OutputDirectory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISettings.OutputDirectory.md 'DefaultDocumentation.ISettings.OutputDirectory') of the previously generated documentation files. | -| [GetFileName(IGeneralContext, DocItem)](AMarkdownFactory.GetFileName(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.GetFileName(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)') | Gets the documentation file name for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). | -| [GetMarkdownFileName(IGeneralContext, DocItem)](AMarkdownFactory.GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)') | Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). | diff --git a/documentation/markdown/CElement.Name.md b/documentation/markdown/CElement.Name.md deleted file mode 100644 index f9587217..00000000 --- a/documentation/markdown/CElement.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements').[CElement](CElement.md 'DefaultDocumentation.Markdown.Elements.CElement') - -## CElement.Name Property - -Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.Name.md 'DefaultDocumentation.Api.IElement.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/CElement.Write(IWriter,XElement).md b/documentation/markdown/CElement.Write(IWriter,XElement).md deleted file mode 100644 index 91dfe2ca..00000000 --- a/documentation/markdown/CElement.Write(IWriter,XElement).md +++ /dev/null @@ -1,25 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements').[CElement](CElement.md 'DefaultDocumentation.Markdown.Elements.CElement') - -## CElement.Write(IWriter, XElement) Method - -Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - - - -`element` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') to write. - -Implements [Write(IWriter, XElement)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.Write(IWriter,XElement).md 'DefaultDocumentation.Api.IElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)') \ No newline at end of file diff --git a/documentation/markdown/CElement.md b/documentation/markdown/CElement.md deleted file mode 100644 index 12004bc5..00000000 --- a/documentation/markdown/CElement.md +++ /dev/null @@ -1,23 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements') - -## CElement Class - -Handles `c` xml element. - -```csharp -public sealed class CElement : -DefaultDocumentation.Api.IElement -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 CElement - -Implements [IElement](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.md 'DefaultDocumentation.Api.IElement') - -| Properties | | -| :--- | :--- | -| [Name](CElement.Name.md 'DefaultDocumentation.Markdown.Elements.CElement.Name') | Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter, XElement)](CElement.Write(IWriter,XElement).md 'DefaultDocumentation.Markdown.Elements.CElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)') | Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). | diff --git a/documentation/markdown/ChildrenSection_T_.ChildrenSection(string,string).md b/documentation/markdown/ChildrenSection_T_.ChildrenSection(string,string).md deleted file mode 100644 index 154e8732..00000000 --- a/documentation/markdown/ChildrenSection_T_.ChildrenSection(string,string).md +++ /dev/null @@ -1,23 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ChildrenSection<T>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') - -## ChildrenSection(string, string) Constructor - -Base constructor of the [ChildrenSection<T>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') type. - -```csharp -protected ChildrenSection(string name, string title); -``` -#### Parameters - - - -`name` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The name of the section. - - - -`title` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The title that will be written before the children. \ No newline at end of file diff --git a/documentation/markdown/ChildrenSection_T_.GetChildren(IGeneralContext,DocItem).md b/documentation/markdown/ChildrenSection_T_.GetChildren(IGeneralContext,DocItem).md deleted file mode 100644 index dacd22ac..00000000 --- a/documentation/markdown/ChildrenSection_T_.GetChildren(IGeneralContext,DocItem).md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ChildrenSection<T>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') - -## ChildrenSection.GetChildren(IGeneralContext, DocItem) Method - -Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') to write. - -```csharp -protected virtual System.Collections.Generic.IEnumerable? GetChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); -``` -#### Parameters - - - -`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - - - -`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which to write its children. - -#### Returns -[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[T](ChildrenSection_T_.md#DefaultDocumentation.Markdown.Sections.ChildrenSection_T_.T 'DefaultDocumentation.Markdown.Sections.ChildrenSection.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') -The children to write. \ No newline at end of file diff --git a/documentation/markdown/ChildrenSection_T_.Name.md b/documentation/markdown/ChildrenSection_T_.Name.md deleted file mode 100644 index d4dd2d02..00000000 --- a/documentation/markdown/ChildrenSection_T_.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ChildrenSection<T>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') - -## ChildrenSection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/ChildrenSection_T_.Write(IWriter).md b/documentation/markdown/ChildrenSection_T_.Write(IWriter).md deleted file mode 100644 index 9e4a8242..00000000 --- a/documentation/markdown/ChildrenSection_T_.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ChildrenSection<T>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') - -## ChildrenSection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/ChildrenSection_T_.md b/documentation/markdown/ChildrenSection_T_.md deleted file mode 100644 index 3eb9b569..00000000 --- a/documentation/markdown/ChildrenSection_T_.md +++ /dev/null @@ -1,54 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## ChildrenSection Class - -Base [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write children of a given type of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public abstract class ChildrenSection : -DefaultDocumentation.Api.ISection - where T : DefaultDocumentation.Models.DocItem -``` -#### Type parameters - - - -`T` - -The of [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') to write. - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ChildrenSection - -Derived -↳ [ClassesSection](ClassesSection.md 'DefaultDocumentation.Markdown.Sections.ClassesSection') -↳ [ConstructorsSection](ConstructorsSection.md 'DefaultDocumentation.Markdown.Sections.ConstructorsSection') -↳ [DelegatesSection](DelegatesSection.md 'DefaultDocumentation.Markdown.Sections.DelegatesSection') -↳ [EnumFieldsSection](EnumFieldsSection.md 'DefaultDocumentation.Markdown.Sections.EnumFieldsSection') -↳ [EnumsSection](EnumsSection.md 'DefaultDocumentation.Markdown.Sections.EnumsSection') -↳ [EventsSection](EventsSection.md 'DefaultDocumentation.Markdown.Sections.EventsSection') -↳ [ExplicitInterfaceImplementationsSection](ExplicitInterfaceImplementationsSection.md 'DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection') -↳ [FieldsSection](FieldsSection.md 'DefaultDocumentation.Markdown.Sections.FieldsSection') -↳ [InterfacesSection](InterfacesSection.md 'DefaultDocumentation.Markdown.Sections.InterfacesSection') -↳ [MethodsSection](MethodsSection.md 'DefaultDocumentation.Markdown.Sections.MethodsSection') -↳ [NamespacesSection](NamespacesSection.md 'DefaultDocumentation.Markdown.Sections.NamespacesSection') -↳ [OperatorsSection](OperatorsSection.md 'DefaultDocumentation.Markdown.Sections.OperatorsSection') -↳ [ParametersSection](ParametersSection.md 'DefaultDocumentation.Markdown.Sections.ParametersSection') -↳ [PropertiesSection](PropertiesSection.md 'DefaultDocumentation.Markdown.Sections.PropertiesSection') -↳ [StructsSection](StructsSection.md 'DefaultDocumentation.Markdown.Sections.StructsSection') -↳ [TypeParametersSection](TypeParametersSection.md 'DefaultDocumentation.Markdown.Sections.TypeParametersSection') - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Constructors | | -| :--- | :--- | -| [ChildrenSection(string, string)](ChildrenSection_T_.ChildrenSection(string,string).md 'DefaultDocumentation.Markdown.Sections.ChildrenSection.ChildrenSection(string, string)') | Base constructor of the [ChildrenSection<T>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') type. | - -| Properties | | -| :--- | :--- | -| [Name](ChildrenSection_T_.Name.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [GetChildren(IGeneralContext, DocItem)](ChildrenSection_T_.GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.Sections.ChildrenSection.GetChildren(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)') | Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') to write. | -| [Write(IWriter)](ChildrenSection_T_.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.ChildrenSection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/ClassesSection.ClassesSection().md b/documentation/markdown/ClassesSection.ClassesSection().md deleted file mode 100644 index 6ace9415..00000000 --- a/documentation/markdown/ClassesSection.ClassesSection().md +++ /dev/null @@ -1,10 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ClassesSection](ClassesSection.md 'DefaultDocumentation.Markdown.Sections.ClassesSection') - -## ClassesSection() Constructor - -Initialize a new instance of the [ClassesSection](ClassesSection.md 'DefaultDocumentation.Markdown.Sections.ClassesSection') type. - -```csharp -public ClassesSection(); -``` \ No newline at end of file diff --git a/documentation/markdown/ClassesSection.ConfigName.md b/documentation/markdown/ClassesSection.ConfigName.md deleted file mode 100644 index 6d201f44..00000000 --- a/documentation/markdown/ClassesSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ClassesSection](ClassesSection.md 'DefaultDocumentation.Markdown.Sections.ClassesSection') - -## ClassesSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Classes; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/ClassesSection.md b/documentation/markdown/ClassesSection.md deleted file mode 100644 index 1ba8e263..00000000 --- a/documentation/markdown/ClassesSection.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## ClassesSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [ClassDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ClassDocItem.md 'DefaultDocumentation.Models.Types.ClassDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class ClassesSection : DefaultDocumentation.Markdown.Sections.ChildrenSection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DefaultDocumentation.Markdown.Sections.ChildrenSection<](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection')[ClassDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ClassDocItem.md 'DefaultDocumentation.Models.Types.ClassDocItem')[>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') 🡒 ClassesSection - -| Constructors | | -| :--- | :--- | -| [ClassesSection()](ClassesSection.ClassesSection().md 'DefaultDocumentation.Markdown.Sections.ClassesSection.ClassesSection()') | Initialize a new instance of the [ClassesSection](ClassesSection.md 'DefaultDocumentation.Markdown.Sections.ClassesSection') type. | - -| Fields | | -| :--- | :--- | -| [ConfigName](ClassesSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.ClassesSection.ConfigName') | The name of this implementation used at the configuration level. | diff --git a/documentation/markdown/CodeElement.Name.md b/documentation/markdown/CodeElement.Name.md deleted file mode 100644 index 8d9cc150..00000000 --- a/documentation/markdown/CodeElement.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements').[CodeElement](CodeElement.md 'DefaultDocumentation.Markdown.Elements.CodeElement') - -## CodeElement.Name Property - -Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.Name.md 'DefaultDocumentation.Api.IElement.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/CodeElement.Write(IWriter,XElement).md b/documentation/markdown/CodeElement.Write(IWriter,XElement).md deleted file mode 100644 index d9aa0486..00000000 --- a/documentation/markdown/CodeElement.Write(IWriter,XElement).md +++ /dev/null @@ -1,25 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements').[CodeElement](CodeElement.md 'DefaultDocumentation.Markdown.Elements.CodeElement') - -## CodeElement.Write(IWriter, XElement) Method - -Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - - - -`element` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') to write. - -Implements [Write(IWriter, XElement)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.Write(IWriter,XElement).md 'DefaultDocumentation.Api.IElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)') \ No newline at end of file diff --git a/documentation/markdown/CodeElement.md b/documentation/markdown/CodeElement.md deleted file mode 100644 index 9899f7ec..00000000 --- a/documentation/markdown/CodeElement.md +++ /dev/null @@ -1,23 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements') - -## CodeElement Class - -Handles `code` xml element. - -```csharp -public sealed class CodeElement : -DefaultDocumentation.Api.IElement -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 CodeElement - -Implements [IElement](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.md 'DefaultDocumentation.Api.IElement') - -| Properties | | -| :--- | :--- | -| [Name](CodeElement.Name.md 'DefaultDocumentation.Markdown.Elements.CodeElement.Name') | Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter, XElement)](CodeElement.Write(IWriter,XElement).md 'DefaultDocumentation.Markdown.Elements.CodeElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)') | Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). | diff --git a/documentation/markdown/ConstructorsSection.ConfigName.md b/documentation/markdown/ConstructorsSection.ConfigName.md deleted file mode 100644 index 1f8d3ca3..00000000 --- a/documentation/markdown/ConstructorsSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ConstructorsSection](ConstructorsSection.md 'DefaultDocumentation.Markdown.Sections.ConstructorsSection') - -## ConstructorsSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Constructors; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/ConstructorsSection.ConstructorsSection().md b/documentation/markdown/ConstructorsSection.ConstructorsSection().md deleted file mode 100644 index a1771dbe..00000000 --- a/documentation/markdown/ConstructorsSection.ConstructorsSection().md +++ /dev/null @@ -1,10 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ConstructorsSection](ConstructorsSection.md 'DefaultDocumentation.Markdown.Sections.ConstructorsSection') - -## ConstructorsSection() Constructor - -Initialize a new instance of the [ConstructorsSection](ConstructorsSection.md 'DefaultDocumentation.Markdown.Sections.ConstructorsSection') type. - -```csharp -public ConstructorsSection(); -``` \ No newline at end of file diff --git a/documentation/markdown/ConstructorsSection.md b/documentation/markdown/ConstructorsSection.md deleted file mode 100644 index 0556fb4b..00000000 --- a/documentation/markdown/ConstructorsSection.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## ConstructorsSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [ConstructorDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ConstructorDocItem.md 'DefaultDocumentation.Models.Members.ConstructorDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class ConstructorsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DefaultDocumentation.Markdown.Sections.ChildrenSection<](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection')[ConstructorDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ConstructorDocItem.md 'DefaultDocumentation.Models.Members.ConstructorDocItem')[>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') 🡒 ConstructorsSection - -| Constructors | | -| :--- | :--- | -| [ConstructorsSection()](ConstructorsSection.ConstructorsSection().md 'DefaultDocumentation.Markdown.Sections.ConstructorsSection.ConstructorsSection()') | Initialize a new instance of the [ConstructorsSection](ConstructorsSection.md 'DefaultDocumentation.Markdown.Sections.ConstructorsSection') type. | - -| Fields | | -| :--- | :--- | -| [ConfigName](ConstructorsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.ConstructorsSection.ConfigName') | The name of this implementation used at the configuration level. | diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/AppendAsMarkdown(thisIWriter,XElement).md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/AppendAsMarkdown(thisIWriter,XElement).md new file mode 100644 index 00000000..763d327e --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/AppendAsMarkdown(thisIWriter,XElement).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.AppendAsMarkdown\(this IWriter, XElement\) Method + +Appends a [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') decorating the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') with a [MarkdownWriter](../../Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter')\. + +```csharp +public static DefaultDocumentation.Api.IWriter AppendAsMarkdown(this DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement? element); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to use\. + + + +`element` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') to write\. + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/AppendAsRaw(thisIWriter).md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/AppendAsRaw(thisIWriter).md new file mode 100644 index 00000000..15ceb075 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/AppendAsRaw(thisIWriter).md @@ -0,0 +1,21 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.AppendAsRaw\(this IWriter\) Method + +Append a string without sanitizing it for markdown regardless of the current [GetRenderAsRaw\(this IWriter\)](GetRenderAsRaw(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.GetRenderAsRaw\(this DefaultDocumentation\.Api\.IWriter\)') value\. + +```csharp +public static System.IDisposable AppendAsRaw(this DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to use\. + +#### Returns +[System\.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System\.IDisposable') +The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/AppendLink.md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/AppendLink.md new file mode 100644 index 00000000..0c08bce0 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/AppendLink.md @@ -0,0 +1,109 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.AppendLink Method + +| Overloads | | +| :--- | :--- | +| [AppendLink\(this IWriter, DocItem, INamedElement\)](DefaultDocumentation/Api/IWriterExtensions/AppendLink.md#DefaultDocumentation.Api.IWriterExtensions.AppendLink(thisDefaultDocumentation.Api.IWriter,DefaultDocumentation.Models.DocItem,INamedElement) 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendLink\(this DefaultDocumentation\.Api\.IWriter, DefaultDocumentation\.Models\.DocItem, INamedElement\)') | Append an link to an [ICSharpCode\.Decompiler\.TypeSystem\.INamedElement](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.TypeSystem.INamedElement 'ICSharpCode\.Decompiler\.TypeSystem\.INamedElement') in the markdown format\. | +| [AppendLink\(this IWriter, DocItem, string\)](DefaultDocumentation/Api/IWriterExtensions/AppendLink.md#DefaultDocumentation.Api.IWriterExtensions.AppendLink(thisDefaultDocumentation.Api.IWriter,DefaultDocumentation.Models.DocItem,string) 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendLink\(this DefaultDocumentation\.Api\.IWriter, DefaultDocumentation\.Models\.DocItem, string\)') | Append an link to a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') in the markdown format\. | +| [AppendLink\(this IWriter, string, string\)](DefaultDocumentation/Api/IWriterExtensions/AppendLink.md#DefaultDocumentation.Api.IWriterExtensions.AppendLink(thisDefaultDocumentation.Api.IWriter,string,string) 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendLink\(this DefaultDocumentation\.Api\.IWriter, string, string\)') | Append an link to an id using [UrlFactories](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/UrlFactories.md 'DefaultDocumentation\.IGeneralContext\.UrlFactories') to resolve the url in the markdown format\. | + + + +## IWriterExtensions\.AppendLink\(this IWriter, DocItem, INamedElement\) Method + +Append an link to an [ICSharpCode\.Decompiler\.TypeSystem\.INamedElement](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.TypeSystem.INamedElement 'ICSharpCode\.Decompiler\.TypeSystem\.INamedElement') in the markdown format\. + +```csharp +public static DefaultDocumentation.Api.IWriter AppendLink(this DefaultDocumentation.Api.IWriter writer, DefaultDocumentation.Models.DocItem item, INamedElement element); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to use\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') parent of the element, to get generic information if needed\. + + + +`element` [ICSharpCode\.Decompiler\.TypeSystem\.INamedElement](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.TypeSystem.INamedElement 'ICSharpCode\.Decompiler\.TypeSystem\.INamedElement') + +The [ICSharpCode\.Decompiler\.TypeSystem\.INamedElement](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.TypeSystem.INamedElement 'ICSharpCode\.Decompiler\.TypeSystem\.INamedElement') to link to\. + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + + + +## IWriterExtensions\.AppendLink\(this IWriter, DocItem, string\) Method + +Append an link to a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') in the markdown format\. + +```csharp +public static DefaultDocumentation.Api.IWriter AppendLink(this DefaultDocumentation.Api.IWriter writer, DefaultDocumentation.Models.DocItem item, string? displayedName=null); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to use\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to link to\. + + + +`displayedName` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The displayed name of the link\. + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + + + +## IWriterExtensions\.AppendLink\(this IWriter, string, string\) Method + +Append an link to an id using [UrlFactories](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/UrlFactories.md 'DefaultDocumentation\.IGeneralContext\.UrlFactories') to resolve the url in the markdown format\. + +```csharp +public static DefaultDocumentation.Api.IWriter AppendLink(this DefaultDocumentation.Api.IWriter writer, string id, string? displayedName=null); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to use\. + + + +`id` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The id to link to\. + + + +`displayedName` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The displayed name of the link\. + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/AppendUrl(thisIWriter,string,string,string).md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/AppendUrl(thisIWriter,string,string,string).md new file mode 100644 index 00000000..34b833e1 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/AppendUrl(thisIWriter,string,string,string).md @@ -0,0 +1,39 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.AppendUrl\(this IWriter, string, string, string\) Method + +Append an url in the markdown format\. + +```csharp +public static DefaultDocumentation.Api.IWriter AppendUrl(this DefaultDocumentation.Api.IWriter writer, string? url, string? displayedName=null, string? tooltip=null); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to use\. + + + +`url` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The url of the link\. + + + +`displayedName` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The displayed name of the link\. + + + +`tooltip` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The tooltip of the link\. + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/EnsureLineStart(thisIWriter).md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/EnsureLineStart(thisIWriter).md new file mode 100644 index 00000000..15270fee --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/EnsureLineStart(thisIWriter).md @@ -0,0 +1,21 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.EnsureLineStart\(this IWriter\) Method + +Ensures that the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') ends with a line break and call [AppendLine\(\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/AppendLine().md 'DefaultDocumentation\.Api\.IWriter\.AppendLine') if it's not the case\. + +```csharp +public static DefaultDocumentation.Api.IWriter EnsureLineStart(this DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to check\. + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/EnsureLineStartAndAppendLine(thisIWriter).md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/EnsureLineStartAndAppendLine(thisIWriter).md new file mode 100644 index 00000000..823c52ce --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/EnsureLineStartAndAppendLine(thisIWriter).md @@ -0,0 +1,21 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.EnsureLineStartAndAppendLine\(this IWriter\) Method + +Calls [EnsureLineStart\(this IWriter\)](EnsureLineStart(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.EnsureLineStart\(this DefaultDocumentation\.Api\.IWriter\)') and [AppendLine\(\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/AppendLine().md 'DefaultDocumentation\.Api\.IWriter\.AppendLine')\. + +```csharp +public static DefaultDocumentation.Api.IWriter EnsureLineStartAndAppendLine(this DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/GetCurrentItem(thisIWriter).md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/GetCurrentItem(thisIWriter).md new file mode 100644 index 00000000..21162d73 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/GetCurrentItem(thisIWriter).md @@ -0,0 +1,22 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.GetCurrentItem\(this IWriter\) Method + +Gets the current item that is being processed by this [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +It can be different from the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/DocItem.md 'DefaultDocumentation\.IPageContext\.DocItem') when inlining child documentation in its parent page\. + +```csharp +public static DefaultDocumentation.Models.DocItem GetCurrentItem(this DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') for which to get the current item\. + +#### Returns +[DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which the documentation is being generated\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/GetDisplayAsSingleLine(thisIWriter).md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/GetDisplayAsSingleLine(thisIWriter).md new file mode 100644 index 00000000..9b2a38a5 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/GetDisplayAsSingleLine(thisIWriter).md @@ -0,0 +1,22 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.GetDisplayAsSingleLine\(this IWriter\) Method + +Gets whether all futur data appended to the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') should stay on the same line \(usefull for table\)\. +This setting is used by the [MarkdownWriter](../../Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. + +```csharp +public static bool GetDisplayAsSingleLine(this DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') for which to get this setting\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +Whether all futur data to happend should stay on the same line\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/GetHandleLineBreak(thisIWriter).md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/GetHandleLineBreak(thisIWriter).md new file mode 100644 index 00000000..cb8aee7d --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/GetHandleLineBreak(thisIWriter).md @@ -0,0 +1,25 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.GetHandleLineBreak\(this IWriter\) Method + +Gets whether line break in the xml documentation should be handled in the generated markdown\. +This setting is used by the [MarkdownWriter](../../Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. + +```csharp +public static bool GetHandleLineBreak(this DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') for which to get this setting\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +Whether line break in the xml documentation should be handled in the generated markdown\. + +### See Also +- [Markdown\.HandleLineBreak](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_HandleLineBreak 'https://github\.com/Doraku/DefaultDocumentation\#MarkdownConfiguration\_HandleLineBreak') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/GetRenderAsRaw(thisIWriter).md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/GetRenderAsRaw(thisIWriter).md new file mode 100644 index 00000000..0893d4f3 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/GetRenderAsRaw(thisIWriter).md @@ -0,0 +1,22 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.GetRenderAsRaw\(this IWriter\) Method + +Gets whether the writer should append the next strings as is without sanitizing it\. +This setting is used by the [MarkdownWriter](../../Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. + +```csharp +public static bool GetRenderAsRaw(this DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') for which to get this setting\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +Whether strings should be sanitized\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/GetUrlFormat(thisIWriter).md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/GetUrlFormat(thisIWriter).md new file mode 100644 index 00000000..44361258 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/GetUrlFormat(thisIWriter).md @@ -0,0 +1,32 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.GetUrlFormat\(this IWriter\) Method + +Gets the format that will be used to display urls\. + +```csharp +public static string GetUrlFormat(this DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') for which to get this setting\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Whether line break in the xml documentation should be handled in the generated markdown\. + +### Remarks +Three arguments will be passed to the format: +1. the displayed text +2. the url +3. the tooltip to display when overing the link. If null the url will be used + +The default value is `[{0}]({1} '{2}')`\. + +### See Also +- [Markdown\.UrlFormat](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_UrlFormat 'https://github\.com/Doraku/DefaultDocumentation\#MarkdownConfiguration\_UrlFormat') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/SetCurrentItem(thisIWriter,DocItem).md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/SetCurrentItem(thisIWriter,DocItem).md new file mode 100644 index 00000000..fa921be5 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/SetCurrentItem(thisIWriter,DocItem).md @@ -0,0 +1,28 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.SetCurrentItem\(this IWriter, DocItem\) Method + +Sets the current item that is being processed by this [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +It can be different from the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/DocItem.md 'DefaultDocumentation\.IPageContext\.DocItem') when inlining child documentation in its parent page\. + +```csharp +public static DefaultDocumentation.Api.IWriter SetCurrentItem(this DefaultDocumentation.Api.IWriter writer, DefaultDocumentation.Models.DocItem value); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') for which to set the current item\. + + + +`value` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which the documentation is being generated\. + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/SetDisplayAsSingleLine(thisIWriter,Nullable_bool_).md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/SetDisplayAsSingleLine(thisIWriter,Nullable_bool_).md new file mode 100644 index 00000000..65a996b3 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/SetDisplayAsSingleLine(thisIWriter,Nullable_bool_).md @@ -0,0 +1,28 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.SetDisplayAsSingleLine\(this IWriter, Nullable\\) Method + +Sets whether all futur data appended to the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') should stay on the same line \(usefull for table\)\. +This setting is used by the [MarkdownWriter](../../Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. + +```csharp +public static DefaultDocumentation.Api.IWriter SetDisplayAsSingleLine(this DefaultDocumentation.Api.IWriter writer, System.Nullable value); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') for which to set this setting\. + + + +`value` [System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') + +Whether all futur data to happend should stay on the same line\. + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/SetHandleLineBreak(thisIWriter,Nullable_bool_).md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/SetHandleLineBreak(thisIWriter,Nullable_bool_).md new file mode 100644 index 00000000..8c4153e9 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/SetHandleLineBreak(thisIWriter,Nullable_bool_).md @@ -0,0 +1,31 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.SetHandleLineBreak\(this IWriter, Nullable\\) Method + +Sets whether line break in the xml documentation should be handled in the generated markdown\. +This setting is used by the [MarkdownWriter](../../Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. + +```csharp +public static DefaultDocumentation.Api.IWriter SetHandleLineBreak(this DefaultDocumentation.Api.IWriter writer, System.Nullable value); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') for which to set this setting\. + + + +`value` [System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') + +Whether line break in the xml documentation should be handled in the generated markdown\. + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +### See Also +- [Markdown\.HandleLineBreak](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_HandleLineBreak 'https://github\.com/Doraku/DefaultDocumentation\#MarkdownConfiguration\_HandleLineBreak') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/SetRenderAsRaw(thisIWriter,Nullable_bool_).md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/SetRenderAsRaw(thisIWriter,Nullable_bool_).md new file mode 100644 index 00000000..f4f5653f --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/SetRenderAsRaw(thisIWriter,Nullable_bool_).md @@ -0,0 +1,28 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.SetRenderAsRaw\(this IWriter, Nullable\\) Method + +Sets whether the writer should append the next strings as is without sanitizing it\. +This setting is used by the [MarkdownWriter](../../Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. + +```csharp +public static DefaultDocumentation.Api.IWriter SetRenderAsRaw(this DefaultDocumentation.Api.IWriter writer, System.Nullable value); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') for which to set this setting\. + + + +`value` [System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') + +Whether strings should be sanitized\. + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/SetUrlFormat(thisIWriter,string).md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/SetUrlFormat(thisIWriter,string).md new file mode 100644 index 00000000..f50e2963 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/SetUrlFormat(thisIWriter,string).md @@ -0,0 +1,30 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.SetUrlFormat\(this IWriter, string\) Method + +Sets the format that will be used to display url\. + +```csharp +public static DefaultDocumentation.Api.IWriter SetUrlFormat(this DefaultDocumentation.Api.IWriter writer, string? value); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') for which to set this setting\. + + + +`value` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The format to use to display urls\. + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +### See Also +- [Markdown\.UrlFormat](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_UrlFormat 'https://github\.com/Doraku/DefaultDocumentation\#MarkdownConfiguration\_UrlFormat') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/ToOverrideWriter(thisIWriter).md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/ToOverrideWriter(thisIWriter).md new file mode 100644 index 00000000..be9fe860 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/ToOverrideWriter(thisIWriter).md @@ -0,0 +1,21 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.ToOverrideWriter\(this IWriter\) Method + +Decorates the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') with a [OverrideWriter](../../Markdown/Writers/OverrideWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter') to override its setting in a given scope\. + +```csharp +public static DefaultDocumentation.Api.IWriter ToOverrideWriter(this DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to decorate\. + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The decorated [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/ToPrefixedWriter(thisIWriter,string).md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/ToPrefixedWriter(thisIWriter,string).md new file mode 100644 index 00000000..80efac12 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/ToPrefixedWriter(thisIWriter,string).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api').[IWriterExtensions](index.md 'DefaultDocumentation\.Api\.IWriterExtensions') + +## IWriterExtensions\.ToPrefixedWriter\(this IWriter, string\) Method + +Decorates the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') with a [PrefixedWriter](../../Markdown/Writers/PrefixedWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter') to prefix every new line with the given prefix\. + +```csharp +public static DefaultDocumentation.Api.IWriter ToPrefixedWriter(this DefaultDocumentation.Api.IWriter writer, string prefix); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to decorate\. + + + +`prefix` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The string to prefix every new line with\. + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The decorated [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/index.md b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/index.md new file mode 100644 index 00000000..26e87656 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Api/IWriterExtensions/index.md @@ -0,0 +1,35 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Api](../../../index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api') + +## IWriterExtensions Class + +Provides extension methods on the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') type\. + +```csharp +public static class IWriterExtensions +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 IWriterExtensions + +| Methods | | +| :--- | :--- | +| [AppendAsMarkdown\(this IWriter, XElement\)](AppendAsMarkdown(thisIWriter,XElement).md 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendAsMarkdown\(this DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)') | Appends a [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') decorating the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') with a [MarkdownWriter](../../Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter')\. | +| [AppendAsRaw\(this IWriter\)](AppendAsRaw(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendAsRaw\(this DefaultDocumentation\.Api\.IWriter\)') | Append a string without sanitizing it for markdown regardless of the current [GetRenderAsRaw\(this IWriter\)](GetRenderAsRaw(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.GetRenderAsRaw\(this DefaultDocumentation\.Api\.IWriter\)') value\. | +| [AppendLink\(this IWriter, DocItem, INamedElement\)](AppendLink.md#DefaultDocumentation.Api.IWriterExtensions.AppendLink(thisDefaultDocumentation.Api.IWriter,DefaultDocumentation.Models.DocItem,INamedElement) 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendLink\(this DefaultDocumentation\.Api\.IWriter, DefaultDocumentation\.Models\.DocItem, INamedElement\)') | Append an link to an [ICSharpCode\.Decompiler\.TypeSystem\.INamedElement](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.TypeSystem.INamedElement 'ICSharpCode\.Decompiler\.TypeSystem\.INamedElement') in the markdown format\. | +| [AppendLink\(this IWriter, DocItem, string\)](AppendLink.md#DefaultDocumentation.Api.IWriterExtensions.AppendLink(thisDefaultDocumentation.Api.IWriter,DefaultDocumentation.Models.DocItem,string) 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendLink\(this DefaultDocumentation\.Api\.IWriter, DefaultDocumentation\.Models\.DocItem, string\)') | Append an link to a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') in the markdown format\. | +| [AppendLink\(this IWriter, string, string\)](AppendLink.md#DefaultDocumentation.Api.IWriterExtensions.AppendLink(thisDefaultDocumentation.Api.IWriter,string,string) 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendLink\(this DefaultDocumentation\.Api\.IWriter, string, string\)') | Append an link to an id using [UrlFactories](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/UrlFactories.md 'DefaultDocumentation\.IGeneralContext\.UrlFactories') to resolve the url in the markdown format\. | +| [AppendUrl\(this IWriter, string, string, string\)](AppendUrl(thisIWriter,string,string,string).md 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendUrl\(this DefaultDocumentation\.Api\.IWriter, string, string, string\)') | Append an url in the markdown format\. | +| [EnsureLineStart\(this IWriter\)](EnsureLineStart(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.EnsureLineStart\(this DefaultDocumentation\.Api\.IWriter\)') | Ensures that the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') ends with a line break and call [AppendLine\(\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/AppendLine().md 'DefaultDocumentation\.Api\.IWriter\.AppendLine') if it's not the case\. | +| [EnsureLineStartAndAppendLine\(this IWriter\)](EnsureLineStartAndAppendLine(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.EnsureLineStartAndAppendLine\(this DefaultDocumentation\.Api\.IWriter\)') | Calls [EnsureLineStart\(this IWriter\)](EnsureLineStart(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.EnsureLineStart\(this DefaultDocumentation\.Api\.IWriter\)') and [AppendLine\(\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/AppendLine().md 'DefaultDocumentation\.Api\.IWriter\.AppendLine')\. | +| [GetCurrentItem\(this IWriter\)](GetCurrentItem(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.GetCurrentItem\(this DefaultDocumentation\.Api\.IWriter\)') | Gets the current item that is being processed by this [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. It can be different from the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/DocItem.md 'DefaultDocumentation\.IPageContext\.DocItem') when inlining child documentation in its parent page\. | +| [GetDisplayAsSingleLine\(this IWriter\)](GetDisplayAsSingleLine(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.GetDisplayAsSingleLine\(this DefaultDocumentation\.Api\.IWriter\)') | Gets whether all futur data appended to the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') should stay on the same line \(usefull for table\)\. This setting is used by the [MarkdownWriter](../../Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. | +| [GetHandleLineBreak\(this IWriter\)](GetHandleLineBreak(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.GetHandleLineBreak\(this DefaultDocumentation\.Api\.IWriter\)') | Gets whether line break in the xml documentation should be handled in the generated markdown\. This setting is used by the [MarkdownWriter](../../Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. | +| [GetRenderAsRaw\(this IWriter\)](GetRenderAsRaw(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.GetRenderAsRaw\(this DefaultDocumentation\.Api\.IWriter\)') | Gets whether the writer should append the next strings as is without sanitizing it\. This setting is used by the [MarkdownWriter](../../Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. | +| [GetUrlFormat\(this IWriter\)](GetUrlFormat(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.GetUrlFormat\(this DefaultDocumentation\.Api\.IWriter\)') | Gets the format that will be used to display urls\. | +| [SetCurrentItem\(this IWriter, DocItem\)](SetCurrentItem(thisIWriter,DocItem).md 'DefaultDocumentation\.Api\.IWriterExtensions\.SetCurrentItem\(this DefaultDocumentation\.Api\.IWriter, DefaultDocumentation\.Models\.DocItem\)') | Sets the current item that is being processed by this [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. It can be different from the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/DocItem.md 'DefaultDocumentation\.IPageContext\.DocItem') when inlining child documentation in its parent page\. | +| [SetDisplayAsSingleLine\(this IWriter, Nullable<bool>\)](SetDisplayAsSingleLine(thisIWriter,Nullable_bool_).md 'DefaultDocumentation\.Api\.IWriterExtensions\.SetDisplayAsSingleLine\(this DefaultDocumentation\.Api\.IWriter, System\.Nullable\\)') | Sets whether all futur data appended to the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') should stay on the same line \(usefull for table\)\. This setting is used by the [MarkdownWriter](../../Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. | +| [SetHandleLineBreak\(this IWriter, Nullable<bool>\)](SetHandleLineBreak(thisIWriter,Nullable_bool_).md 'DefaultDocumentation\.Api\.IWriterExtensions\.SetHandleLineBreak\(this DefaultDocumentation\.Api\.IWriter, System\.Nullable\\)') | Sets whether line break in the xml documentation should be handled in the generated markdown\. This setting is used by the [MarkdownWriter](../../Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. | +| [SetRenderAsRaw\(this IWriter, Nullable<bool>\)](SetRenderAsRaw(thisIWriter,Nullable_bool_).md 'DefaultDocumentation\.Api\.IWriterExtensions\.SetRenderAsRaw\(this DefaultDocumentation\.Api\.IWriter, System\.Nullable\\)') | Sets whether the writer should append the next strings as is without sanitizing it\. This setting is used by the [MarkdownWriter](../../Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. | +| [SetUrlFormat\(this IWriter, string\)](SetUrlFormat(thisIWriter,string).md 'DefaultDocumentation\.Api\.IWriterExtensions\.SetUrlFormat\(this DefaultDocumentation\.Api\.IWriter, string\)') | Sets the format that will be used to display url\. | +| [ToOverrideWriter\(this IWriter\)](ToOverrideWriter(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.ToOverrideWriter\(this DefaultDocumentation\.Api\.IWriter\)') | Decorates the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') with a [OverrideWriter](../../Markdown/Writers/OverrideWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter') to override its setting in a given scope\. | +| [ToPrefixedWriter\(this IWriter, string\)](ToPrefixedWriter(thisIWriter,string).md 'DefaultDocumentation\.Api\.IWriterExtensions\.ToPrefixedWriter\(this DefaultDocumentation\.Api\.IWriter, string\)') | Decorates the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') with a [PrefixedWriter](../../Markdown/Writers/PrefixedWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter') to prefix every new line with the given prefix\. | diff --git a/documentation/markdown/DefaultDocumentation/IGeneralContextExtensions/GetChildren_T_(thisIGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/IGeneralContextExtensions/GetChildren_T_(thisIGeneralContext,DocItem).md new file mode 100644 index 00000000..87c2a677 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/IGeneralContextExtensions/GetChildren_T_(thisIGeneralContext,DocItem).md @@ -0,0 +1,35 @@ +#### [DefaultDocumentation\.Markdown](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContextExtensions](index.md 'DefaultDocumentation\.IGeneralContextExtensions') + +## IGeneralContextExtensions\.GetChildren\\(this IGeneralContext, DocItem\) Method + +Gets the children of a specific [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') type of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') instance\. + +```csharp +public static System.Collections.Generic.IEnumerable GetChildren(this DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item) + where T : DefaultDocumentation.Models.DocItem; +``` +#### Type parameters + + + +`T` + +The type of the children to look for\. +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation file\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') instance for which to get its children\. + +#### Returns +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[T](DefaultDocumentation/IGeneralContextExtensions/GetChildren_T_(thisIGeneralContext,DocItem).md#DefaultDocumentation.IGeneralContextExtensions.GetChildren_T_(thisDefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem).T 'DefaultDocumentation\.IGeneralContextExtensions\.GetChildren\\(this DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)\.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') +The children of the provided [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/IGeneralContextExtensions/GetInvalidCharReplacement(thisIGeneralContext).md b/documentation/markdown/DefaultDocumentation/IGeneralContextExtensions/GetInvalidCharReplacement(thisIGeneralContext).md new file mode 100644 index 00000000..9b64ffe1 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/IGeneralContextExtensions/GetInvalidCharReplacement(thisIGeneralContext).md @@ -0,0 +1,21 @@ +#### [DefaultDocumentation\.Markdown](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContextExtensions](index.md 'DefaultDocumentation\.IGeneralContextExtensions') + +## IGeneralContextExtensions\.GetInvalidCharReplacement\(this IGeneralContext\) Method + +Gets the [Markdown\.InvalidCharReplacement](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_InvalidCharReplacement 'https://github\.com/Doraku/DefaultDocumentation\#MarkdownConfiguration\_InvalidCharReplacement') setting\. + +```csharp +public static string? GetInvalidCharReplacement(this DefaultDocumentation.IGeneralContext context); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation file\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +The [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') to use to replace invalid chars in generated file name\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/IGeneralContextExtensions/GetNestedTypeVisibilities(thisIGeneralContext,Type).md b/documentation/markdown/DefaultDocumentation/IGeneralContextExtensions/GetNestedTypeVisibilities(thisIGeneralContext,Type).md new file mode 100644 index 00000000..fa59e134 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/IGeneralContextExtensions/GetNestedTypeVisibilities(thisIGeneralContext,Type).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Markdown](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContextExtensions](index.md 'DefaultDocumentation\.IGeneralContextExtensions') + +## IGeneralContextExtensions\.GetNestedTypeVisibilities\(this IGeneralContext, Type\) Method + +Gets the [Markdown\.NestedTypeVisibilities](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_NestedTypeVisibilities 'https://github\.com/Doraku/DefaultDocumentation\#MarkdownConfiguration\_NestedTypeVisibilities') setting\. + +```csharp +public static DefaultDocumentation.Markdown.NestedTypeVisibilities GetNestedTypeVisibilities(this DefaultDocumentation.IGeneralContext context, System.Type type); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation file\. + + + +`type` [System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') + +The [System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') for which to get the setting\. + +#### Returns +[NestedTypeVisibilities](../Markdown/NestedTypeVisibilities/index.md 'DefaultDocumentation\.Markdown\.NestedTypeVisibilities') +The [NestedTypeVisibilities](../Markdown/NestedTypeVisibilities/index.md 'DefaultDocumentation\.Markdown\.NestedTypeVisibilities') to use\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/IGeneralContextExtensions/GetRemoveFileExtensionFromUrl(thisIGeneralContext).md b/documentation/markdown/DefaultDocumentation/IGeneralContextExtensions/GetRemoveFileExtensionFromUrl(thisIGeneralContext).md new file mode 100644 index 00000000..1c79b7e1 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/IGeneralContextExtensions/GetRemoveFileExtensionFromUrl(thisIGeneralContext).md @@ -0,0 +1,21 @@ +#### [DefaultDocumentation\.Markdown](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContextExtensions](index.md 'DefaultDocumentation\.IGeneralContextExtensions') + +## IGeneralContextExtensions\.GetRemoveFileExtensionFromUrl\(this IGeneralContext\) Method + +Gets the [Markdown\.RemoveFileExtensionFromUrl](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_RemoveFileExtensionFromUrl 'https://github\.com/Doraku/DefaultDocumentation\#MarkdownConfiguration\_RemoveFileExtensionFromUrl') setting\. + +```csharp +public static bool GetRemoveFileExtensionFromUrl(this DefaultDocumentation.IGeneralContext context); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation file\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +Whether to include the file extension in urls\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/IGeneralContextExtensions/GetUseFullUrl(thisIGeneralContext).md b/documentation/markdown/DefaultDocumentation/IGeneralContextExtensions/GetUseFullUrl(thisIGeneralContext).md new file mode 100644 index 00000000..95c8ed65 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/IGeneralContextExtensions/GetUseFullUrl(thisIGeneralContext).md @@ -0,0 +1,20 @@ +#### [DefaultDocumentation\.Markdown](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContextExtensions](index.md 'DefaultDocumentation\.IGeneralContextExtensions') + +## IGeneralContextExtensions\.GetUseFullUrl\(this IGeneralContext\) Method + +Gets the [Markdown\.UseFullUrl](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_UseFullUrl 'https://github\.com/Doraku/DefaultDocumentation\#MarkdownConfiguration\_UseFullUrl') setting\. + +```csharp +public static bool GetUseFullUrl(this DefaultDocumentation.IGeneralContext context); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation file\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/IGeneralContextExtensions/index.md b/documentation/markdown/DefaultDocumentation/IGeneralContextExtensions/index.md new file mode 100644 index 00000000..eaa79b7f --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/IGeneralContextExtensions/index.md @@ -0,0 +1,20 @@ +#### [DefaultDocumentation\.Markdown](../../index.md 'index') +### [DefaultDocumentation](../../index.md#DefaultDocumentation 'DefaultDocumentation') + +## IGeneralContextExtensions Class + +Provides extension methods on the [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') type\. + +```csharp +public static class IGeneralContextExtensions +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 IGeneralContextExtensions + +| Methods | | +| :--- | :--- | +| [GetChildren<T>\(this IGeneralContext, DocItem\)](GetChildren_T_(thisIGeneralContext,DocItem).md 'DefaultDocumentation\.IGeneralContextExtensions\.GetChildren\\(this DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the children of a specific [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') type of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') instance\. | +| [GetInvalidCharReplacement\(this IGeneralContext\)](GetInvalidCharReplacement(thisIGeneralContext).md 'DefaultDocumentation\.IGeneralContextExtensions\.GetInvalidCharReplacement\(this DefaultDocumentation\.IGeneralContext\)') | Gets the [Markdown\.InvalidCharReplacement](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_InvalidCharReplacement 'https://github\.com/Doraku/DefaultDocumentation\#MarkdownConfiguration\_InvalidCharReplacement') setting\. | +| [GetNestedTypeVisibilities\(this IGeneralContext, Type\)](GetNestedTypeVisibilities(thisIGeneralContext,Type).md 'DefaultDocumentation\.IGeneralContextExtensions\.GetNestedTypeVisibilities\(this DefaultDocumentation\.IGeneralContext, System\.Type\)') | Gets the [Markdown\.NestedTypeVisibilities](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_NestedTypeVisibilities 'https://github\.com/Doraku/DefaultDocumentation\#MarkdownConfiguration\_NestedTypeVisibilities') setting\. | +| [GetRemoveFileExtensionFromUrl\(this IGeneralContext\)](GetRemoveFileExtensionFromUrl(thisIGeneralContext).md 'DefaultDocumentation\.IGeneralContextExtensions\.GetRemoveFileExtensionFromUrl\(this DefaultDocumentation\.IGeneralContext\)') | Gets the [Markdown\.RemoveFileExtensionFromUrl](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_RemoveFileExtensionFromUrl 'https://github\.com/Doraku/DefaultDocumentation\#MarkdownConfiguration\_RemoveFileExtensionFromUrl') setting\. | +| [GetUseFullUrl\(this IGeneralContext\)](GetUseFullUrl(thisIGeneralContext).md 'DefaultDocumentation\.IGeneralContextExtensions\.GetUseFullUrl\(this DefaultDocumentation\.IGeneralContext\)') | Gets the [Markdown\.UseFullUrl](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_UseFullUrl 'https://github\.com/Doraku/DefaultDocumentation\#MarkdownConfiguration\_UseFullUrl') setting\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/ConfigName.md new file mode 100644 index 00000000..0e48aa48 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.DocItemGenerators](../../../../index.md#DefaultDocumentation.Markdown.DocItemGenerators 'DefaultDocumentation\.Markdown\.DocItemGenerators').[ExcludeGenerator](index.md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.ExcludeGenerator') + +## ExcludeGenerator\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Exclude"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/Generate(IDocItemsContext).md b/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/Generate(IDocItemsContext).md new file mode 100644 index 00000000..12e7f265 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/Generate(IDocItemsContext).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.DocItemGenerators](../../../../index.md#DefaultDocumentation.Markdown.DocItemGenerators 'DefaultDocumentation\.Markdown\.DocItemGenerators').[ExcludeGenerator](index.md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.ExcludeGenerator') + +## ExcludeGenerator\.Generate\(IDocItemsContext\) Method + +Modified the known [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') of the [IDocItemsContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext')\. + +```csharp +public void Generate(DefaultDocumentation.IDocItemsContext context); +``` +#### Parameters + + + +`context` [IDocItemsContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext') + +The [IDocItemsContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext') of the documentation generation\. + +Implements [Generate\(IDocItemsContext\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/Generate(IDocItemsContext).md 'DefaultDocumentation\.Api\.IDocItemGenerator\.Generate\(DefaultDocumentation\.IDocItemsContext\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/Name.md new file mode 100644 index 00000000..ccff573d --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.DocItemGenerators](../../../../index.md#DefaultDocumentation.Markdown.DocItemGenerators 'DefaultDocumentation\.Markdown\.DocItemGenerators').[ExcludeGenerator](index.md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.ExcludeGenerator') + +## ExcludeGenerator\.Name Property + +Gets the name of the generator, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/Name.md 'DefaultDocumentation\.Api\.IDocItemGenerator\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/index.md b/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/index.md new file mode 100644 index 00000000..8cb3b30a --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.DocItemGenerators](../../../../index.md#DefaultDocumentation.Markdown.DocItemGenerators 'DefaultDocumentation\.Markdown\.DocItemGenerators') + +## ExcludeGenerator Class + +Implementation of the [IDocItemGenerator](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/index.md 'DefaultDocumentation\.Api\.IDocItemGenerator') to remove [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') from the documentation generation based on [Markdown\.Exclude](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_Exclude 'https://github\.com/Doraku/DefaultDocumentation\#MarkdownConfiguration\_Exclude')\. + +```csharp +public sealed class ExcludeGenerator : DefaultDocumentation.Api.IDocItemGenerator +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ExcludeGenerator + +Implements [IDocItemGenerator](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/index.md 'DefaultDocumentation\.Api\.IDocItemGenerator') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.ExcludeGenerator\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.ExcludeGenerator\.Name') | Gets the name of the generator, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Generate\(IDocItemsContext\)](Generate(IDocItemsContext).md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.ExcludeGenerator\.Generate\(DefaultDocumentation\.IDocItemsContext\)') | Modified the known [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') of the [IDocItemsContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/ConfigName.md new file mode 100644 index 00000000..0726f448 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.DocItemGenerators](../../../../index.md#DefaultDocumentation.Markdown.DocItemGenerators 'DefaultDocumentation\.Markdown\.DocItemGenerators').[OverloadsGenerator](index.md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.OverloadsGenerator') + +## OverloadsGenerator\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Overloads"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/Generate(IDocItemsContext).md b/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/Generate(IDocItemsContext).md new file mode 100644 index 00000000..16c5940b --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/Generate(IDocItemsContext).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.DocItemGenerators](../../../../index.md#DefaultDocumentation.Markdown.DocItemGenerators 'DefaultDocumentation\.Markdown\.DocItemGenerators').[OverloadsGenerator](index.md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.OverloadsGenerator') + +## OverloadsGenerator\.Generate\(IDocItemsContext\) Method + +Modified the known [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') of the [IDocItemsContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext')\. + +```csharp +public void Generate(DefaultDocumentation.IDocItemsContext context); +``` +#### Parameters + + + +`context` [IDocItemsContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext') + +The [IDocItemsContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext') of the documentation generation\. + +Implements [Generate\(IDocItemsContext\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/Generate(IDocItemsContext).md 'DefaultDocumentation\.Api\.IDocItemGenerator\.Generate\(DefaultDocumentation\.IDocItemsContext\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/Name.md new file mode 100644 index 00000000..9a74a9eb --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.DocItemGenerators](../../../../index.md#DefaultDocumentation.Markdown.DocItemGenerators 'DefaultDocumentation\.Markdown\.DocItemGenerators').[OverloadsGenerator](index.md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.OverloadsGenerator') + +## OverloadsGenerator\.Name Property + +Gets the name of the generator, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/Name.md 'DefaultDocumentation\.Api\.IDocItemGenerator\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/index.md b/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/index.md new file mode 100644 index 00000000..db3e5b7c --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.DocItemGenerators](../../../../index.md#DefaultDocumentation.Markdown.DocItemGenerators 'DefaultDocumentation\.Markdown\.DocItemGenerators') + +## OverloadsGenerator Class + +Implementation of the [IDocItemGenerator](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/index.md 'DefaultDocumentation\.Api\.IDocItemGenerator') to add [ConstructorOverloadsDocItem](../../Models/ConstructorOverloadsDocItem/index.md 'DefaultDocumentation\.Markdown\.Models\.ConstructorOverloadsDocItem') and [MethodOverloadsDocItem](../../Models/MethodOverloadsDocItem/index.md 'DefaultDocumentation\.Markdown\.Models\.MethodOverloadsDocItem') to the documentation generated\. + +```csharp +public sealed class OverloadsGenerator : DefaultDocumentation.Api.IDocItemGenerator +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 OverloadsGenerator + +Implements [IDocItemGenerator](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/index.md 'DefaultDocumentation\.Api\.IDocItemGenerator') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.OverloadsGenerator\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.OverloadsGenerator\.Name') | Gets the name of the generator, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Generate\(IDocItemsContext\)](Generate(IDocItemsContext).md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.OverloadsGenerator\.Generate\(DefaultDocumentation\.IDocItemsContext\)') | Modified the known [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') of the [IDocItemsContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/BrElement/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/BrElement/ConfigName.md new file mode 100644 index 00000000..93e18120 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/BrElement/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[BrElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.BrElement') + +## BrElement\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "br"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/BrElement/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/BrElement/Name.md new file mode 100644 index 00000000..8569d3d2 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/BrElement/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[BrElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.BrElement') + +## BrElement\.Name Property + +Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/Name.md 'DefaultDocumentation\.Api\.IElement\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/BrElement/Write(IWriter,XElement).md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/BrElement/Write(IWriter,XElement).md new file mode 100644 index 00000000..a5309175 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/BrElement/Write(IWriter,XElement).md @@ -0,0 +1,25 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[BrElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.BrElement') + +## BrElement\.Write\(IWriter, XElement\) Method + +Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + + + +`element` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') to write\. + +Implements [Write\(IWriter, XElement\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Api\.IElement\.Write\(DefaultDocumentation\.Api\.IWriter,System\.Xml\.Linq\.XElement\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/BrElement/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/BrElement/index.md new file mode 100644 index 00000000..6ff7884b --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/BrElement/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements') + +## BrElement Class + +Handles `br` xml element\. + +```csharp +public sealed class BrElement : DefaultDocumentation.Api.IElement +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 BrElement + +Implements [IElement](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/index.md 'DefaultDocumentation\.Api\.IElement') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Elements\.BrElement\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Elements\.BrElement\.Name') | Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter, XElement\)](Write(IWriter,XElement).md 'DefaultDocumentation\.Markdown\.Elements\.BrElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)') | Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/CElement/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/CElement/ConfigName.md new file mode 100644 index 00000000..f01c0374 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/CElement/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[CElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.CElement') + +## CElement\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "c"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/CElement/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/CElement/Name.md new file mode 100644 index 00000000..f4f66bd3 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/CElement/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[CElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.CElement') + +## CElement\.Name Property + +Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/Name.md 'DefaultDocumentation\.Api\.IElement\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/CElement/Write(IWriter,XElement).md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/CElement/Write(IWriter,XElement).md new file mode 100644 index 00000000..5ff6c291 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/CElement/Write(IWriter,XElement).md @@ -0,0 +1,25 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[CElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.CElement') + +## CElement\.Write\(IWriter, XElement\) Method + +Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + + + +`element` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') to write\. + +Implements [Write\(IWriter, XElement\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Api\.IElement\.Write\(DefaultDocumentation\.Api\.IWriter,System\.Xml\.Linq\.XElement\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/CElement/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/CElement/index.md new file mode 100644 index 00000000..63f87948 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/CElement/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements') + +## CElement Class + +Handles `c` xml element\. + +```csharp +public sealed class CElement : DefaultDocumentation.Api.IElement +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 CElement + +Implements [IElement](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/index.md 'DefaultDocumentation\.Api\.IElement') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Elements\.CElement\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Elements\.CElement\.Name') | Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter, XElement\)](Write(IWriter,XElement).md 'DefaultDocumentation\.Markdown\.Elements\.CElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)') | Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/CodeElement/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/CodeElement/ConfigName.md new file mode 100644 index 00000000..5c97f51c --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/CodeElement/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[CodeElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.CodeElement') + +## CodeElement\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "code"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/CodeElement/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/CodeElement/Name.md new file mode 100644 index 00000000..4ee4396d --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/CodeElement/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[CodeElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.CodeElement') + +## CodeElement\.Name Property + +Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/Name.md 'DefaultDocumentation\.Api\.IElement\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/CodeElement/Write(IWriter,XElement).md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/CodeElement/Write(IWriter,XElement).md new file mode 100644 index 00000000..8b19b517 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/CodeElement/Write(IWriter,XElement).md @@ -0,0 +1,25 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[CodeElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.CodeElement') + +## CodeElement\.Write\(IWriter, XElement\) Method + +Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + + + +`element` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') to write\. + +Implements [Write\(IWriter, XElement\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Api\.IElement\.Write\(DefaultDocumentation\.Api\.IWriter,System\.Xml\.Linq\.XElement\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/CodeElement/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/CodeElement/index.md new file mode 100644 index 00000000..0652e769 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/CodeElement/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements') + +## CodeElement Class + +Handles `code` xml element\. + +```csharp +public sealed class CodeElement : DefaultDocumentation.Api.IElement +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 CodeElement + +Implements [IElement](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/index.md 'DefaultDocumentation\.Api\.IElement') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Elements\.CodeElement\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Elements\.CodeElement\.Name') | Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter, XElement\)](Write(IWriter,XElement).md 'DefaultDocumentation\.Markdown\.Elements\.CodeElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)') | Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/ListElement/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ListElement/ConfigName.md new file mode 100644 index 00000000..026a7a12 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ListElement/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[ListElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.ListElement') + +## ListElement\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "list"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/ListElement/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ListElement/Name.md new file mode 100644 index 00000000..72020ef3 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ListElement/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[ListElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.ListElement') + +## ListElement\.Name Property + +Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/Name.md 'DefaultDocumentation\.Api\.IElement\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/ListElement/Write(IWriter,XElement).md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ListElement/Write(IWriter,XElement).md new file mode 100644 index 00000000..dc11b3fc --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ListElement/Write(IWriter,XElement).md @@ -0,0 +1,25 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[ListElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.ListElement') + +## ListElement\.Write\(IWriter, XElement\) Method + +Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + + + +`element` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') to write\. + +Implements [Write\(IWriter, XElement\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Api\.IElement\.Write\(DefaultDocumentation\.Api\.IWriter,System\.Xml\.Linq\.XElement\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/ListElement/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ListElement/index.md new file mode 100644 index 00000000..56baddf3 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ListElement/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements') + +## ListElement Class + +Handles `list` xml element\. + +```csharp +public sealed class ListElement : DefaultDocumentation.Api.IElement +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ListElement + +Implements [IElement](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/index.md 'DefaultDocumentation\.Api\.IElement') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Elements\.ListElement\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Elements\.ListElement\.Name') | Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter, XElement\)](Write(IWriter,XElement).md 'DefaultDocumentation\.Markdown\.Elements\.ListElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)') | Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/NoteElement/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/NoteElement/ConfigName.md new file mode 100644 index 00000000..51c4cc7d --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/NoteElement/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[NoteElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.NoteElement') + +## NoteElement\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "note"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/NoteElement/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/NoteElement/Name.md new file mode 100644 index 00000000..4b52cf64 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/NoteElement/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[NoteElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.NoteElement') + +## NoteElement\.Name Property + +Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/Name.md 'DefaultDocumentation\.Api\.IElement\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/NoteElement/Write(IWriter,XElement).md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/NoteElement/Write(IWriter,XElement).md new file mode 100644 index 00000000..1d0742d1 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/NoteElement/Write(IWriter,XElement).md @@ -0,0 +1,25 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[NoteElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.NoteElement') + +## NoteElement\.Write\(IWriter, XElement\) Method + +Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + + + +`element` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') to write\. + +Implements [Write\(IWriter, XElement\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Api\.IElement\.Write\(DefaultDocumentation\.Api\.IWriter,System\.Xml\.Linq\.XElement\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/NoteElement/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/NoteElement/index.md new file mode 100644 index 00000000..60d04588 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/NoteElement/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements') + +## NoteElement Class + +Handles `note` xml element\. + +```csharp +public sealed class NoteElement : DefaultDocumentation.Api.IElement +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 NoteElement + +Implements [IElement](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/index.md 'DefaultDocumentation\.Api\.IElement') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Elements\.NoteElement\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Elements\.NoteElement\.Name') | Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter, XElement\)](Write(IWriter,XElement).md 'DefaultDocumentation\.Markdown\.Elements\.NoteElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)') | Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParaElement/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParaElement/ConfigName.md new file mode 100644 index 00000000..a45b82ac --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParaElement/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[ParaElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.ParaElement') + +## ParaElement\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "para"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParaElement/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParaElement/Name.md new file mode 100644 index 00000000..3e931bee --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParaElement/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[ParaElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.ParaElement') + +## ParaElement\.Name Property + +Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/Name.md 'DefaultDocumentation\.Api\.IElement\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParaElement/Write(IWriter,XElement).md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParaElement/Write(IWriter,XElement).md new file mode 100644 index 00000000..d311a2c0 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParaElement/Write(IWriter,XElement).md @@ -0,0 +1,25 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[ParaElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.ParaElement') + +## ParaElement\.Write\(IWriter, XElement\) Method + +Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + + + +`element` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') to write\. + +Implements [Write\(IWriter, XElement\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Api\.IElement\.Write\(DefaultDocumentation\.Api\.IWriter,System\.Xml\.Linq\.XElement\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParaElement/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParaElement/index.md new file mode 100644 index 00000000..e41c4ece --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParaElement/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements') + +## ParaElement Class + +Handles `para` xml element\. + +```csharp +public sealed class ParaElement : DefaultDocumentation.Api.IElement +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ParaElement + +Implements [IElement](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/index.md 'DefaultDocumentation\.Api\.IElement') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Elements\.ParaElement\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Elements\.ParaElement\.Name') | Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter, XElement\)](Write(IWriter,XElement).md 'DefaultDocumentation\.Markdown\.Elements\.ParaElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)') | Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParamRefElement/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParamRefElement/ConfigName.md new file mode 100644 index 00000000..d2462a2a --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParamRefElement/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[ParamRefElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.ParamRefElement') + +## ParamRefElement\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "paramref"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParamRefElement/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParamRefElement/Name.md new file mode 100644 index 00000000..564f5515 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParamRefElement/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[ParamRefElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.ParamRefElement') + +## ParamRefElement\.Name Property + +Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/Name.md 'DefaultDocumentation\.Api\.IElement\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParamRefElement/Write(IWriter,XElement).md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParamRefElement/Write(IWriter,XElement).md new file mode 100644 index 00000000..66e3c7b9 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParamRefElement/Write(IWriter,XElement).md @@ -0,0 +1,25 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[ParamRefElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.ParamRefElement') + +## ParamRefElement\.Write\(IWriter, XElement\) Method + +Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + + + +`element` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') to write\. + +Implements [Write\(IWriter, XElement\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Api\.IElement\.Write\(DefaultDocumentation\.Api\.IWriter,System\.Xml\.Linq\.XElement\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParamRefElement/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParamRefElement/index.md new file mode 100644 index 00000000..892b8879 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/ParamRefElement/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements') + +## ParamRefElement Class + +Handles `paramref` xml element\. + +```csharp +public sealed class ParamRefElement : DefaultDocumentation.Api.IElement +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ParamRefElement + +Implements [IElement](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/index.md 'DefaultDocumentation\.Api\.IElement') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Elements\.ParamRefElement\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Elements\.ParamRefElement\.Name') | Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter, XElement\)](Write(IWriter,XElement).md 'DefaultDocumentation\.Markdown\.Elements\.ParamRefElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)') | Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/SeeElement/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/SeeElement/ConfigName.md new file mode 100644 index 00000000..55991b74 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/SeeElement/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[SeeElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.SeeElement') + +## SeeElement\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "see"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/SeeElement/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/SeeElement/Name.md new file mode 100644 index 00000000..4545d3a0 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/SeeElement/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[SeeElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.SeeElement') + +## SeeElement\.Name Property + +Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/Name.md 'DefaultDocumentation\.Api\.IElement\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/SeeElement/Write(IWriter,XElement).md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/SeeElement/Write(IWriter,XElement).md new file mode 100644 index 00000000..871f27ef --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/SeeElement/Write(IWriter,XElement).md @@ -0,0 +1,25 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[SeeElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.SeeElement') + +## SeeElement\.Write\(IWriter, XElement\) Method + +Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + + + +`element` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') to write\. + +Implements [Write\(IWriter, XElement\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Api\.IElement\.Write\(DefaultDocumentation\.Api\.IWriter,System\.Xml\.Linq\.XElement\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/SeeElement/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/SeeElement/index.md new file mode 100644 index 00000000..04a4ede6 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/SeeElement/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements') + +## SeeElement Class + +Handles `see` xml element\. + +```csharp +public sealed class SeeElement : DefaultDocumentation.Api.IElement +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 SeeElement + +Implements [IElement](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/index.md 'DefaultDocumentation\.Api\.IElement') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Elements\.SeeElement\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Elements\.SeeElement\.Name') | Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter, XElement\)](Write(IWriter,XElement).md 'DefaultDocumentation\.Markdown\.Elements\.SeeElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)') | Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/TypeParamRefElement/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/TypeParamRefElement/ConfigName.md new file mode 100644 index 00000000..fa258e05 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/TypeParamRefElement/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[TypeParamRefElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.TypeParamRefElement') + +## TypeParamRefElement\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "typeparamref"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/TypeParamRefElement/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/TypeParamRefElement/Name.md new file mode 100644 index 00000000..9da1b897 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/TypeParamRefElement/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[TypeParamRefElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.TypeParamRefElement') + +## TypeParamRefElement\.Name Property + +Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/Name.md 'DefaultDocumentation\.Api\.IElement\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/TypeParamRefElement/Write(IWriter,XElement).md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/TypeParamRefElement/Write(IWriter,XElement).md new file mode 100644 index 00000000..f3a93f77 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/TypeParamRefElement/Write(IWriter,XElement).md @@ -0,0 +1,25 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements').[TypeParamRefElement](index.md 'DefaultDocumentation\.Markdown\.Elements\.TypeParamRefElement') + +## TypeParamRefElement\.Write\(IWriter, XElement\) Method + +Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + + + +`element` [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') + +The [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') to write\. + +Implements [Write\(IWriter, XElement\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Api\.IElement\.Write\(DefaultDocumentation\.Api\.IWriter,System\.Xml\.Linq\.XElement\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Elements/TypeParamRefElement/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Elements/TypeParamRefElement/index.md new file mode 100644 index 00000000..b5a837dc --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Elements/TypeParamRefElement/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Elements](../../../../index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation\.Markdown\.Elements') + +## TypeParamRefElement Class + +Handles `typeparamref` xml element\. + +```csharp +public sealed class TypeParamRefElement : DefaultDocumentation.Api.IElement +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 TypeParamRefElement + +Implements [IElement](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IElement/index.md 'DefaultDocumentation\.Api\.IElement') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Elements\.TypeParamRefElement\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Elements\.TypeParamRefElement\.Name') | Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter, XElement\)](Write(IWriter,XElement).md 'DefaultDocumentation\.Markdown\.Elements\.TypeParamRefElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)') | Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/Clean(IGeneralContext).md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/Clean(IGeneralContext).md new file mode 100644 index 00000000..31578617 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/Clean(IGeneralContext).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[BaseMarkdownFileNameFactory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.BaseMarkdownFileNameFactory') + +## BaseMarkdownFileNameFactory\.Clean\(IGeneralContext\) Method + +Cleans the [OutputDirectory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/ISettings/OutputDirectory.md 'DefaultDocumentation\.ISettings\.OutputDirectory') of the previously generated documentation files\. + +```csharp +public void Clean(DefaultDocumentation.IGeneralContext context); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + +Implements [Clean\(IGeneralContext\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/Clean(IGeneralContext).md 'DefaultDocumentation\.Api\.IFileNameFactory\.Clean\(DefaultDocumentation\.IGeneralContext\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/GetFileName(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/GetFileName(IGeneralContext,DocItem).md new file mode 100644 index 00000000..5f8a4207 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/GetFileName(IGeneralContext,DocItem).md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[BaseMarkdownFileNameFactory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.BaseMarkdownFileNameFactory') + +## BaseMarkdownFileNameFactory\.GetFileName\(IGeneralContext, DocItem\) Method + +Gets the documentation file name for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public string GetFileName(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to get the documentation file name\. + +Implements [GetFileName\(IGeneralContext, DocItem\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/GetFileName(IGeneralContext,DocItem).md 'DefaultDocumentation\.Api\.IFileNameFactory\.GetFileName\(DefaultDocumentation\.IGeneralContext,DefaultDocumentation\.Models\.DocItem\)') + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +The documentation file name of the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/GetMarkdownFileName(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/GetMarkdownFileName(IGeneralContext,DocItem).md new file mode 100644 index 00000000..c1c47de7 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/GetMarkdownFileName(IGeneralContext,DocItem).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[BaseMarkdownFileNameFactory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.BaseMarkdownFileNameFactory') + +## BaseMarkdownFileNameFactory\.GetMarkdownFileName\(IGeneralContext, DocItem\) Method + +Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +protected abstract string GetMarkdownFileName(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to get the documentation file name\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +The file name to use\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/Name.md new file mode 100644 index 00000000..79b21d85 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[BaseMarkdownFileNameFactory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.BaseMarkdownFileNameFactory') + +## BaseMarkdownFileNameFactory\.Name Property + +Gets the name of the factory, used to identify it at the configuration level\. + +```csharp +public abstract string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/Name.md 'DefaultDocumentation\.Api\.IFileNameFactory\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/index.md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/index.md new file mode 100644 index 00000000..6e34563b --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/index.md @@ -0,0 +1,31 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories') + +## BaseMarkdownFileNameFactory Class + +Base implementation of the [IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory') to generate file with a `.md` extension\. +It will also replace invalid char that may be present with the [Markdown\.InvalidCharReplacement](https://github.com/Doraku/DefaultDocumentation#invalidcharreplacement 'https://github\.com/Doraku/DefaultDocumentation\#invalidcharreplacement') setting\. + +```csharp +public abstract class BaseMarkdownFileNameFactory : DefaultDocumentation.Api.IFileNameFactory +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 BaseMarkdownFileNameFactory + +Derived +↳ [FullNameFactory](../FullNameFactory/index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.FullNameFactory') +↳ [Md5Factory](../Md5Factory/index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.Md5Factory') +↳ [NameAndMd5MixFactory](../NameAndMd5MixFactory/index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameAndMd5MixFactory') +↳ [NameFactory](../NameFactory/index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameFactory') + +Implements [IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory') + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.BaseMarkdownFileNameFactory\.Name') | Gets the name of the factory, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Clean\(IGeneralContext\)](Clean(IGeneralContext).md 'DefaultDocumentation\.Markdown\.FileNameFactories\.BaseMarkdownFileNameFactory\.Clean\(DefaultDocumentation\.IGeneralContext\)') | Cleans the [OutputDirectory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/ISettings/OutputDirectory.md 'DefaultDocumentation\.ISettings\.OutputDirectory') of the previously generated documentation files\. | +| [GetFileName\(IGeneralContext, DocItem\)](GetFileName(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.FileNameFactories\.BaseMarkdownFileNameFactory\.GetFileName\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the documentation file name for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. | +| [GetMarkdownFileName\(IGeneralContext, DocItem\)](GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.FileNameFactories\.BaseMarkdownFileNameFactory\.GetMarkdownFileName\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/Clean(IGeneralContext).md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/Clean(IGeneralContext).md new file mode 100644 index 00000000..b747eb52 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/Clean(IGeneralContext).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[DirectoryNameFactory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.DirectoryNameFactory') + +## DirectoryNameFactory\.Clean\(IGeneralContext\) Method + +Cleans the [OutputDirectory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/ISettings/OutputDirectory.md 'DefaultDocumentation\.ISettings\.OutputDirectory') of the previously generated documentation files\. + +```csharp +public void Clean(DefaultDocumentation.IGeneralContext context); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + +Implements [Clean\(IGeneralContext\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/Clean(IGeneralContext).md 'DefaultDocumentation\.Api\.IFileNameFactory\.Clean\(DefaultDocumentation\.IGeneralContext\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/ConfigName.md new file mode 100644 index 00000000..ea98b5e4 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[DirectoryNameFactory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.DirectoryNameFactory') + +## DirectoryNameFactory\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "DirectoryName"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/GetFileName(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/GetFileName(IGeneralContext,DocItem).md new file mode 100644 index 00000000..946b106a --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/GetFileName(IGeneralContext,DocItem).md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[DirectoryNameFactory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.DirectoryNameFactory') + +## DirectoryNameFactory\.GetFileName\(IGeneralContext, DocItem\) Method + +Gets the documentation file name for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public string GetFileName(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to get the documentation file name\. + +Implements [GetFileName\(IGeneralContext, DocItem\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/GetFileName(IGeneralContext,DocItem).md 'DefaultDocumentation\.Api\.IFileNameFactory\.GetFileName\(DefaultDocumentation\.IGeneralContext,DefaultDocumentation\.Models\.DocItem\)') + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +The documentation file name of the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/Name.md new file mode 100644 index 00000000..30ea95e4 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[DirectoryNameFactory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.DirectoryNameFactory') + +## DirectoryNameFactory\.Name Property + +Gets the name of the factory, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/Name.md 'DefaultDocumentation\.Api\.IFileNameFactory\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/index.md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/index.md new file mode 100644 index 00000000..baf245d5 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/index.md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories') + +## DirectoryNameFactory Class + +[IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory') implementation using [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/Name.md 'DefaultDocumentation\.Models\.DocItem\.Name') as file name in a directory hierarchy\. + +```csharp +public sealed class DirectoryNameFactory : DefaultDocumentation.Api.IFileNameFactory +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 DirectoryNameFactory + +Implements [IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.DirectoryNameFactory\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.DirectoryNameFactory\.Name') | Gets the name of the factory, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Clean\(IGeneralContext\)](Clean(IGeneralContext).md 'DefaultDocumentation\.Markdown\.FileNameFactories\.DirectoryNameFactory\.Clean\(DefaultDocumentation\.IGeneralContext\)') | Cleans the [OutputDirectory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/ISettings/OutputDirectory.md 'DefaultDocumentation\.ISettings\.OutputDirectory') of the previously generated documentation files\. | +| [GetFileName\(IGeneralContext, DocItem\)](GetFileName(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.FileNameFactories\.DirectoryNameFactory\.GetFileName\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the documentation file name for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/ConfigName.md new file mode 100644 index 00000000..085c526c --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[FullNameFactory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.FullNameFactory') + +## FullNameFactory\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "FullName"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/GetMarkdownFileName(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/GetMarkdownFileName(IGeneralContext,DocItem).md new file mode 100644 index 00000000..b9c0742b --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/GetMarkdownFileName(IGeneralContext,DocItem).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[FullNameFactory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.FullNameFactory') + +## FullNameFactory\.GetMarkdownFileName\(IGeneralContext, DocItem\) Method + +Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +protected override string GetMarkdownFileName(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to get the documentation file name\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +The file name to use\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/Name.md new file mode 100644 index 00000000..7bb2cecd --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[FullNameFactory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.FullNameFactory') + +## FullNameFactory\.Name Property + +Gets the name of the factory, used to identify it at the configuration level\. + +```csharp +public override string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/Name.md 'DefaultDocumentation\.Api\.IFileNameFactory\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/index.md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/index.md new file mode 100644 index 00000000..1c71d7dd --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/index.md @@ -0,0 +1,24 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories') + +## FullNameFactory Class + +[IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory') implementation using [FullName](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/FullName.md 'DefaultDocumentation\.Models\.DocItem\.FullName') as file name\. + +```csharp +public sealed class FullNameFactory : DefaultDocumentation.Markdown.FileNameFactories.BaseMarkdownFileNameFactory +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [BaseMarkdownFileNameFactory](../BaseMarkdownFileNameFactory/index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.BaseMarkdownFileNameFactory') 🡒 FullNameFactory + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.FullNameFactory\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.FullNameFactory\.Name') | Gets the name of the factory, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [GetMarkdownFileName\(IGeneralContext, DocItem\)](GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.FileNameFactories\.FullNameFactory\.GetMarkdownFileName\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/ConfigName.md new file mode 100644 index 00000000..b81ebaea --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[Md5Factory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.Md5Factory') + +## Md5Factory\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Md5"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/GetMarkdownFileName(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/GetMarkdownFileName(IGeneralContext,DocItem).md new file mode 100644 index 00000000..5a75eda8 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/GetMarkdownFileName(IGeneralContext,DocItem).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[Md5Factory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.Md5Factory') + +## Md5Factory\.GetMarkdownFileName\(IGeneralContext, DocItem\) Method + +Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +protected override string GetMarkdownFileName(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to get the documentation file name\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +The file name to use\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/Name.md new file mode 100644 index 00000000..9be8af00 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[Md5Factory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.Md5Factory') + +## Md5Factory\.Name Property + +Gets the name of the factory, used to identify it at the configuration level\. + +```csharp +public override string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/Name.md 'DefaultDocumentation\.Api\.IFileNameFactory\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/index.md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/index.md new file mode 100644 index 00000000..3fbbc387 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/index.md @@ -0,0 +1,24 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories') + +## Md5Factory Class + +[IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory') implementation using an md5 on the [FullName](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/FullName.md 'DefaultDocumentation\.Models\.DocItem\.FullName') as file name\. + +```csharp +public sealed class Md5Factory : DefaultDocumentation.Markdown.FileNameFactories.BaseMarkdownFileNameFactory +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [BaseMarkdownFileNameFactory](../BaseMarkdownFileNameFactory/index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.BaseMarkdownFileNameFactory') 🡒 Md5Factory + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.Md5Factory\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.Md5Factory\.Name') | Gets the name of the factory, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [GetMarkdownFileName\(IGeneralContext, DocItem\)](GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.FileNameFactories\.Md5Factory\.GetMarkdownFileName\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/ConfigName.md new file mode 100644 index 00000000..0b0acc4f --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[NameAndMd5MixFactory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameAndMd5MixFactory') + +## NameAndMd5MixFactory\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "NameAndMd5Mix"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/GetMarkdownFileName(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/GetMarkdownFileName(IGeneralContext,DocItem).md new file mode 100644 index 00000000..085697c2 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/GetMarkdownFileName(IGeneralContext,DocItem).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[NameAndMd5MixFactory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameAndMd5MixFactory') + +## NameAndMd5MixFactory\.GetMarkdownFileName\(IGeneralContext, DocItem\) Method + +Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +protected override string GetMarkdownFileName(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to get the documentation file name\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +The file name to use\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/Name.md new file mode 100644 index 00000000..5b729047 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[NameAndMd5MixFactory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameAndMd5MixFactory') + +## NameAndMd5MixFactory\.Name Property + +Gets the name of the factory, used to identify it at the configuration level\. + +```csharp +public override string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/Name.md 'DefaultDocumentation\.Api\.IFileNameFactory\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/index.md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/index.md new file mode 100644 index 00000000..815abf31 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/index.md @@ -0,0 +1,24 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories') + +## NameAndMd5MixFactory Class + +[IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory') implementation using [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/Name.md 'DefaultDocumentation\.Models\.DocItem\.Name') and an md5 on the [FullName](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/FullName.md 'DefaultDocumentation\.Models\.DocItem\.FullName') as file name\. + +```csharp +public sealed class NameAndMd5MixFactory : DefaultDocumentation.Markdown.FileNameFactories.BaseMarkdownFileNameFactory +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [BaseMarkdownFileNameFactory](../BaseMarkdownFileNameFactory/index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.BaseMarkdownFileNameFactory') 🡒 NameAndMd5MixFactory + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameAndMd5MixFactory\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameAndMd5MixFactory\.Name') | Gets the name of the factory, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [GetMarkdownFileName\(IGeneralContext, DocItem\)](GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameAndMd5MixFactory\.GetMarkdownFileName\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameFactory/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameFactory/ConfigName.md new file mode 100644 index 00000000..bd62a5d8 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameFactory/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[NameFactory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameFactory') + +## NameFactory\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Name"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameFactory/GetMarkdownFileName(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameFactory/GetMarkdownFileName(IGeneralContext,DocItem).md new file mode 100644 index 00000000..57d2f85a --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameFactory/GetMarkdownFileName(IGeneralContext,DocItem).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[NameFactory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameFactory') + +## NameFactory\.GetMarkdownFileName\(IGeneralContext, DocItem\) Method + +Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +protected override string GetMarkdownFileName(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to get the documentation file name\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +The file name to use\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameFactory/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameFactory/Name.md new file mode 100644 index 00000000..4af0e9bf --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameFactory/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories').[NameFactory](index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameFactory') + +## NameFactory\.Name Property + +Gets the name of the factory, used to identify it at the configuration level\. + +```csharp +public override string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/Name.md 'DefaultDocumentation\.Api\.IFileNameFactory\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameFactory/index.md b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameFactory/index.md new file mode 100644 index 00000000..e528fb53 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/FileNameFactories/NameFactory/index.md @@ -0,0 +1,24 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.FileNameFactories](../../../../index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation\.Markdown\.FileNameFactories') + +## NameFactory Class + +[IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory') implementation using [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/Name.md 'DefaultDocumentation\.Models\.DocItem\.Name') as file name\. + +```csharp +public sealed class NameFactory : DefaultDocumentation.Markdown.FileNameFactories.BaseMarkdownFileNameFactory +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [BaseMarkdownFileNameFactory](../BaseMarkdownFileNameFactory/index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.BaseMarkdownFileNameFactory') 🡒 NameFactory + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameFactory\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameFactory\.Name') | Gets the name of the factory, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [GetMarkdownFileName\(IGeneralContext, DocItem\)](GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameFactory\.GetMarkdownFileName\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Models/ConstructorOverloadsDocItem/ConstructorOverloadsDocItem(TypeDocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Models/ConstructorOverloadsDocItem/ConstructorOverloadsDocItem(TypeDocItem).md new file mode 100644 index 00000000..62d29900 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Models/ConstructorOverloadsDocItem/ConstructorOverloadsDocItem(TypeDocItem).md @@ -0,0 +1,17 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Models](../../../../index.md#DefaultDocumentation.Markdown.Models 'DefaultDocumentation\.Markdown\.Models').[ConstructorOverloadsDocItem](index.md 'DefaultDocumentation\.Markdown\.Models\.ConstructorOverloadsDocItem') + +## ConstructorOverloadsDocItem\(TypeDocItem\) Constructor + +Initialize a new instance of the [ConstructorOverloadsDocItem](index.md 'DefaultDocumentation\.Markdown\.Models\.ConstructorOverloadsDocItem') type\. + +```csharp +public ConstructorOverloadsDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent); +``` +#### Parameters + + + +`parent` [TypeDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') + +The [TypeDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') parent\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Models/ConstructorOverloadsDocItem/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Models/ConstructorOverloadsDocItem/index.md new file mode 100644 index 00000000..87afebf2 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Models/ConstructorOverloadsDocItem/index.md @@ -0,0 +1,16 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Models](../../../../index.md#DefaultDocumentation.Markdown.Models 'DefaultDocumentation\.Markdown\.Models') + +## ConstructorOverloadsDocItem Class + +Represents the different overload of the constructors of a given [TypeDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem')\. + +```csharp +public sealed class ConstructorOverloadsDocItem : DefaultDocumentation.Models.DocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 ConstructorOverloadsDocItem + +| Constructors | | +| :--- | :--- | +| [ConstructorOverloadsDocItem\(TypeDocItem\)](ConstructorOverloadsDocItem(TypeDocItem).md 'DefaultDocumentation\.Markdown\.Models\.ConstructorOverloadsDocItem\.ConstructorOverloadsDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem\)') | Initialize a new instance of the [ConstructorOverloadsDocItem](DefaultDocumentation/Markdown/Models/ConstructorOverloadsDocItem/index.md 'DefaultDocumentation\.Markdown\.Models\.ConstructorOverloadsDocItem') type\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Models/MethodOverloadsDocItem/MethodOverloadsDocItem(TypeDocItem,string).md b/documentation/markdown/DefaultDocumentation/Markdown/Models/MethodOverloadsDocItem/MethodOverloadsDocItem(TypeDocItem,string).md new file mode 100644 index 00000000..bb4d32e4 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Models/MethodOverloadsDocItem/MethodOverloadsDocItem(TypeDocItem,string).md @@ -0,0 +1,23 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Models](../../../../index.md#DefaultDocumentation.Markdown.Models 'DefaultDocumentation\.Markdown\.Models').[MethodOverloadsDocItem](index.md 'DefaultDocumentation\.Markdown\.Models\.MethodOverloadsDocItem') + +## MethodOverloadsDocItem\(TypeDocItem, string\) Constructor + +Initialize a new instance of the [MethodOverloadsDocItem](index.md 'DefaultDocumentation\.Markdown\.Models\.MethodOverloadsDocItem') type\. + +```csharp +public MethodOverloadsDocItem(DefaultDocumentation.Models.Types.TypeDocItem parent, string methodName); +``` +#### Parameters + + + +`parent` [TypeDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') + +The [TypeDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem') parent\. + + + +`methodName` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The method name of the overloads\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Models/MethodOverloadsDocItem/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Models/MethodOverloadsDocItem/index.md new file mode 100644 index 00000000..f9aacf04 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Models/MethodOverloadsDocItem/index.md @@ -0,0 +1,16 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Models](../../../../index.md#DefaultDocumentation.Markdown.Models 'DefaultDocumentation\.Markdown\.Models') + +## MethodOverloadsDocItem Class + +Represents the different overload of a method of a given [TypeDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem')\. + +```csharp +public sealed class MethodOverloadsDocItem : DefaultDocumentation.Models.DocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') 🡒 MethodOverloadsDocItem + +| Constructors | | +| :--- | :--- | +| [MethodOverloadsDocItem\(TypeDocItem, string\)](MethodOverloadsDocItem(TypeDocItem,string).md 'DefaultDocumentation\.Markdown\.Models\.MethodOverloadsDocItem\.MethodOverloadsDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, string\)') | Initialize a new instance of the [MethodOverloadsDocItem](DefaultDocumentation/Markdown/Models/MethodOverloadsDocItem/index.md 'DefaultDocumentation\.Markdown\.Models\.MethodOverloadsDocItem') type\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/NestedTypeVisibilities/index.md b/documentation/markdown/DefaultDocumentation/Markdown/NestedTypeVisibilities/index.md new file mode 100644 index 00000000..f4a45cf4 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/NestedTypeVisibilities/index.md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Markdown](../../../index.md#DefaultDocumentation.Markdown 'DefaultDocumentation\.Markdown') + +## NestedTypeVisibilities Enum + +Specifies where nested types should be displayed in the generated documentation\. + +```csharp +public enum NestedTypeVisibilities +``` +### Fields + + + +`Default` 0 + +Same as [Namespace](DefaultDocumentation/Markdown/NestedTypeVisibilities/index.md#DefaultDocumentation.Markdown.NestedTypeVisibilities.Namespace 'DefaultDocumentation\.Markdown\.NestedTypeVisibilities\.Namespace')\. + + + +`Namespace` 1 + +Generates nested types in namespace page\. + + + +`DeclaringType` 2 + +Generates nested types in declaring type page\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/ChildrenSection(string,string).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/ChildrenSection(string,string).md new file mode 100644 index 00000000..8346c7e7 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/ChildrenSection(string,string).md @@ -0,0 +1,23 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ChildrenSection<T>](index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') + +## ChildrenSection\(string, string\) Constructor + +Base constructor of the [ChildrenSection<T>](index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') type\. + +```csharp +protected ChildrenSection(string name, string title); +``` +#### Parameters + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The name of the section\. + + + +`title` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The title that will be written before the children\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/GetChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/GetChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..6d90306f --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/GetChildren(IGeneralContext,DocItem).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ChildrenSection<T>](index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') + +## ChildrenSection\\.GetChildren\(IGeneralContext, DocItem\) Method + +Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. + +```csharp +protected virtual System.Collections.Generic.IEnumerable? GetChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[T](index.md#DefaultDocumentation.Markdown.Sections.ChildrenSection_T_.T 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\\.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') +The children to write\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/Name.md new file mode 100644 index 00000000..d7ce21a5 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ChildrenSection<T>](index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') + +## ChildrenSection\\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..7021e29e --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ChildrenSection<T>](index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') + +## ChildrenSection\\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected abstract bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/ShouldWriteTitle(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/ShouldWriteTitle(IGeneralContext,DocItem).md new file mode 100644 index 00000000..e9837353 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/ShouldWriteTitle(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ChildrenSection<T>](index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') + +## ChildrenSection\\.ShouldWriteTitle\(IGeneralContext, DocItem\) Method + +Gets if the title should be writen or not\. + +```csharp +protected virtual bool ShouldWriteTitle(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/Write(IWriter).md new file mode 100644 index 00000000..8886a9a5 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ChildrenSection<T>](index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') + +## ChildrenSection\\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/index.md new file mode 100644 index 00000000..5520db16 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/index.md @@ -0,0 +1,57 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## ChildrenSection\ Class + +Base [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write children of a given type of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public abstract class ChildrenSection : DefaultDocumentation.Api.ISection + where T : DefaultDocumentation.Models.DocItem +``` +#### Type parameters + + + +`T` + +The of [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ChildrenSection + +Derived +↳ [ClassesSection](../ClassesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ClassesSection') +↳ [ConstructorOverloadsSection](../ConstructorOverloadsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorOverloadsSection') +↳ [ConstructorsSection](../ConstructorsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection') +↳ [DelegatesSection](../DelegatesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.DelegatesSection') +↳ [EnumFieldsSection](../EnumFieldsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumFieldsSection') +↳ [EnumsSection](../EnumsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumsSection') +↳ [EventsSection](../EventsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.EventsSection') +↳ [ExplicitInterfaceImplementationsSection](../ExplicitInterfaceImplementationsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ExplicitInterfaceImplementationsSection') +↳ [FieldsSection](../FieldsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.FieldsSection') +↳ [InterfacesSection](../InterfacesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.InterfacesSection') +↳ [MethodOverloadsSection](../MethodOverloadsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodOverloadsSection') +↳ [MethodsSection](../MethodsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection') +↳ [NamespacesSection](../NamespacesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.NamespacesSection') +↳ [OperatorsSection](../OperatorsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.OperatorsSection') +↳ [ParametersSection](../ParametersSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ParametersSection') +↳ [PropertiesSection](../PropertiesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.PropertiesSection') +↳ [StructsSection](../StructsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.StructsSection') +↳ [TypeParametersSection](../TypeParametersSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.TypeParametersSection') + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Constructors | | +| :--- | :--- | +| [ChildrenSection\(string, string\)](ChildrenSection(string,string).md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\\.ChildrenSection\(string, string\)') | Base constructor of the [ChildrenSection<T>](DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') type\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [GetChildren\(IGeneralContext, DocItem\)](GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\\.GetChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | +| [ShouldWriteTitle\(IGeneralContext, DocItem\)](ShouldWriteTitle(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\\.ShouldWriteTitle\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the title should be writen or not\. | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ClassesSection/ClassesSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ClassesSection/ClassesSection().md new file mode 100644 index 00000000..84aa9bd1 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ClassesSection/ClassesSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ClassesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ClassesSection') + +## ClassesSection\(\) Constructor + +Initialize a new instance of the [ClassesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ClassesSection') type\. + +```csharp +public ClassesSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ClassesSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ClassesSection/ConfigName.md new file mode 100644 index 00000000..e663025f --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ClassesSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ClassesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ClassesSection') + +## ClassesSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Classes"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ClassesSection/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ClassesSection/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..11034622 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ClassesSection/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ClassesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ClassesSection') + +## ClassesSection\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected override bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ClassesSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ClassesSection/index.md new file mode 100644 index 00000000..ef794d39 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ClassesSection/index.md @@ -0,0 +1,24 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## ClassesSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [ClassDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/ClassDocItem/index.md 'DefaultDocumentation\.Models\.Types\.ClassDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class ClassesSection : DefaultDocumentation.Markdown.Sections.ChildrenSection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DefaultDocumentation\.Markdown\.Sections\.ChildrenSection<](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')[ClassDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/ClassDocItem/index.md 'DefaultDocumentation\.Models\.Types\.ClassDocItem')[>](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') 🡒 ClassesSection + +| Constructors | | +| :--- | :--- | +| [ClassesSection\(\)](ClassesSection().md 'DefaultDocumentation\.Markdown\.Sections\.ClassesSection\.ClassesSection\(\)') | Initialize a new instance of the [ClassesSection](DefaultDocumentation/Markdown/Sections/ClassesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ClassesSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ClassesSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ClassesSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/ConfigName.md new file mode 100644 index 00000000..a73f9e92 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ConstructorOverloadsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorOverloadsSection') + +## ConstructorOverloadsSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "ConstructorOverloads"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/ConstructorOverloadsSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/ConstructorOverloadsSection().md new file mode 100644 index 00000000..ef3d52f8 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/ConstructorOverloadsSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ConstructorOverloadsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorOverloadsSection') + +## ConstructorOverloadsSection\(\) Constructor + +Initialize a new instance of the [ConstructorsSection](../ConstructorsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection') type\. + +```csharp +public ConstructorOverloadsSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/GetChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/GetChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..4359b9f2 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/GetChildren(IGeneralContext,DocItem).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ConstructorOverloadsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorOverloadsSection') + +## ConstructorOverloadsSection\.GetChildren\(IGeneralContext, DocItem\) Method + +Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. + +```csharp +protected override System.Collections.Generic.IEnumerable? GetChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[ConstructorDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/ConstructorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') +The children to write\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..eb07e74f --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ConstructorOverloadsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorOverloadsSection') + +## ConstructorOverloadsSection\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected override bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/index.md new file mode 100644 index 00000000..9e36f8d4 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/index.md @@ -0,0 +1,25 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## ConstructorOverloadsSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [ConstructorOverloadsSection](DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorOverloadsSection') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class ConstructorOverloadsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DefaultDocumentation\.Markdown\.Sections\.ChildrenSection<](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')[ConstructorDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/ConstructorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem')[>](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') 🡒 ConstructorOverloadsSection + +| Constructors | | +| :--- | :--- | +| [ConstructorOverloadsSection\(\)](ConstructorOverloadsSection().md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorOverloadsSection\.ConstructorOverloadsSection\(\)') | Initialize a new instance of the [ConstructorsSection](../ConstructorsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorOverloadsSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [GetChildren\(IGeneralContext, DocItem\)](GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorOverloadsSection\.GetChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorOverloadsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorsSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorsSection/ConfigName.md new file mode 100644 index 00000000..2c360356 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorsSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ConstructorsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection') + +## ConstructorsSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Constructors"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorsSection/ConstructorsSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorsSection/ConstructorsSection().md new file mode 100644 index 00000000..8bdd8e1a --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorsSection/ConstructorsSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ConstructorsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection') + +## ConstructorsSection\(\) Constructor + +Initialize a new instance of the [ConstructorsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection') type\. + +```csharp +public ConstructorsSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorsSection/GetChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorsSection/GetChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..9246d06f --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorsSection/GetChildren(IGeneralContext,DocItem).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ConstructorsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection') + +## ConstructorsSection\.GetChildren\(IGeneralContext, DocItem\) Method + +Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. + +```csharp +protected override System.Collections.Generic.IEnumerable? GetChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[ConstructorDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/ConstructorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') +The children to write\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorsSection/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorsSection/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..4e0b3cd6 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorsSection/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ConstructorsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection') + +## ConstructorsSection\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected override bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorsSection/ShouldWriteTitle(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorsSection/ShouldWriteTitle(IGeneralContext,DocItem).md new file mode 100644 index 00000000..3533a5fc --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorsSection/ShouldWriteTitle(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ConstructorsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection') + +## ConstructorsSection\.ShouldWriteTitle\(IGeneralContext, DocItem\) Method + +Gets if the title should be writen or not\. + +```csharp +protected override bool ShouldWriteTitle(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorsSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorsSection/index.md new file mode 100644 index 00000000..c9d45a13 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ConstructorsSection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## ConstructorsSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [ConstructorDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/ConstructorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class ConstructorsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DefaultDocumentation\.Markdown\.Sections\.ChildrenSection<](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')[ConstructorDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/ConstructorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem')[>](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') 🡒 ConstructorsSection + +| Constructors | | +| :--- | :--- | +| [ConstructorsSection\(\)](ConstructorsSection().md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection\.ConstructorsSection\(\)') | Initialize a new instance of the [ConstructorsSection](DefaultDocumentation/Markdown/Sections/ConstructorsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [GetChildren\(IGeneralContext, DocItem\)](GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection\.GetChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | +| [ShouldWriteTitle\(IGeneralContext, DocItem\)](ShouldWriteTitle(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection\.ShouldWriteTitle\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the title should be writen or not\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefaultSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefaultSection/ConfigName.md new file mode 100644 index 00000000..ad244adc --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefaultSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[DefaultSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.DefaultSection') + +## DefaultSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Default"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefaultSection/DefaultSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefaultSection/DefaultSection().md new file mode 100644 index 00000000..30776d89 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefaultSection/DefaultSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[DefaultSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.DefaultSection') + +## DefaultSection\(\) Constructor + +Initialize a new instance of the [DefaultSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.DefaultSection') type\. + +```csharp +public DefaultSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefaultSection/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefaultSection/Name.md new file mode 100644 index 00000000..7285a653 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefaultSection/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[DefaultSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.DefaultSection') + +## DefaultSection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefaultSection/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefaultSection/Write(IWriter).md new file mode 100644 index 00000000..bd675ab4 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefaultSection/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[DefaultSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.DefaultSection') + +## DefaultSection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefaultSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefaultSection/index.md new file mode 100644 index 00000000..90133964 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefaultSection/index.md @@ -0,0 +1,63 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## DefaultSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation regrouping the following implementation in this order: + +1. [TitleSection](../TitleSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.TitleSection') +2. [SummarySection](../SummarySection/index.md 'DefaultDocumentation\.Markdown\.Sections\.SummarySection') +3. [DefinitionSection](../DefinitionSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.DefinitionSection') +4. [ConstructorOverloadsSection](../ConstructorOverloadsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorOverloadsSection') +5. [MethodOverloadsSection](../MethodOverloadsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodOverloadsSection') +6. [TypeParametersSection](../TypeParametersSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.TypeParametersSection') +7. [ParametersSection](../ParametersSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ParametersSection') +8. [EnumFieldsSection](../EnumFieldsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumFieldsSection') +9. [InheritanceSection](../InheritanceSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.InheritanceSection') +10. [DerivedSection](../DerivedSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.DerivedSection') +11. [ImplementSection](../ImplementSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ImplementSection') +12. [EventTypeSection](../EventTypeSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.EventTypeSection') +13. [FieldValueSection](../FieldValueSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.FieldValueSection') +14. [ValueSection](../ValueSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ValueSection') +15. [ReturnsSection](../ReturnsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ReturnsSection') +16. [ExceptionSection](../ExceptionSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ExceptionSection') +17. [ExampleSection](../ExampleSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ExampleSection') +18. [RemarksSection](../RemarksSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.RemarksSection') +19. [SeeAlsoSection](../SeeAlsoSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.SeeAlsoSection') +20. [NamespacesSection](../NamespacesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.NamespacesSection') +21. [ClassesSection](../ClassesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ClassesSection') +22. [StructsSection](../StructsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.StructsSection') +23. [InterfacesSection](../InterfacesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.InterfacesSection') +24. [EnumsSection](../EnumsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumsSection') +25. [DelegatesSection](../DelegatesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.DelegatesSection') +26. [ConstructorsSection](../ConstructorsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection') +27. [FieldsSection](../FieldsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.FieldsSection') +28. [PropertiesSection](../PropertiesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.PropertiesSection') +29. [MethodsSection](../MethodsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection') +30. [EventsSection](../EventsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.EventsSection') +31. [OperatorsSection](../OperatorsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.OperatorsSection') +32. [ExplicitInterfaceImplementationsSection](../ExplicitInterfaceImplementationsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ExplicitInterfaceImplementationsSection') + +```csharp +public sealed class DefaultSection : DefaultDocumentation.Api.ISection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 DefaultSection + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Constructors | | +| :--- | :--- | +| [DefaultSection\(\)](DefaultSection().md 'DefaultDocumentation\.Markdown\.Sections\.DefaultSection\.DefaultSection\(\)') | Initialize a new instance of the [DefaultSection](DefaultDocumentation/Markdown/Sections/DefaultSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.DefaultSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.DefaultSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.DefaultSection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.DefaultSection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefinitionSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefinitionSection/ConfigName.md new file mode 100644 index 00000000..102bc4c5 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefinitionSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[DefinitionSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.DefinitionSection') + +## DefinitionSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Definition"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefinitionSection/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefinitionSection/Name.md new file mode 100644 index 00000000..3e07a7b1 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefinitionSection/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[DefinitionSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.DefinitionSection') + +## DefinitionSection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefinitionSection/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefinitionSection/Write(IWriter).md new file mode 100644 index 00000000..2b216e2b --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefinitionSection/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[DefinitionSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.DefinitionSection') + +## DefinitionSection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefinitionSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefinitionSection/index.md new file mode 100644 index 00000000..d0fd1feb --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DefinitionSection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## DefinitionSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the definition of [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class DefinitionSection : DefaultDocumentation.Api.ISection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 DefinitionSection + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.DefinitionSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.DefinitionSection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.DefinitionSection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/DelegatesSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DelegatesSection/ConfigName.md new file mode 100644 index 00000000..9ca2539b --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DelegatesSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[DelegatesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.DelegatesSection') + +## DelegatesSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Delegates"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/DelegatesSection/DelegatesSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DelegatesSection/DelegatesSection().md new file mode 100644 index 00000000..a7dbdd87 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DelegatesSection/DelegatesSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[DelegatesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.DelegatesSection') + +## DelegatesSection\(\) Constructor + +Initialize a new instance of the [DelegatesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.DelegatesSection') type\. + +```csharp +public DelegatesSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/DelegatesSection/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DelegatesSection/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..1b1793fe --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DelegatesSection/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[DelegatesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.DelegatesSection') + +## DelegatesSection\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected override bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/DelegatesSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DelegatesSection/index.md new file mode 100644 index 00000000..9764a797 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DelegatesSection/index.md @@ -0,0 +1,24 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## DelegatesSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [DelegateDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/DelegateDocItem/index.md 'DefaultDocumentation\.Models\.Types\.DelegateDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class DelegatesSection : DefaultDocumentation.Markdown.Sections.ChildrenSection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DefaultDocumentation\.Markdown\.Sections\.ChildrenSection<](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')[DelegateDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/DelegateDocItem/index.md 'DefaultDocumentation\.Models\.Types\.DelegateDocItem')[>](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') 🡒 DelegatesSection + +| Constructors | | +| :--- | :--- | +| [DelegatesSection\(\)](DelegatesSection().md 'DefaultDocumentation\.Markdown\.Sections\.DelegatesSection\.DelegatesSection\(\)') | Initialize a new instance of the [DelegatesSection](DefaultDocumentation/Markdown/Sections/DelegatesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.DelegatesSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.DelegatesSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.DelegatesSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/DerivedSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DerivedSection/ConfigName.md new file mode 100644 index 00000000..d1236a0d --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DerivedSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[DerivedSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.DerivedSection') + +## DerivedSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Derived"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/DerivedSection/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DerivedSection/Name.md new file mode 100644 index 00000000..b809362a --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DerivedSection/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[DerivedSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.DerivedSection') + +## DerivedSection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/DerivedSection/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DerivedSection/Write(IWriter).md new file mode 100644 index 00000000..6315f7bb --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DerivedSection/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[DerivedSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.DerivedSection') + +## DerivedSection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/DerivedSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DerivedSection/index.md new file mode 100644 index 00000000..aa0be0a9 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/DerivedSection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## DerivedSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the derived type of [TypeDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem')\. + +```csharp +public sealed class DerivedSection : DefaultDocumentation.Api.ISection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 DerivedSection + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.DerivedSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.DerivedSection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.DerivedSection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumFieldsSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumFieldsSection/ConfigName.md new file mode 100644 index 00000000..ec18423b --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumFieldsSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[EnumFieldsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumFieldsSection') + +## EnumFieldsSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "EnumFields"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumFieldsSection/EnumFieldsSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumFieldsSection/EnumFieldsSection().md new file mode 100644 index 00000000..e965edb2 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumFieldsSection/EnumFieldsSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[EnumFieldsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumFieldsSection') + +## EnumFieldsSection\(\) Constructor + +Initialize a new instance of the [EnumFieldsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumFieldsSection') type\. + +```csharp +public EnumFieldsSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumFieldsSection/GetChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumFieldsSection/GetChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..33c4590b --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumFieldsSection/GetChildren(IGeneralContext,DocItem).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[EnumFieldsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumFieldsSection') + +## EnumFieldsSection\.GetChildren\(IGeneralContext, DocItem\) Method + +Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. + +```csharp +protected override System.Collections.Generic.IEnumerable? GetChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[EnumFieldDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/EnumFieldDocItem/index.md 'DefaultDocumentation\.Models\.Members\.EnumFieldDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') +The children to write\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumFieldsSection/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumFieldsSection/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..e6a6b3f6 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumFieldsSection/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[EnumFieldsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumFieldsSection') + +## EnumFieldsSection\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected override bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumFieldsSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumFieldsSection/index.md new file mode 100644 index 00000000..df6cb17a --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumFieldsSection/index.md @@ -0,0 +1,25 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## EnumFieldsSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [EnumFieldDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/EnumFieldDocItem/index.md 'DefaultDocumentation\.Models\.Members\.EnumFieldDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class EnumFieldsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DefaultDocumentation\.Markdown\.Sections\.ChildrenSection<](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')[EnumFieldDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/EnumFieldDocItem/index.md 'DefaultDocumentation\.Models\.Members\.EnumFieldDocItem')[>](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') 🡒 EnumFieldsSection + +| Constructors | | +| :--- | :--- | +| [EnumFieldsSection\(\)](EnumFieldsSection().md 'DefaultDocumentation\.Markdown\.Sections\.EnumFieldsSection\.EnumFieldsSection\(\)') | Initialize a new instance of the [EnumFieldsSection](DefaultDocumentation/Markdown/Sections/EnumFieldsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumFieldsSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.EnumFieldsSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [GetChildren\(IGeneralContext, DocItem\)](GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.EnumFieldsSection\.GetChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.EnumFieldsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumsSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumsSection/ConfigName.md new file mode 100644 index 00000000..39473132 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumsSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[EnumsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumsSection') + +## EnumsSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Enums"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumsSection/EnumsSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumsSection/EnumsSection().md new file mode 100644 index 00000000..591ed472 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumsSection/EnumsSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[EnumsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumsSection') + +## EnumsSection\(\) Constructor + +Initialize a new instance of the [EnumsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumsSection') type\. + +```csharp +public EnumsSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumsSection/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumsSection/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..08b31789 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumsSection/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[EnumsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumsSection') + +## EnumsSection\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected override bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumsSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumsSection/index.md new file mode 100644 index 00000000..1adb6333 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EnumsSection/index.md @@ -0,0 +1,24 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## EnumsSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [EnumDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/EnumDocItem/index.md 'DefaultDocumentation\.Models\.Types\.EnumDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class EnumsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DefaultDocumentation\.Markdown\.Sections\.ChildrenSection<](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')[EnumDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/EnumDocItem/index.md 'DefaultDocumentation\.Models\.Types\.EnumDocItem')[>](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') 🡒 EnumsSection + +| Constructors | | +| :--- | :--- | +| [EnumsSection\(\)](EnumsSection().md 'DefaultDocumentation\.Markdown\.Sections\.EnumsSection\.EnumsSection\(\)') | Initialize a new instance of the [EnumsSection](DefaultDocumentation/Markdown/Sections/EnumsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumsSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.EnumsSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.EnumsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventTypeSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventTypeSection/ConfigName.md new file mode 100644 index 00000000..926b4735 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventTypeSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[EventTypeSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.EventTypeSection') + +## EventTypeSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "EventType"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventTypeSection/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventTypeSection/Name.md new file mode 100644 index 00000000..9e7d5701 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventTypeSection/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[EventTypeSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.EventTypeSection') + +## EventTypeSection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventTypeSection/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventTypeSection/Write(IWriter).md new file mode 100644 index 00000000..67adb1cf --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventTypeSection/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[EventTypeSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.EventTypeSection') + +## EventTypeSection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventTypeSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventTypeSection/index.md new file mode 100644 index 00000000..a737cf2b --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventTypeSection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## EventTypeSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the event type of [EventDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/EventDocItem/index.md 'DefaultDocumentation\.Models\.Members\.EventDocItem')\. + +```csharp +public sealed class EventTypeSection : DefaultDocumentation.Api.ISection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 EventTypeSection + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.EventTypeSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.EventTypeSection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.EventTypeSection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventsSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventsSection/ConfigName.md new file mode 100644 index 00000000..2e9b0c64 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventsSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[EventsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.EventsSection') + +## EventsSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Events"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventsSection/EventsSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventsSection/EventsSection().md new file mode 100644 index 00000000..5736b19c --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventsSection/EventsSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[EventsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.EventsSection') + +## EventsSection\(\) Constructor + +Initialize a new instance of the [EventsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.EventsSection') type\. + +```csharp +public EventsSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventsSection/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventsSection/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..57a7b57c --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventsSection/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[EventsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.EventsSection') + +## EventsSection\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected override bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventsSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventsSection/index.md new file mode 100644 index 00000000..9f242cf4 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/EventsSection/index.md @@ -0,0 +1,24 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## EventsSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [EventDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/EventDocItem/index.md 'DefaultDocumentation\.Models\.Members\.EventDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class EventsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DefaultDocumentation\.Markdown\.Sections\.ChildrenSection<](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')[EventDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/EventDocItem/index.md 'DefaultDocumentation\.Models\.Members\.EventDocItem')[>](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') 🡒 EventsSection + +| Constructors | | +| :--- | :--- | +| [EventsSection\(\)](EventsSection().md 'DefaultDocumentation\.Markdown\.Sections\.EventsSection\.EventsSection\(\)') | Initialize a new instance of the [EventsSection](DefaultDocumentation/Markdown/Sections/EventsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.EventsSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.EventsSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.EventsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExampleSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExampleSection/ConfigName.md new file mode 100644 index 00000000..8ab7f5be --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExampleSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ExampleSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ExampleSection') + +## ExampleSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "example"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExampleSection/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExampleSection/Name.md new file mode 100644 index 00000000..40100055 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExampleSection/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ExampleSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ExampleSection') + +## ExampleSection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExampleSection/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExampleSection/Write(IWriter).md new file mode 100644 index 00000000..e4fd5798 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExampleSection/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ExampleSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ExampleSection') + +## ExampleSection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExampleSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExampleSection/index.md new file mode 100644 index 00000000..3d536a20 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExampleSection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## ExampleSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the `example` top level element\. + +```csharp +public sealed class ExampleSection : DefaultDocumentation.Api.ISection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ExampleSection + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ExampleSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.ExampleSection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.ExampleSection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExceptionSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExceptionSection/ConfigName.md new file mode 100644 index 00000000..43c46ecb --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExceptionSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ExceptionSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ExceptionSection') + +## ExceptionSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "exception"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExceptionSection/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExceptionSection/Name.md new file mode 100644 index 00000000..423d4be6 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExceptionSection/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ExceptionSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ExceptionSection') + +## ExceptionSection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExceptionSection/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExceptionSection/Write(IWriter).md new file mode 100644 index 00000000..455df15f --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExceptionSection/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ExceptionSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ExceptionSection') + +## ExceptionSection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExceptionSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExceptionSection/index.md new file mode 100644 index 00000000..1574b0bf --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExceptionSection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## ExceptionSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the `exception` top level elements\. + +```csharp +public sealed class ExceptionSection : DefaultDocumentation.Api.ISection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ExceptionSection + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ExceptionSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.ExceptionSection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.ExceptionSection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/ConfigName.md new file mode 100644 index 00000000..b25fc95e --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ExplicitInterfaceImplementationsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ExplicitInterfaceImplementationsSection') + +## ExplicitInterfaceImplementationsSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "ExplicitInterfaceImplementations"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/ExplicitInterfaceImplementationsSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/ExplicitInterfaceImplementationsSection().md new file mode 100644 index 00000000..d1b8a947 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/ExplicitInterfaceImplementationsSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ExplicitInterfaceImplementationsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ExplicitInterfaceImplementationsSection') + +## ExplicitInterfaceImplementationsSection\(\) Constructor + +Initialize a new instance of the [ExplicitInterfaceImplementationsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ExplicitInterfaceImplementationsSection') type\. + +```csharp +public ExplicitInterfaceImplementationsSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..a07848a8 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ExplicitInterfaceImplementationsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ExplicitInterfaceImplementationsSection') + +## ExplicitInterfaceImplementationsSection\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected override bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/index.md new file mode 100644 index 00000000..664e42cb --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/index.md @@ -0,0 +1,24 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## ExplicitInterfaceImplementationsSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [ExplicitInterfaceImplementationDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class ExplicitInterfaceImplementationsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DefaultDocumentation\.Markdown\.Sections\.ChildrenSection<](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')[ExplicitInterfaceImplementationDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem')[>](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') 🡒 ExplicitInterfaceImplementationsSection + +| Constructors | | +| :--- | :--- | +| [ExplicitInterfaceImplementationsSection\(\)](ExplicitInterfaceImplementationsSection().md 'DefaultDocumentation\.Markdown\.Sections\.ExplicitInterfaceImplementationsSection\.ExplicitInterfaceImplementationsSection\(\)') | Initialize a new instance of the [ExplicitInterfaceImplementationsSection](DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ExplicitInterfaceImplementationsSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ExplicitInterfaceImplementationsSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ExplicitInterfaceImplementationsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldValueSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldValueSection/ConfigName.md new file mode 100644 index 00000000..2e83ee3b --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldValueSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[FieldValueSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.FieldValueSection') + +## FieldValueSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "FieldValue"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldValueSection/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldValueSection/Name.md new file mode 100644 index 00000000..4e4de50f --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldValueSection/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[FieldValueSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.FieldValueSection') + +## FieldValueSection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldValueSection/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldValueSection/Write(IWriter).md new file mode 100644 index 00000000..ab55f4f6 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldValueSection/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[FieldValueSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.FieldValueSection') + +## FieldValueSection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldValueSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldValueSection/index.md new file mode 100644 index 00000000..dd72852f --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldValueSection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## FieldValueSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the field type of [FieldDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/FieldDocItem/index.md 'DefaultDocumentation\.Models\.Members\.FieldDocItem')\. + +```csharp +public sealed class FieldValueSection : DefaultDocumentation.Api.ISection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 FieldValueSection + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.FieldValueSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.FieldValueSection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.FieldValueSection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldsSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldsSection/ConfigName.md new file mode 100644 index 00000000..9dfe0488 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldsSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[FieldsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.FieldsSection') + +## FieldsSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Fields"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldsSection/FieldsSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldsSection/FieldsSection().md new file mode 100644 index 00000000..8656a6aa --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldsSection/FieldsSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[FieldsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.FieldsSection') + +## FieldsSection\(\) Constructor + +Initialize a new instance of the [FieldsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.FieldsSection') type\. + +```csharp +public FieldsSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldsSection/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldsSection/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..7b0fa811 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldsSection/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[FieldsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.FieldsSection') + +## FieldsSection\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected override bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldsSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldsSection/index.md new file mode 100644 index 00000000..9124a59c --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FieldsSection/index.md @@ -0,0 +1,24 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## FieldsSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [FieldDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/FieldDocItem/index.md 'DefaultDocumentation\.Models\.Members\.FieldDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class FieldsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DefaultDocumentation\.Markdown\.Sections\.ChildrenSection<](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')[FieldDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/FieldDocItem/index.md 'DefaultDocumentation\.Models\.Members\.FieldDocItem')[>](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') 🡒 FieldsSection + +| Constructors | | +| :--- | :--- | +| [FieldsSection\(\)](FieldsSection().md 'DefaultDocumentation\.Markdown\.Sections\.FieldsSection\.FieldsSection\(\)') | Initialize a new instance of the [FieldsSection](DefaultDocumentation/Markdown/Sections/FieldsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.FieldsSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.FieldsSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.FieldsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/FooterSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FooterSection/ConfigName.md new file mode 100644 index 00000000..47f6cc91 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FooterSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[FooterSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.FooterSection') + +## FooterSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Footer"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/FooterSection/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FooterSection/Name.md new file mode 100644 index 00000000..e51149b4 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FooterSection/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[FooterSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.FooterSection') + +## FooterSection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/FooterSection/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FooterSection/Write(IWriter).md new file mode 100644 index 00000000..6b50c428 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FooterSection/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[FooterSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.FooterSection') + +## FooterSection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/FooterSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FooterSection/index.md new file mode 100644 index 00000000..99a97f08 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/FooterSection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## FooterSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write a link to [DefaultDocumentation](https://github.com/Doraku/DefaultDocumentation 'https://github\.com/Doraku/DefaultDocumentation')\. + +```csharp +public sealed class FooterSection : DefaultDocumentation.Api.ISection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 FooterSection + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.FooterSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.FooterSection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.FooterSection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/HeaderSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/HeaderSection/ConfigName.md new file mode 100644 index 00000000..d630bc68 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/HeaderSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[HeaderSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.HeaderSection') + +## HeaderSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Header"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/HeaderSection/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/HeaderSection/Name.md new file mode 100644 index 00000000..5643fe0b --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/HeaderSection/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[HeaderSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.HeaderSection') + +## HeaderSection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/HeaderSection/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/HeaderSection/Write(IWriter).md new file mode 100644 index 00000000..a0080259 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/HeaderSection/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[HeaderSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.HeaderSection') + +## HeaderSection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/HeaderSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/HeaderSection/index.md new file mode 100644 index 00000000..b006a2b5 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/HeaderSection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## HeaderSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write a link to the top level documentation page\. + +```csharp +public sealed class HeaderSection : DefaultDocumentation.Api.ISection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 HeaderSection + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.HeaderSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.HeaderSection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.HeaderSection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ImplementSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ImplementSection/ConfigName.md new file mode 100644 index 00000000..560ec936 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ImplementSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ImplementSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ImplementSection') + +## ImplementSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Implement"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ImplementSection/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ImplementSection/Name.md new file mode 100644 index 00000000..9c40de56 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ImplementSection/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ImplementSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ImplementSection') + +## ImplementSection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ImplementSection/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ImplementSection/Write(IWriter).md new file mode 100644 index 00000000..6a581d3f --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ImplementSection/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ImplementSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ImplementSection') + +## ImplementSection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ImplementSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ImplementSection/index.md new file mode 100644 index 00000000..f17149bc --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ImplementSection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## ImplementSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the types/members implemented by the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class ImplementSection : DefaultDocumentation.Api.ISection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ImplementSection + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ImplementSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.ImplementSection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.ImplementSection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/InheritanceSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/InheritanceSection/ConfigName.md new file mode 100644 index 00000000..c992d7ba --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/InheritanceSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[InheritanceSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.InheritanceSection') + +## InheritanceSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Inheritance"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/InheritanceSection/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/InheritanceSection/Name.md new file mode 100644 index 00000000..042c2519 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/InheritanceSection/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[InheritanceSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.InheritanceSection') + +## InheritanceSection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/InheritanceSection/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/InheritanceSection/Write(IWriter).md new file mode 100644 index 00000000..987211d0 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/InheritanceSection/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[InheritanceSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.InheritanceSection') + +## InheritanceSection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/InheritanceSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/InheritanceSection/index.md new file mode 100644 index 00000000..f3b74129 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/InheritanceSection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## InheritanceSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the types inherited by the [TypeDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem')\. + +```csharp +public sealed class InheritanceSection : DefaultDocumentation.Api.ISection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 InheritanceSection + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.InheritanceSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.InheritanceSection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.InheritanceSection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/InterfacesSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/InterfacesSection/ConfigName.md new file mode 100644 index 00000000..c914d21d --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/InterfacesSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[InterfacesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.InterfacesSection') + +## InterfacesSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Interfaces"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/InterfacesSection/InterfacesSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/InterfacesSection/InterfacesSection().md new file mode 100644 index 00000000..96c854e8 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/InterfacesSection/InterfacesSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[InterfacesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.InterfacesSection') + +## InterfacesSection\(\) Constructor + +Initialize a new instance of the [InterfacesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.InterfacesSection') type\. + +```csharp +public InterfacesSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/InterfacesSection/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/InterfacesSection/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..f158220b --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/InterfacesSection/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[InterfacesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.InterfacesSection') + +## InterfacesSection\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected override bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/InterfacesSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/InterfacesSection/index.md new file mode 100644 index 00000000..fb519bd6 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/InterfacesSection/index.md @@ -0,0 +1,24 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## InterfacesSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [InterfaceDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/InterfaceDocItem/index.md 'DefaultDocumentation\.Models\.Types\.InterfaceDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class InterfacesSection : DefaultDocumentation.Markdown.Sections.ChildrenSection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DefaultDocumentation\.Markdown\.Sections\.ChildrenSection<](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')[InterfaceDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/InterfaceDocItem/index.md 'DefaultDocumentation\.Models\.Types\.InterfaceDocItem')[>](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') 🡒 InterfacesSection + +| Constructors | | +| :--- | :--- | +| [InterfacesSection\(\)](InterfacesSection().md 'DefaultDocumentation\.Markdown\.Sections\.InterfacesSection\.InterfacesSection\(\)') | Initialize a new instance of the [InterfacesSection](DefaultDocumentation/Markdown/Sections/InterfacesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.InterfacesSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.InterfacesSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.InterfacesSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/ConfigName.md new file mode 100644 index 00000000..d5652efa --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[MethodOverloadsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodOverloadsSection') + +## MethodOverloadsSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "MethodOverloads"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/GetChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/GetChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..2012a26b --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/GetChildren(IGeneralContext,DocItem).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[MethodOverloadsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodOverloadsSection') + +## MethodOverloadsSection\.GetChildren\(IGeneralContext, DocItem\) Method + +Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. + +```csharp +protected override System.Collections.Generic.IEnumerable? GetChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[MethodDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/index.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') +The children to write\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/MethodOverloadsSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/MethodOverloadsSection().md new file mode 100644 index 00000000..e75b418e --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/MethodOverloadsSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[MethodOverloadsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodOverloadsSection') + +## MethodOverloadsSection\(\) Constructor + +Initialize a new instance of the [ConstructorsSection](../ConstructorsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection') type\. + +```csharp +public MethodOverloadsSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..9dbd2f20 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[MethodOverloadsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodOverloadsSection') + +## MethodOverloadsSection\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected override bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/index.md new file mode 100644 index 00000000..e61e0597 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/index.md @@ -0,0 +1,25 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## MethodOverloadsSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [MethodOverloadsSection](DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodOverloadsSection') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class MethodOverloadsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DefaultDocumentation\.Markdown\.Sections\.ChildrenSection<](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')[MethodDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/index.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem')[>](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') 🡒 MethodOverloadsSection + +| Constructors | | +| :--- | :--- | +| [MethodOverloadsSection\(\)](MethodOverloadsSection().md 'DefaultDocumentation\.Markdown\.Sections\.MethodOverloadsSection\.MethodOverloadsSection\(\)') | Initialize a new instance of the [ConstructorsSection](../ConstructorsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.MethodOverloadsSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [GetChildren\(IGeneralContext, DocItem\)](GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.MethodOverloadsSection\.GetChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.MethodOverloadsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodsSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodsSection/ConfigName.md new file mode 100644 index 00000000..2cee54c3 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodsSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[MethodsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection') + +## MethodsSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Methods"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodsSection/GetChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodsSection/GetChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..3003bd12 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodsSection/GetChildren(IGeneralContext,DocItem).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[MethodsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection') + +## MethodsSection\.GetChildren\(IGeneralContext, DocItem\) Method + +Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. + +```csharp +protected override System.Collections.Generic.IEnumerable? GetChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[MethodDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/index.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') +The children to write\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodsSection/MethodsSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodsSection/MethodsSection().md new file mode 100644 index 00000000..a7350fe3 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodsSection/MethodsSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[MethodsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection') + +## MethodsSection\(\) Constructor + +Initialize a new instance of the [MethodsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection') type\. + +```csharp +public MethodsSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodsSection/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodsSection/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..66ec74f8 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodsSection/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[MethodsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection') + +## MethodsSection\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected override bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodsSection/ShouldWriteTitle(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodsSection/ShouldWriteTitle(IGeneralContext,DocItem).md new file mode 100644 index 00000000..cc1bf105 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodsSection/ShouldWriteTitle(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[MethodsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection') + +## MethodsSection\.ShouldWriteTitle\(IGeneralContext, DocItem\) Method + +Gets if the title should be writen or not\. + +```csharp +protected override bool ShouldWriteTitle(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodsSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodsSection/index.md new file mode 100644 index 00000000..0a5ec012 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/MethodsSection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## MethodsSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [MethodDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/index.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class MethodsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DefaultDocumentation\.Markdown\.Sections\.ChildrenSection<](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')[MethodDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/index.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem')[>](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') 🡒 MethodsSection + +| Constructors | | +| :--- | :--- | +| [MethodsSection\(\)](MethodsSection().md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection\.MethodsSection\(\)') | Initialize a new instance of the [MethodsSection](DefaultDocumentation/Markdown/Sections/MethodsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [GetChildren\(IGeneralContext, DocItem\)](GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection\.GetChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | +| [ShouldWriteTitle\(IGeneralContext, DocItem\)](ShouldWriteTitle(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection\.ShouldWriteTitle\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the title should be writen or not\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/NamespacesSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/NamespacesSection/ConfigName.md new file mode 100644 index 00000000..8eb4f9f2 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/NamespacesSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[NamespacesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.NamespacesSection') + +## NamespacesSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Namespaces"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/NamespacesSection/NamespacesSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/NamespacesSection/NamespacesSection().md new file mode 100644 index 00000000..e905d3ce --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/NamespacesSection/NamespacesSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[NamespacesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.NamespacesSection') + +## NamespacesSection\(\) Constructor + +Initialize a new instance of the [NamespacesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.NamespacesSection') type\. + +```csharp +public NamespacesSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/NamespacesSection/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/NamespacesSection/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..057a3492 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/NamespacesSection/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[NamespacesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.NamespacesSection') + +## NamespacesSection\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected override bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/NamespacesSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/NamespacesSection/index.md new file mode 100644 index 00000000..e1386970 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/NamespacesSection/index.md @@ -0,0 +1,24 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## NamespacesSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [NamespaceDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/NamespaceDocItem/index.md 'DefaultDocumentation\.Models\.NamespaceDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class NamespacesSection : DefaultDocumentation.Markdown.Sections.ChildrenSection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DefaultDocumentation\.Markdown\.Sections\.ChildrenSection<](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')[NamespaceDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/NamespaceDocItem/index.md 'DefaultDocumentation\.Models\.NamespaceDocItem')[>](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') 🡒 NamespacesSection + +| Constructors | | +| :--- | :--- | +| [NamespacesSection\(\)](NamespacesSection().md 'DefaultDocumentation\.Markdown\.Sections\.NamespacesSection\.NamespacesSection\(\)') | Initialize a new instance of the [NamespacesSection](DefaultDocumentation/Markdown/Sections/NamespacesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.NamespacesSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.NamespacesSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.NamespacesSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/OperatorsSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/OperatorsSection/ConfigName.md new file mode 100644 index 00000000..2e0caaeb --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/OperatorsSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[OperatorsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.OperatorsSection') + +## OperatorsSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Operators"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/OperatorsSection/OperatorsSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/OperatorsSection/OperatorsSection().md new file mode 100644 index 00000000..2333933f --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/OperatorsSection/OperatorsSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[OperatorsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.OperatorsSection') + +## OperatorsSection\(\) Constructor + +Initialize a new instance of the [OperatorsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.OperatorsSection') type\. + +```csharp +public OperatorsSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/OperatorsSection/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/OperatorsSection/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..afef9838 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/OperatorsSection/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[OperatorsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.OperatorsSection') + +## OperatorsSection\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected override bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/OperatorsSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/OperatorsSection/index.md new file mode 100644 index 00000000..b3a9be01 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/OperatorsSection/index.md @@ -0,0 +1,24 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## OperatorsSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [OperatorDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/OperatorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.OperatorDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class OperatorsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DefaultDocumentation\.Markdown\.Sections\.ChildrenSection<](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')[OperatorDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/OperatorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.OperatorDocItem')[>](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') 🡒 OperatorsSection + +| Constructors | | +| :--- | :--- | +| [OperatorsSection\(\)](OperatorsSection().md 'DefaultDocumentation\.Markdown\.Sections\.OperatorsSection\.OperatorsSection\(\)') | Initialize a new instance of the [OperatorsSection](DefaultDocumentation/Markdown/Sections/OperatorsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.OperatorsSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.OperatorsSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.OperatorsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ParametersSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ParametersSection/ConfigName.md new file mode 100644 index 00000000..cf859e89 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ParametersSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ParametersSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ParametersSection') + +## ParametersSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Parameters"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ParametersSection/GetChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ParametersSection/GetChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..a5d5374d --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ParametersSection/GetChildren(IGeneralContext,DocItem).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ParametersSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ParametersSection') + +## ParametersSection\.GetChildren\(IGeneralContext, DocItem\) Method + +Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. + +```csharp +protected override System.Collections.Generic.IEnumerable? GetChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[ParameterDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') +The children to write\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ParametersSection/ParametersSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ParametersSection/ParametersSection().md new file mode 100644 index 00000000..ac5b0dbb --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ParametersSection/ParametersSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ParametersSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ParametersSection') + +## ParametersSection\(\) Constructor + +Initialize a new instance of the [ParametersSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ParametersSection') type\. + +```csharp +public ParametersSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ParametersSection/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ParametersSection/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..356e6278 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ParametersSection/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ParametersSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ParametersSection') + +## ParametersSection\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected override bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ParametersSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ParametersSection/index.md new file mode 100644 index 00000000..fe5fb757 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ParametersSection/index.md @@ -0,0 +1,25 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## ParametersSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [ParameterDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class ParametersSection : DefaultDocumentation.Markdown.Sections.ChildrenSection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DefaultDocumentation\.Markdown\.Sections\.ChildrenSection<](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')[ParameterDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem')[>](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') 🡒 ParametersSection + +| Constructors | | +| :--- | :--- | +| [ParametersSection\(\)](ParametersSection().md 'DefaultDocumentation\.Markdown\.Sections\.ParametersSection\.ParametersSection\(\)') | Initialize a new instance of the [ParametersSection](DefaultDocumentation/Markdown/Sections/ParametersSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ParametersSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ParametersSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [GetChildren\(IGeneralContext, DocItem\)](GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ParametersSection\.GetChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ParametersSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/PropertiesSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/PropertiesSection/ConfigName.md new file mode 100644 index 00000000..936570a4 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/PropertiesSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[PropertiesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.PropertiesSection') + +## PropertiesSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Properties"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/PropertiesSection/PropertiesSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/PropertiesSection/PropertiesSection().md new file mode 100644 index 00000000..9a1ef201 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/PropertiesSection/PropertiesSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[PropertiesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.PropertiesSection') + +## PropertiesSection\(\) Constructor + +Initialize a new instance of the [PropertiesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.PropertiesSection') type\. + +```csharp +public PropertiesSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/PropertiesSection/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/PropertiesSection/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..168eb7de --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/PropertiesSection/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[PropertiesSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.PropertiesSection') + +## PropertiesSection\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected override bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/PropertiesSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/PropertiesSection/index.md new file mode 100644 index 00000000..fabf61ad --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/PropertiesSection/index.md @@ -0,0 +1,24 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## PropertiesSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [PropertyDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/PropertyDocItem/index.md 'DefaultDocumentation\.Models\.Members\.PropertyDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class PropertiesSection : DefaultDocumentation.Markdown.Sections.ChildrenSection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DefaultDocumentation\.Markdown\.Sections\.ChildrenSection<](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')[PropertyDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/PropertyDocItem/index.md 'DefaultDocumentation\.Models\.Members\.PropertyDocItem')[>](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') 🡒 PropertiesSection + +| Constructors | | +| :--- | :--- | +| [PropertiesSection\(\)](PropertiesSection().md 'DefaultDocumentation\.Markdown\.Sections\.PropertiesSection\.PropertiesSection\(\)') | Initialize a new instance of the [PropertiesSection](DefaultDocumentation/Markdown/Sections/PropertiesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.PropertiesSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.PropertiesSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.PropertiesSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/RemarksSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/RemarksSection/ConfigName.md new file mode 100644 index 00000000..dbbe0dbf --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/RemarksSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[RemarksSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.RemarksSection') + +## RemarksSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "remarks"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/RemarksSection/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/RemarksSection/Name.md new file mode 100644 index 00000000..c290548f --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/RemarksSection/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[RemarksSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.RemarksSection') + +## RemarksSection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/RemarksSection/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/RemarksSection/Write(IWriter).md new file mode 100644 index 00000000..5105c74a --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/RemarksSection/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[RemarksSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.RemarksSection') + +## RemarksSection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/RemarksSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/RemarksSection/index.md new file mode 100644 index 00000000..051ed7aa --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/RemarksSection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## RemarksSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the `remarks` top level element\. + +```csharp +public sealed class RemarksSection : DefaultDocumentation.Api.ISection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 RemarksSection + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.RemarksSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.RemarksSection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.RemarksSection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ReturnsSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ReturnsSection/ConfigName.md new file mode 100644 index 00000000..19601992 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ReturnsSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ReturnsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ReturnsSection') + +## ReturnsSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "returns"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ReturnsSection/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ReturnsSection/Name.md new file mode 100644 index 00000000..8bd46ca5 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ReturnsSection/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ReturnsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ReturnsSection') + +## ReturnsSection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ReturnsSection/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ReturnsSection/Write(IWriter).md new file mode 100644 index 00000000..e95ec01e --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ReturnsSection/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ReturnsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ReturnsSection') + +## ReturnsSection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ReturnsSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ReturnsSection/index.md new file mode 100644 index 00000000..3d189be7 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ReturnsSection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## ReturnsSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the `returns` top level element\. + +```csharp +public sealed class ReturnsSection : DefaultDocumentation.Api.ISection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ReturnsSection + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ReturnsSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.ReturnsSection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.ReturnsSection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/SeeAlsoSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/SeeAlsoSection/ConfigName.md new file mode 100644 index 00000000..b0127186 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/SeeAlsoSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[SeeAlsoSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.SeeAlsoSection') + +## SeeAlsoSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "seealso"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/SeeAlsoSection/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/SeeAlsoSection/Name.md new file mode 100644 index 00000000..c5f60dc2 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/SeeAlsoSection/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[SeeAlsoSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.SeeAlsoSection') + +## SeeAlsoSection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/SeeAlsoSection/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/SeeAlsoSection/Write(IWriter).md new file mode 100644 index 00000000..5c3908d6 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/SeeAlsoSection/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[SeeAlsoSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.SeeAlsoSection') + +## SeeAlsoSection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/SeeAlsoSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/SeeAlsoSection/index.md new file mode 100644 index 00000000..0718937c --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/SeeAlsoSection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## SeeAlsoSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the `seealso` top level elements\. + +```csharp +public sealed class SeeAlsoSection : DefaultDocumentation.Api.ISection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 SeeAlsoSection + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.SeeAlsoSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.SeeAlsoSection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.SeeAlsoSection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/StructsSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/StructsSection/ConfigName.md new file mode 100644 index 00000000..b1559985 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/StructsSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[StructsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.StructsSection') + +## StructsSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Structs"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/StructsSection/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/StructsSection/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..c507a37d --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/StructsSection/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[StructsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.StructsSection') + +## StructsSection\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected override bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/StructsSection/StructsSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/StructsSection/StructsSection().md new file mode 100644 index 00000000..53fa8966 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/StructsSection/StructsSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[StructsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.StructsSection') + +## StructsSection\(\) Constructor + +Initialize a new instance of the [StructsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.StructsSection') type\. + +```csharp +public StructsSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/StructsSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/StructsSection/index.md new file mode 100644 index 00000000..01e22f29 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/StructsSection/index.md @@ -0,0 +1,24 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## StructsSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [StructDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/StructDocItem/index.md 'DefaultDocumentation\.Models\.Types\.StructDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class StructsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DefaultDocumentation\.Markdown\.Sections\.ChildrenSection<](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')[StructDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/StructDocItem/index.md 'DefaultDocumentation\.Models\.Types\.StructDocItem')[>](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') 🡒 StructsSection + +| Constructors | | +| :--- | :--- | +| [StructsSection\(\)](StructsSection().md 'DefaultDocumentation\.Markdown\.Sections\.StructsSection\.StructsSection\(\)') | Initialize a new instance of the [StructsSection](DefaultDocumentation/Markdown/Sections/StructsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.StructsSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.StructsSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.StructsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/SummarySection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/SummarySection/ConfigName.md new file mode 100644 index 00000000..3866d654 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/SummarySection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[SummarySection](index.md 'DefaultDocumentation\.Markdown\.Sections\.SummarySection') + +## SummarySection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "summary"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/SummarySection/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/SummarySection/Name.md new file mode 100644 index 00000000..22d8d9b3 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/SummarySection/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[SummarySection](index.md 'DefaultDocumentation\.Markdown\.Sections\.SummarySection') + +## SummarySection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/SummarySection/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/SummarySection/Write(IWriter).md new file mode 100644 index 00000000..0b64cfd3 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/SummarySection/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[SummarySection](index.md 'DefaultDocumentation\.Markdown\.Sections\.SummarySection') + +## SummarySection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/SummarySection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/SummarySection/index.md new file mode 100644 index 00000000..7a206614 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/SummarySection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## SummarySection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the `summary` top level element\. + +```csharp +public sealed class SummarySection : DefaultDocumentation.Api.ISection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 SummarySection + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.SummarySection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.SummarySection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.SummarySection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/TableOfContentsSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TableOfContentsSection/ConfigName.md new file mode 100644 index 00000000..6d969c37 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TableOfContentsSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[TableOfContentsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection') + +## TableOfContentsSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "TableOfContents"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md new file mode 100644 index 00000000..b30c2b49 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md @@ -0,0 +1,47 @@ +#### [DefaultDocumentation\.Markdown](../../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[TableOfContentsSection](../index.md 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection') + +## TableOfContentsSection\.Modes Enum + +The different options to customize the table of contents\. + +```csharp +public enum TableOfContentsSection.Modes +``` +### Fields + + + +`None` 0 + +Default generation\. + + + +`Grouped` 1 + +[DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') will appear in their kind section\. + + + +`IncludeKind` 2 + +The kind of each [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') will appear explicitely\. + + + +`IncludeSummary` 4 + +The summary of each [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') will be displayed\. + + + +`IncludeNewLine` 8 + +There should be a new line when displaying the summary of the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + + + +`IncludeSummaryWithNewLine` 12 + +Same as [IncludeSummary](DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummary 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection\.Modes\.IncludeSummary') and [IncludeNewLine](DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeNewLine 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection\.Modes\.IncludeNewLine') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Name.md new file mode 100644 index 00000000..ed31fa4d --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[TableOfContentsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection') + +## TableOfContentsSection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Write(IWriter).md new file mode 100644 index 00000000..2b60dbf6 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[TableOfContentsSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection') + +## TableOfContentsSection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/TableOfContentsSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TableOfContentsSection/index.md new file mode 100644 index 00000000..08e05283 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TableOfContentsSection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## TableOfContentsSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write a table of content of all children of the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class TableOfContentsSection : DefaultDocumentation.Api.ISection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 TableOfContentsSection + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/TitleSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TitleSection/ConfigName.md new file mode 100644 index 00000000..71a4a24c --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TitleSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[TitleSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.TitleSection') + +## TitleSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "Title"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/TitleSection/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TitleSection/Name.md new file mode 100644 index 00000000..b8f4e9db --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TitleSection/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[TitleSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.TitleSection') + +## TitleSection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/TitleSection/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TitleSection/Write(IWriter).md new file mode 100644 index 00000000..63caa061 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TitleSection/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[TitleSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.TitleSection') + +## TitleSection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/TitleSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TitleSection/index.md new file mode 100644 index 00000000..72455954 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TitleSection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## TitleSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write a title of the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class TitleSection : DefaultDocumentation.Api.ISection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 TitleSection + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.TitleSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.TitleSection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.TitleSection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/TypeParametersSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TypeParametersSection/ConfigName.md new file mode 100644 index 00000000..38bd4951 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TypeParametersSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[TypeParametersSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.TypeParametersSection') + +## TypeParametersSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "TypeParameters"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/TypeParametersSection/GetChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TypeParametersSection/GetChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..408cc994 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TypeParametersSection/GetChildren(IGeneralContext,DocItem).md @@ -0,0 +1,27 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[TypeParametersSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.TypeParametersSection') + +## TypeParametersSection\.GetChildren\(IGeneralContext, DocItem\) Method + +Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. + +```csharp +protected override System.Collections.Generic.IEnumerable? GetChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[TypeParameterDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') +The children to write\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/TypeParametersSection/ShouldInlineChildren(IGeneralContext,DocItem).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TypeParametersSection/ShouldInlineChildren(IGeneralContext,DocItem).md new file mode 100644 index 00000000..eb29f26d --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TypeParametersSection/ShouldInlineChildren(IGeneralContext,DocItem).md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[TypeParametersSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.TypeParametersSection') + +## TypeParametersSection\.ShouldInlineChildren\(IGeneralContext, DocItem\) Method + +Gets if the children should be inlined or not\. + +```csharp +protected override bool ShouldInlineChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') + +The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') of the current documentation generation process\. + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to write its children\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/TypeParametersSection/TypeParametersSection().md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TypeParametersSection/TypeParametersSection().md new file mode 100644 index 00000000..9df93281 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TypeParametersSection/TypeParametersSection().md @@ -0,0 +1,10 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[TypeParametersSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.TypeParametersSection') + +## TypeParametersSection\(\) Constructor + +Initialize a new instance of the [TypeParametersSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.TypeParametersSection') type\. + +```csharp +public TypeParametersSection(); +``` \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/TypeParametersSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TypeParametersSection/index.md new file mode 100644 index 00000000..247fef7d --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/TypeParametersSection/index.md @@ -0,0 +1,25 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## TypeParametersSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [TypeParameterDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class TypeParametersSection : DefaultDocumentation.Markdown.Sections.ChildrenSection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [DefaultDocumentation\.Markdown\.Sections\.ChildrenSection<](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')[TypeParameterDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem')[>](../ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') 🡒 TypeParametersSection + +| Constructors | | +| :--- | :--- | +| [TypeParametersSection\(\)](TypeParametersSection().md 'DefaultDocumentation\.Markdown\.Sections\.TypeParametersSection\.TypeParametersSection\(\)') | Initialize a new instance of the [TypeParametersSection](DefaultDocumentation/Markdown/Sections/TypeParametersSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.TypeParametersSection') type\. | + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.TypeParametersSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [GetChildren\(IGeneralContext, DocItem\)](GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.TypeParametersSection\.GetChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. | +| [ShouldInlineChildren\(IGeneralContext, DocItem\)](ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.TypeParametersSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)') | Gets if the children should be inlined or not\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ValueSection/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ValueSection/ConfigName.md new file mode 100644 index 00000000..010f1ac2 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ValueSection/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ValueSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ValueSection') + +## ValueSection\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "value"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ValueSection/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ValueSection/Name.md new file mode 100644 index 00000000..424b48eb --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ValueSection/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ValueSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ValueSection') + +## ValueSection\.Name Property + +Gets the name of the section, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Name.md 'DefaultDocumentation\.Api\.ISection\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ValueSection/Write(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ValueSection/Write(IWriter).md new file mode 100644 index 00000000..5781c686 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ValueSection/Write(IWriter).md @@ -0,0 +1,19 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections').[ValueSection](index.md 'DefaultDocumentation\.Markdown\.Sections\.ValueSection') + +## ValueSection\.Write\(IWriter\) Method + +Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. + +```csharp +public void Write(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') to write to\. + +Implements [Write\(IWriter\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/Write(IWriter).md 'DefaultDocumentation\.Api\.ISection\.Write\(DefaultDocumentation\.Api\.IWriter\)') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Sections/ValueSection/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ValueSection/index.md new file mode 100644 index 00000000..c2c022dd --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Sections/ValueSection/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Sections](../../../../index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation\.Markdown\.Sections') + +## ValueSection Class + +[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the `value` top level element\. + +```csharp +public sealed class ValueSection : DefaultDocumentation.Api.ISection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ValueSection + +Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ValueSection\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.Sections\.ValueSection\.Name') | Gets the name of the section, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [Write\(IWriter\)](Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.ValueSection\.Write\(DefaultDocumentation\.Api\.IWriter\)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/ConfigName.md new file mode 100644 index 00000000..65393216 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.UrlFactories](../../../../index.md#DefaultDocumentation.Markdown.UrlFactories 'DefaultDocumentation\.Markdown\.UrlFactories').[DocItemFactory](index.md 'DefaultDocumentation\.Markdown\.UrlFactories\.DocItemFactory') + +## DocItemFactory\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "DocItem"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/GetUrl(IPageContext,string).md b/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/GetUrl(IPageContext,string).md new file mode 100644 index 00000000..b35920ee --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/GetUrl(IPageContext,string).md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.UrlFactories](../../../../index.md#DefaultDocumentation.Markdown.UrlFactories 'DefaultDocumentation\.Markdown\.UrlFactories').[DocItemFactory](index.md 'DefaultDocumentation\.Markdown\.UrlFactories\.DocItemFactory') + +## DocItemFactory\.GetUrl\(IPageContext, string\) Method + +Gets the url of the given id\. Returns null of the instance does not know how to handle the provided id\. + +```csharp +public string? GetUrl(DefaultDocumentation.IPageContext context, string id); +``` +#### Parameters + + + +`context` [IPageContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext') + +The [IPageContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext') of the current documentation generation process\. + + + +`id` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The id to get the url for\. + +Implements [GetUrl\(IPageContext, string\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IUrlFactory/GetUrl(IPageContext,string).md 'DefaultDocumentation\.Api\.IUrlFactory\.GetUrl\(DefaultDocumentation\.IPageContext,System\.String\)') + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +The url of the given id\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/Name.md new file mode 100644 index 00000000..42f65975 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.UrlFactories](../../../../index.md#DefaultDocumentation.Markdown.UrlFactories 'DefaultDocumentation\.Markdown\.UrlFactories').[DocItemFactory](index.md 'DefaultDocumentation\.Markdown\.UrlFactories\.DocItemFactory') + +## DocItemFactory\.Name Property + +Gets the name of the factory, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IUrlFactory/Name.md 'DefaultDocumentation\.Api\.IUrlFactory\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/index.md b/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/index.md new file mode 100644 index 00000000..716ff9d6 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.UrlFactories](../../../../index.md#DefaultDocumentation.Markdown.UrlFactories 'DefaultDocumentation\.Markdown\.UrlFactories') + +## DocItemFactory Class + +Handles id for known [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + +```csharp +public sealed class DocItemFactory : DefaultDocumentation.Api.IUrlFactory +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 DocItemFactory + +Implements [IUrlFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IUrlFactory/index.md 'DefaultDocumentation\.Api\.IUrlFactory') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.UrlFactories\.DocItemFactory\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.UrlFactories\.DocItemFactory\.Name') | Gets the name of the factory, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [GetUrl\(IPageContext, string\)](GetUrl(IPageContext,string).md 'DefaultDocumentation\.Markdown\.UrlFactories\.DocItemFactory\.GetUrl\(DefaultDocumentation\.IPageContext, string\)') | Gets the url of the given id\. Returns null of the instance does not know how to handle the provided id\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/ConfigName.md b/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/ConfigName.md new file mode 100644 index 00000000..67506468 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/ConfigName.md @@ -0,0 +1,13 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.UrlFactories](../../../../index.md#DefaultDocumentation.Markdown.UrlFactories 'DefaultDocumentation\.Markdown\.UrlFactories').[DotnetApiFactory](index.md 'DefaultDocumentation\.Markdown\.UrlFactories\.DotnetApiFactory') + +## DotnetApiFactory\.ConfigName Field + +The name of this implementation used at the configuration level\. + +```csharp +public const string ConfigName = "DotnetApi"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/GetUrl(IPageContext,string).md b/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/GetUrl(IPageContext,string).md new file mode 100644 index 00000000..27dd08ff --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/GetUrl(IPageContext,string).md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.UrlFactories](../../../../index.md#DefaultDocumentation.Markdown.UrlFactories 'DefaultDocumentation\.Markdown\.UrlFactories').[DotnetApiFactory](index.md 'DefaultDocumentation\.Markdown\.UrlFactories\.DotnetApiFactory') + +## DotnetApiFactory\.GetUrl\(IPageContext, string\) Method + +Gets the url of the given id\. Returns null of the instance does not know how to handle the provided id\. + +```csharp +public string GetUrl(DefaultDocumentation.IPageContext context, string id); +``` +#### Parameters + + + +`context` [IPageContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext') + +The [IPageContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext') of the current documentation generation process\. + + + +`id` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The id to get the url for\. + +Implements [GetUrl\(IPageContext, string\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IUrlFactory/GetUrl(IPageContext,string).md 'DefaultDocumentation\.Api\.IUrlFactory\.GetUrl\(DefaultDocumentation\.IPageContext,System\.String\)') + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +The url of the given id\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/Name.md b/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/Name.md new file mode 100644 index 00000000..556ae1d2 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/Name.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.UrlFactories](../../../../index.md#DefaultDocumentation.Markdown.UrlFactories 'DefaultDocumentation\.Markdown\.UrlFactories').[DotnetApiFactory](index.md 'DefaultDocumentation\.Markdown\.UrlFactories\.DotnetApiFactory') + +## DotnetApiFactory\.Name Property + +Gets the name of the factory, used to identify it at the configuration level\. + +```csharp +public string Name { get; } +``` + +Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IUrlFactory/Name.md 'DefaultDocumentation\.Api\.IUrlFactory\.Name') + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/index.md b/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/index.md new file mode 100644 index 00000000..9293bfa4 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/index.md @@ -0,0 +1,26 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.UrlFactories](../../../../index.md#DefaultDocumentation.Markdown.UrlFactories 'DefaultDocumentation\.Markdown\.UrlFactories') + +## DotnetApiFactory Class + +Transforms any id as a dotnet api url\. + +```csharp +public sealed class DotnetApiFactory : DefaultDocumentation.Api.IUrlFactory +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 DotnetApiFactory + +Implements [IUrlFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IUrlFactory/index.md 'DefaultDocumentation\.Api\.IUrlFactory') + +| Fields | | +| :--- | :--- | +| [ConfigName](ConfigName.md 'DefaultDocumentation\.Markdown\.UrlFactories\.DotnetApiFactory\.ConfigName') | The name of this implementation used at the configuration level\. | + +| Properties | | +| :--- | :--- | +| [Name](Name.md 'DefaultDocumentation\.Markdown\.UrlFactories\.DotnetApiFactory\.Name') | Gets the name of the factory, used to identify it at the configuration level\. | + +| Methods | | +| :--- | :--- | +| [GetUrl\(IPageContext, string\)](GetUrl(IPageContext,string).md 'DefaultDocumentation\.Markdown\.UrlFactories\.DotnetApiFactory\.GetUrl\(DefaultDocumentation\.IPageContext, string\)') | Gets the url of the given id\. Returns null of the instance does not know how to handle the provided id\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/Append(string).md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/Append(string).md new file mode 100644 index 00000000..2dfc6d13 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/Append(string).md @@ -0,0 +1,23 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers').[MarkdownWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') + +## MarkdownWriter\.Append\(string\) Method + +Appends a string at the end of the documentation text\. + +```csharp +public DefaultDocumentation.Api.IWriter Append(string value); +``` +#### Parameters + + + +`value` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The value to append\. + +Implements [Append\(string\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/Append(string).md 'DefaultDocumentation\.Api\.IWriter\.Append\(System\.String\)') + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The current [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/AppendLine().md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/AppendLine().md new file mode 100644 index 00000000..9fe8a270 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/AppendLine().md @@ -0,0 +1,16 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers').[MarkdownWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') + +## MarkdownWriter\.AppendLine\(\) Method + +Appends a [System\.Environment\.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System\.Environment\.NewLine') or a `` at the end of the documentation text depending of the current setting\. + +```csharp +public DefaultDocumentation.Api.IWriter AppendLine(); +``` + +Implements [AppendLine\(\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/AppendLine().md 'DefaultDocumentation\.Api\.IWriter\.AppendLine') + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The current [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/Context.md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/Context.md new file mode 100644 index 00000000..c97527aa --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/Context.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers').[MarkdownWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') + +## MarkdownWriter\.Context Property + +Gets the [IPageContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext') of the current documentation generation process\. + +```csharp +public DefaultDocumentation.IPageContext Context { get; } +``` + +Implements [Context](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/Context.md 'DefaultDocumentation\.Api\.IWriter\.Context') + +#### Property Value +[IPageContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/EndsWith(string).md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/EndsWith(string).md new file mode 100644 index 00000000..f5ac7796 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/EndsWith(string).md @@ -0,0 +1,23 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers').[MarkdownWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') + +## MarkdownWriter\.EndsWith\(string\) Method + +Returns whether the documentation text ends with the given string\. + +```csharp +public bool EndsWith(string value); +``` +#### Parameters + + + +`value` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') to check\. + +Implements [EndsWith\(string\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/EndsWith(string).md 'DefaultDocumentation\.Api\.IWriter\.EndsWith\(System\.String\)') + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs\.microsoft\.com/en\-us/dotnet/csharp/language\-reference/builtin\-types/bool') if the documentation text ends with [value](DefaultDocumentation/Markdown/Writers/MarkdownWriter/EndsWith(string).md#DefaultDocumentation.Markdown.Writers.MarkdownWriter.EndsWith(string).value 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter\.EndsWith\(string\)\.value'), else [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs\.microsoft\.com/en\-us/dotnet/csharp/language\-reference/builtin\-types/bool')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/Length.md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/Length.md new file mode 100644 index 00000000..ca65edcc --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/Length.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers').[MarkdownWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') + +## MarkdownWriter\.Length Property + +Gets or sets the length of the documentation text currently produced\. + +```csharp +public int Length { get; set; } +``` + +Implements [Length](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/Length.md 'DefaultDocumentation\.Api\.IWriter\.Length') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/MarkdownWriter(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/MarkdownWriter(IWriter).md new file mode 100644 index 00000000..a81032e5 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/MarkdownWriter(IWriter).md @@ -0,0 +1,17 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers').[MarkdownWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') + +## MarkdownWriter\(IWriter\) Constructor + +Initializes a new instance of the [MarkdownWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. + +```csharp +public MarkdownWriter(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') instance to decorate\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/index.md new file mode 100644 index 00000000..a73a793f --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/MarkdownWriter/index.md @@ -0,0 +1,30 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers') + +## MarkdownWriter Class + +Decorator of the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') type to handle the [Markdown\.HandleLineBreak](https://github.com/Doraku/DefaultDocumentation#HandleLineBreak 'https://github\.com/Doraku/DefaultDocumentation\#HandleLineBreak') setting\. +It also uses a [OverrideWriter](../OverrideWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter') internally to further decorate the instance\. + +```csharp +public sealed class MarkdownWriter : DefaultDocumentation.Api.IWriter +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 MarkdownWriter + +Implements [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +| Constructors | | +| :--- | :--- | +| [MarkdownWriter\(IWriter\)](MarkdownWriter(IWriter).md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter\.MarkdownWriter\(DefaultDocumentation\.Api\.IWriter\)') | Initializes a new instance of the [MarkdownWriter](DefaultDocumentation/Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. | + +| Properties | | +| :--- | :--- | +| [Context](Context.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter\.Context') | Gets the [IPageContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext') of the current documentation generation process\. | +| [Length](Length.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter\.Length') | Gets or sets the length of the documentation text currently produced\. | + +| Methods | | +| :--- | :--- | +| [Append\(string\)](Append(string).md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter\.Append\(string\)') | Appends a string at the end of the documentation text\. | +| [AppendLine\(\)](AppendLine().md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter\.AppendLine\(\)') | Appends a [System\.Environment\.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System\.Environment\.NewLine') or a `` at the end of the documentation text depending of the current setting\. | +| [EndsWith\(string\)](EndsWith(string).md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter\.EndsWith\(string\)') | Returns whether the documentation text ends with the given string\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/Append(string).md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/Append(string).md new file mode 100644 index 00000000..d92fdb35 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/Append(string).md @@ -0,0 +1,23 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers').[OverrideWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter') + +## OverrideWriter\.Append\(string\) Method + +Appends a string at the end of the documentation text\. + +```csharp +public DefaultDocumentation.Api.IWriter Append(string value); +``` +#### Parameters + + + +`value` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The value to append\. + +Implements [Append\(string\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/Append(string).md 'DefaultDocumentation\.Api\.IWriter\.Append\(System\.String\)') + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The current [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/AppendLine().md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/AppendLine().md new file mode 100644 index 00000000..98214209 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/AppendLine().md @@ -0,0 +1,16 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers').[OverrideWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter') + +## OverrideWriter\.AppendLine\(\) Method + +Appends a [System\.Environment\.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System\.Environment\.NewLine') at the end of the documentation text\. + +```csharp +public DefaultDocumentation.Api.IWriter AppendLine(); +``` + +Implements [AppendLine\(\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/AppendLine().md 'DefaultDocumentation\.Api\.IWriter\.AppendLine') + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The current [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/Context.md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/Context.md new file mode 100644 index 00000000..06f6d30d --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/Context.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers').[OverrideWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter') + +## OverrideWriter\.Context Property + +Gets the [IPageContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext') of the current documentation generation process\. + +```csharp +public DefaultDocumentation.IPageContext Context { get; } +``` + +Implements [Context](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/Context.md 'DefaultDocumentation\.Api\.IWriter\.Context') + +#### Property Value +[IPageContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/EndsWith(string).md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/EndsWith(string).md new file mode 100644 index 00000000..43fe5cca --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/EndsWith(string).md @@ -0,0 +1,23 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers').[OverrideWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter') + +## OverrideWriter\.EndsWith\(string\) Method + +Returns whether the documentation text ends with the given string\. + +```csharp +public bool EndsWith(string value); +``` +#### Parameters + + + +`value` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') to check\. + +Implements [EndsWith\(string\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/EndsWith(string).md 'DefaultDocumentation\.Api\.IWriter\.EndsWith\(System\.String\)') + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs\.microsoft\.com/en\-us/dotnet/csharp/language\-reference/builtin\-types/bool') if the documentation text ends with [value](DefaultDocumentation/Markdown/Writers/OverrideWriter/EndsWith(string).md#DefaultDocumentation.Markdown.Writers.OverrideWriter.EndsWith(string).value 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter\.EndsWith\(string\)\.value'), else [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs\.microsoft\.com/en\-us/dotnet/csharp/language\-reference/builtin\-types/bool')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/Length.md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/Length.md new file mode 100644 index 00000000..cc1dff7e --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/Length.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers').[OverrideWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter') + +## OverrideWriter\.Length Property + +Gets or sets the length of the documentation text currently produced\. + +```csharp +public int Length { get; set; } +``` + +Implements [Length](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/Length.md 'DefaultDocumentation\.Api\.IWriter\.Length') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/OverrideWriter(IWriter).md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/OverrideWriter(IWriter).md new file mode 100644 index 00000000..2fa779f3 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/OverrideWriter(IWriter).md @@ -0,0 +1,17 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers').[OverrideWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter') + +## OverrideWriter\(IWriter\) Constructor + +Initializes a new instance of the [OverrideWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter') type\. + +```csharp +public OverrideWriter(DefaultDocumentation.Api.IWriter writer); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') instance to decorate\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/index.md new file mode 100644 index 00000000..32f357d1 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/OverrideWriter/index.md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers') + +## OverrideWriter Class + +Decorator of the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') type to override its data without changing its actual values\. + +```csharp +public sealed class OverrideWriter : DefaultDocumentation.Api.IWriter +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 OverrideWriter + +Implements [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +| Constructors | | +| :--- | :--- | +| [OverrideWriter\(IWriter\)](OverrideWriter(IWriter).md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter\.OverrideWriter\(DefaultDocumentation\.Api\.IWriter\)') | Initializes a new instance of the [OverrideWriter](DefaultDocumentation/Markdown/Writers/OverrideWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter') type\. | + +| Properties | | +| :--- | :--- | +| [Context](Context.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter\.Context') | Gets the [IPageContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext') of the current documentation generation process\. | +| [Length](Length.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter\.Length') | Gets or sets the length of the documentation text currently produced\. | + +| Methods | | +| :--- | :--- | +| [Append\(string\)](Append(string).md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter\.Append\(string\)') | Appends a string at the end of the documentation text\. | +| [AppendLine\(\)](AppendLine().md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter\.AppendLine\(\)') | Appends a [System\.Environment\.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System\.Environment\.NewLine') at the end of the documentation text\. | +| [EndsWith\(string\)](EndsWith(string).md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter\.EndsWith\(string\)') | Returns whether the documentation text ends with the given string\. | diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/Append(string).md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/Append(string).md new file mode 100644 index 00000000..b2e3ecc4 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/Append(string).md @@ -0,0 +1,23 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers').[PrefixedWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter') + +## PrefixedWriter\.Append\(string\) Method + +Appends a string at the end of the documentation text\. + +```csharp +public DefaultDocumentation.Api.IWriter Append(string value); +``` +#### Parameters + + + +`value` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The value to append\. + +Implements [Append\(string\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/Append(string).md 'DefaultDocumentation\.Api\.IWriter\.Append\(System\.String\)') + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The current [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/AppendLine().md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/AppendLine().md new file mode 100644 index 00000000..72745e2f --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/AppendLine().md @@ -0,0 +1,16 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers').[PrefixedWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter') + +## PrefixedWriter\.AppendLine\(\) Method + +Appends a [System\.Environment\.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System\.Environment\.NewLine') at the end of the documentation text\. + +```csharp +public DefaultDocumentation.Api.IWriter AppendLine(); +``` + +Implements [AppendLine\(\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/AppendLine().md 'DefaultDocumentation\.Api\.IWriter\.AppendLine') + +#### Returns +[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') +The current [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/Context.md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/Context.md new file mode 100644 index 00000000..1c42c4a7 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/Context.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers').[PrefixedWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter') + +## PrefixedWriter\.Context Property + +Gets the [IPageContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext') of the current documentation generation process\. + +```csharp +public DefaultDocumentation.IPageContext Context { get; } +``` + +Implements [Context](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/Context.md 'DefaultDocumentation\.Api\.IWriter\.Context') + +#### Property Value +[IPageContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/EndsWith(string).md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/EndsWith(string).md new file mode 100644 index 00000000..64dec698 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/EndsWith(string).md @@ -0,0 +1,23 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers').[PrefixedWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter') + +## PrefixedWriter\.EndsWith\(string\) Method + +Returns whether the documentation text ends with the given string\. + +```csharp +public bool EndsWith(string value); +``` +#### Parameters + + + +`value` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') to check\. + +Implements [EndsWith\(string\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/EndsWith(string).md 'DefaultDocumentation\.Api\.IWriter\.EndsWith\(System\.String\)') + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs\.microsoft\.com/en\-us/dotnet/csharp/language\-reference/builtin\-types/bool') if the documentation text ends with [value](DefaultDocumentation/Markdown/Writers/PrefixedWriter/EndsWith(string).md#DefaultDocumentation.Markdown.Writers.PrefixedWriter.EndsWith(string).value 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter\.EndsWith\(string\)\.value'), else [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs\.microsoft\.com/en\-us/dotnet/csharp/language\-reference/builtin\-types/bool')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/Length.md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/Length.md new file mode 100644 index 00000000..56f8f139 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/Length.md @@ -0,0 +1,15 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers').[PrefixedWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter') + +## PrefixedWriter\.Length Property + +Gets or sets the length of the documentation text currently produced\. + +```csharp +public int Length { get; set; } +``` + +Implements [Length](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/Length.md 'DefaultDocumentation\.Api\.IWriter\.Length') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/PrefixedWriter(IWriter,string).md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/PrefixedWriter(IWriter,string).md new file mode 100644 index 00000000..b3e2af59 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/PrefixedWriter(IWriter,string).md @@ -0,0 +1,23 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers').[PrefixedWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter') + +## PrefixedWriter\(IWriter, string\) Constructor + +Initializes a new instance of the [PrefixedWriter](index.md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter') type\. + +```csharp +public PrefixedWriter(DefaultDocumentation.Api.IWriter writer, string prefix); +``` +#### Parameters + + + +`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') instance to decorate\. + + + +`prefix` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +The prefix to use at every new line start\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/index.md b/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/index.md new file mode 100644 index 00000000..9f755671 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Markdown/Writers/PrefixedWriter/index.md @@ -0,0 +1,29 @@ +#### [DefaultDocumentation\.Markdown](../../../../index.md 'index') +### [DefaultDocumentation\.Markdown\.Writers](../../../../index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation\.Markdown\.Writers') + +## PrefixedWriter Class + +Decorator of the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') type to prefix every new line with a specific [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')\. + +```csharp +public sealed class PrefixedWriter : DefaultDocumentation.Api.IWriter +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 PrefixedWriter + +Implements [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') + +| Constructors | | +| :--- | :--- | +| [PrefixedWriter\(IWriter, string\)](PrefixedWriter(IWriter,string).md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter\.PrefixedWriter\(DefaultDocumentation\.Api\.IWriter, string\)') | Initializes a new instance of the [PrefixedWriter](DefaultDocumentation/Markdown/Writers/PrefixedWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter') type\. | + +| Properties | | +| :--- | :--- | +| [Context](Context.md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter\.Context') | Gets the [IPageContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext') of the current documentation generation process\. | +| [Length](Length.md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter\.Length') | Gets or sets the length of the documentation text currently produced\. | + +| Methods | | +| :--- | :--- | +| [Append\(string\)](Append(string).md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter\.Append\(string\)') | Appends a string at the end of the documentation text\. | +| [AppendLine\(\)](AppendLine().md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter\.AppendLine\(\)') | Appends a [System\.Environment\.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System\.Environment\.NewLine') at the end of the documentation text\. | +| [EndsWith\(string\)](EndsWith(string).md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter\.EndsWith\(string\)') | Returns whether the documentation text ends with the given string\. | diff --git a/documentation/markdown/DefaultDocumentation/Models/DocItemExtensions/GetLongName(thisDocItem).md b/documentation/markdown/DefaultDocumentation/Models/DocItemExtensions/GetLongName(thisDocItem).md new file mode 100644 index 00000000..afff2798 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Models/DocItemExtensions/GetLongName(thisDocItem).md @@ -0,0 +1,22 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models').[DocItemExtensions](index.md 'DefaultDocumentation\.Models\.DocItemExtensions') + +## DocItemExtensions\.GetLongName\(this DocItem\) Method + +Gets the long name of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem'), being its full name without its namespace\. +This method should not be called on [AssemblyDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/AssemblyDocItem/index.md 'DefaultDocumentation\.Models\.AssemblyDocItem') or [NamespaceDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/NamespaceDocItem/index.md 'DefaultDocumentation\.Models\.NamespaceDocItem') types\. + +```csharp +public static string GetLongName(this DefaultDocumentation.Models.DocItem item); +``` +#### Parameters + + + +`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') + +The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') for which to get its long name\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +The long name of the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. \ No newline at end of file diff --git a/documentation/markdown/DefaultDocumentation/Models/DocItemExtensions/index.md b/documentation/markdown/DefaultDocumentation/Models/DocItemExtensions/index.md new file mode 100644 index 00000000..1a611cf9 --- /dev/null +++ b/documentation/markdown/DefaultDocumentation/Models/DocItemExtensions/index.md @@ -0,0 +1,16 @@ +#### [DefaultDocumentation\.Markdown](../../../index.md 'index') +### [DefaultDocumentation\.Models](../../../index.md#DefaultDocumentation.Models 'DefaultDocumentation\.Models') + +## DocItemExtensions Class + +Provides extension methods on the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') type\. + +```csharp +public static class DocItemExtensions +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 DocItemExtensions + +| Methods | | +| :--- | :--- | +| [GetLongName\(this DocItem\)](GetLongName(thisDocItem).md 'DefaultDocumentation\.Models\.DocItemExtensions\.GetLongName\(this DefaultDocumentation\.Models\.DocItem\)') | Gets the long name of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem'), being its full name without its namespace\. This method should not be called on [AssemblyDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/AssemblyDocItem/index.md 'DefaultDocumentation\.Models\.AssemblyDocItem') or [NamespaceDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/NamespaceDocItem/index.md 'DefaultDocumentation\.Models\.NamespaceDocItem') types\. | diff --git a/documentation/markdown/DefaultSection.ConfigName.md b/documentation/markdown/DefaultSection.ConfigName.md deleted file mode 100644 index 32c32c7b..00000000 --- a/documentation/markdown/DefaultSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[DefaultSection](DefaultSection.md 'DefaultDocumentation.Markdown.Sections.DefaultSection') - -## DefaultSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Default; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultSection.DefaultSection().md b/documentation/markdown/DefaultSection.DefaultSection().md deleted file mode 100644 index 0bd30543..00000000 --- a/documentation/markdown/DefaultSection.DefaultSection().md +++ /dev/null @@ -1,10 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[DefaultSection](DefaultSection.md 'DefaultDocumentation.Markdown.Sections.DefaultSection') - -## DefaultSection() Constructor - -Initialize a new instance of the [DefaultSection](DefaultSection.md 'DefaultDocumentation.Markdown.Sections.DefaultSection') type. - -```csharp -public DefaultSection(); -``` \ No newline at end of file diff --git a/documentation/markdown/DefaultSection.Name.md b/documentation/markdown/DefaultSection.Name.md deleted file mode 100644 index bb68055d..00000000 --- a/documentation/markdown/DefaultSection.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[DefaultSection](DefaultSection.md 'DefaultDocumentation.Markdown.Sections.DefaultSection') - -## DefaultSection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/DefaultSection.Write(IWriter).md b/documentation/markdown/DefaultSection.Write(IWriter).md deleted file mode 100644 index 7d3a4675..00000000 --- a/documentation/markdown/DefaultSection.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[DefaultSection](DefaultSection.md 'DefaultDocumentation.Markdown.Sections.DefaultSection') - -## DefaultSection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/DefaultSection.md b/documentation/markdown/DefaultSection.md deleted file mode 100644 index a1d39182..00000000 --- a/documentation/markdown/DefaultSection.md +++ /dev/null @@ -1,62 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## DefaultSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation regrouping the following implementation in this order: - -1. [TitleSection](TitleSection.md 'DefaultDocumentation.Markdown.Sections.TitleSection') -2. [SummarySection](SummarySection.md 'DefaultDocumentation.Markdown.Sections.SummarySection') -3. [DefinitionSection](DefinitionSection.md 'DefaultDocumentation.Markdown.Sections.DefinitionSection') -4. [TypeParametersSection](TypeParametersSection.md 'DefaultDocumentation.Markdown.Sections.TypeParametersSection') -5. [ParametersSection](ParametersSection.md 'DefaultDocumentation.Markdown.Sections.ParametersSection') -6. [EnumFieldsSection](EnumFieldsSection.md 'DefaultDocumentation.Markdown.Sections.EnumFieldsSection') -7. [InheritanceSection](InheritanceSection.md 'DefaultDocumentation.Markdown.Sections.InheritanceSection') -8. [DerivedSection](DerivedSection.md 'DefaultDocumentation.Markdown.Sections.DerivedSection') -9. [ImplementSection](ImplementSection.md 'DefaultDocumentation.Markdown.Sections.ImplementSection') -10. [EventTypeSection](EventTypeSection.md 'DefaultDocumentation.Markdown.Sections.EventTypeSection') -11. [FieldValueSection](FieldValueSection.md 'DefaultDocumentation.Markdown.Sections.FieldValueSection') -12. [ValueSection](ValueSection.md 'DefaultDocumentation.Markdown.Sections.ValueSection') -13. [ReturnsSection](ReturnsSection.md 'DefaultDocumentation.Markdown.Sections.ReturnsSection') -14. [ExceptionSection](ExceptionSection.md 'DefaultDocumentation.Markdown.Sections.ExceptionSection') -15. [ExampleSection](ExampleSection.md 'DefaultDocumentation.Markdown.Sections.ExampleSection') -16. [RemarksSection](RemarksSection.md 'DefaultDocumentation.Markdown.Sections.RemarksSection') -17. [SeeAlsoSection](SeeAlsoSection.md 'DefaultDocumentation.Markdown.Sections.SeeAlsoSection') -18. [NamespacesSection](NamespacesSection.md 'DefaultDocumentation.Markdown.Sections.NamespacesSection') -19. [ClassesSection](ClassesSection.md 'DefaultDocumentation.Markdown.Sections.ClassesSection') -20. [StructsSection](StructsSection.md 'DefaultDocumentation.Markdown.Sections.StructsSection') -21. [InterfacesSection](InterfacesSection.md 'DefaultDocumentation.Markdown.Sections.InterfacesSection') -22. [EnumsSection](EnumsSection.md 'DefaultDocumentation.Markdown.Sections.EnumsSection') -23. [DelegatesSection](DelegatesSection.md 'DefaultDocumentation.Markdown.Sections.DelegatesSection') -24. [ConstructorsSection](ConstructorsSection.md 'DefaultDocumentation.Markdown.Sections.ConstructorsSection') -25. [FieldsSection](FieldsSection.md 'DefaultDocumentation.Markdown.Sections.FieldsSection') -26. [PropertiesSection](PropertiesSection.md 'DefaultDocumentation.Markdown.Sections.PropertiesSection') -27. [MethodsSection](MethodsSection.md 'DefaultDocumentation.Markdown.Sections.MethodsSection') -28. [EventsSection](EventsSection.md 'DefaultDocumentation.Markdown.Sections.EventsSection') -29. [OperatorsSection](OperatorsSection.md 'DefaultDocumentation.Markdown.Sections.OperatorsSection') -30. [ExplicitInterfaceImplementationsSection](ExplicitInterfaceImplementationsSection.md 'DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection') - -```csharp -public sealed class DefaultSection : -DefaultDocumentation.Api.ISection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DefaultSection - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Constructors | | -| :--- | :--- | -| [DefaultSection()](DefaultSection.DefaultSection().md 'DefaultDocumentation.Markdown.Sections.DefaultSection.DefaultSection()') | Initialize a new instance of the [DefaultSection](DefaultSection.md 'DefaultDocumentation.Markdown.Sections.DefaultSection') type. | - -| Fields | | -| :--- | :--- | -| [ConfigName](DefaultSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.DefaultSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](DefaultSection.Name.md 'DefaultDocumentation.Markdown.Sections.DefaultSection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](DefaultSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.DefaultSection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/DefinitionSection.ConfigName.md b/documentation/markdown/DefinitionSection.ConfigName.md deleted file mode 100644 index 55d83c9d..00000000 --- a/documentation/markdown/DefinitionSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[DefinitionSection](DefinitionSection.md 'DefaultDocumentation.Markdown.Sections.DefinitionSection') - -## DefinitionSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Definition; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/DefinitionSection.Name.md b/documentation/markdown/DefinitionSection.Name.md deleted file mode 100644 index dcaaee67..00000000 --- a/documentation/markdown/DefinitionSection.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[DefinitionSection](DefinitionSection.md 'DefaultDocumentation.Markdown.Sections.DefinitionSection') - -## DefinitionSection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/DefinitionSection.Write(IWriter).md b/documentation/markdown/DefinitionSection.Write(IWriter).md deleted file mode 100644 index 4cbb155d..00000000 --- a/documentation/markdown/DefinitionSection.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[DefinitionSection](DefinitionSection.md 'DefaultDocumentation.Markdown.Sections.DefinitionSection') - -## DefinitionSection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/DefinitionSection.md b/documentation/markdown/DefinitionSection.md deleted file mode 100644 index 5328566f..00000000 --- a/documentation/markdown/DefinitionSection.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## DefinitionSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the definition of [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class DefinitionSection : -DefaultDocumentation.Api.ISection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DefinitionSection - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Fields | | -| :--- | :--- | -| [ConfigName](DefinitionSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.DefinitionSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](DefinitionSection.Name.md 'DefaultDocumentation.Markdown.Sections.DefinitionSection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](DefinitionSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.DefinitionSection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/DelegatesSection.ConfigName.md b/documentation/markdown/DelegatesSection.ConfigName.md deleted file mode 100644 index 6bd11755..00000000 --- a/documentation/markdown/DelegatesSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[DelegatesSection](DelegatesSection.md 'DefaultDocumentation.Markdown.Sections.DelegatesSection') - -## DelegatesSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Delegates; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/DelegatesSection.DelegatesSection().md b/documentation/markdown/DelegatesSection.DelegatesSection().md deleted file mode 100644 index 7b40466c..00000000 --- a/documentation/markdown/DelegatesSection.DelegatesSection().md +++ /dev/null @@ -1,10 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[DelegatesSection](DelegatesSection.md 'DefaultDocumentation.Markdown.Sections.DelegatesSection') - -## DelegatesSection() Constructor - -Initialize a new instance of the [DelegatesSection](DelegatesSection.md 'DefaultDocumentation.Markdown.Sections.DelegatesSection') type. - -```csharp -public DelegatesSection(); -``` \ No newline at end of file diff --git a/documentation/markdown/DelegatesSection.md b/documentation/markdown/DelegatesSection.md deleted file mode 100644 index 5678cbe6..00000000 --- a/documentation/markdown/DelegatesSection.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## DelegatesSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [DelegateDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DelegateDocItem.md 'DefaultDocumentation.Models.Types.DelegateDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class DelegatesSection : DefaultDocumentation.Markdown.Sections.ChildrenSection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DefaultDocumentation.Markdown.Sections.ChildrenSection<](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection')[DelegateDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DelegateDocItem.md 'DefaultDocumentation.Models.Types.DelegateDocItem')[>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') 🡒 DelegatesSection - -| Constructors | | -| :--- | :--- | -| [DelegatesSection()](DelegatesSection.DelegatesSection().md 'DefaultDocumentation.Markdown.Sections.DelegatesSection.DelegatesSection()') | Initialize a new instance of the [DelegatesSection](DelegatesSection.md 'DefaultDocumentation.Markdown.Sections.DelegatesSection') type. | - -| Fields | | -| :--- | :--- | -| [ConfigName](DelegatesSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.DelegatesSection.ConfigName') | The name of this implementation used at the configuration level. | diff --git a/documentation/markdown/DerivedSection.ConfigName.md b/documentation/markdown/DerivedSection.ConfigName.md deleted file mode 100644 index 5619dc42..00000000 --- a/documentation/markdown/DerivedSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[DerivedSection](DerivedSection.md 'DefaultDocumentation.Markdown.Sections.DerivedSection') - -## DerivedSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Derived; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/DerivedSection.Name.md b/documentation/markdown/DerivedSection.Name.md deleted file mode 100644 index 1fb974e4..00000000 --- a/documentation/markdown/DerivedSection.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[DerivedSection](DerivedSection.md 'DefaultDocumentation.Markdown.Sections.DerivedSection') - -## DerivedSection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/DerivedSection.Write(IWriter).md b/documentation/markdown/DerivedSection.Write(IWriter).md deleted file mode 100644 index df981b7b..00000000 --- a/documentation/markdown/DerivedSection.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[DerivedSection](DerivedSection.md 'DefaultDocumentation.Markdown.Sections.DerivedSection') - -## DerivedSection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/DerivedSection.md b/documentation/markdown/DerivedSection.md deleted file mode 100644 index 6338eceb..00000000 --- a/documentation/markdown/DerivedSection.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## DerivedSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the derived type of [TypeDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem'). - -```csharp -public sealed class DerivedSection : -DefaultDocumentation.Api.ISection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DerivedSection - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Fields | | -| :--- | :--- | -| [ConfigName](DerivedSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.DerivedSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](DerivedSection.Name.md 'DefaultDocumentation.Markdown.Sections.DerivedSection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](DerivedSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.DerivedSection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/DocItemExtension.GetLongName(thisDocItem).md b/documentation/markdown/DocItemExtension.GetLongName(thisDocItem).md deleted file mode 100644 index 65960b2e..00000000 --- a/documentation/markdown/DocItemExtension.GetLongName(thisDocItem).md +++ /dev/null @@ -1,22 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models').[DocItemExtension](DocItemExtension.md 'DefaultDocumentation.Models.DocItemExtension') - -## DocItemExtension.GetLongName(this DocItem) Method - -Gets the long name of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'), being its full name without its namespace. -This method should not be called on [AssemblyDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/AssemblyDocItem.md 'DefaultDocumentation.Models.AssemblyDocItem') or [NamespaceDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/NamespaceDocItem.md 'DefaultDocumentation.Models.NamespaceDocItem') types. - -```csharp -public static string GetLongName(this DefaultDocumentation.Models.DocItem item); -``` -#### Parameters - - - -`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which to get its long name. - -#### Returns -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The long name of the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). \ No newline at end of file diff --git a/documentation/markdown/DocItemExtension.md b/documentation/markdown/DocItemExtension.md deleted file mode 100644 index e794554b..00000000 --- a/documentation/markdown/DocItemExtension.md +++ /dev/null @@ -1,16 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Models](index.md#DefaultDocumentation.Models 'DefaultDocumentation.Models') - -## DocItemExtension Class - -Provides extension methods on the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') type. - -```csharp -public static class DocItemExtension -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DocItemExtension - -| Methods | | -| :--- | :--- | -| [GetLongName(this DocItem)](DocItemExtension.GetLongName(thisDocItem).md 'DefaultDocumentation.Models.DocItemExtension.GetLongName(this DefaultDocumentation.Models.DocItem)') | Gets the long name of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'), being its full name without its namespace.
This method should not be called on [AssemblyDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/AssemblyDocItem.md 'DefaultDocumentation.Models.AssemblyDocItem') or [NamespaceDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/NamespaceDocItem.md 'DefaultDocumentation.Models.NamespaceDocItem') types. | diff --git a/documentation/markdown/DocItemFactory.ConfigName.md b/documentation/markdown/DocItemFactory.ConfigName.md deleted file mode 100644 index 5edba4bf..00000000 --- a/documentation/markdown/DocItemFactory.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.UrlFactories](index.md#DefaultDocumentation.Markdown.UrlFactories 'DefaultDocumentation.Markdown.UrlFactories').[DocItemFactory](DocItemFactory.md 'DefaultDocumentation.Markdown.UrlFactories.DocItemFactory') - -## DocItemFactory.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = DocItem; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/DocItemFactory.GetUrl(IGeneralContext,string).md b/documentation/markdown/DocItemFactory.GetUrl(IGeneralContext,string).md deleted file mode 100644 index 4769b7f2..00000000 --- a/documentation/markdown/DocItemFactory.GetUrl(IGeneralContext,string).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.UrlFactories](index.md#DefaultDocumentation.Markdown.UrlFactories 'DefaultDocumentation.Markdown.UrlFactories').[DocItemFactory](DocItemFactory.md 'DefaultDocumentation.Markdown.UrlFactories.DocItemFactory') - -## DocItemFactory.GetUrl(IGeneralContext, string) Method - -Gets the url of the given id. Returns null of the instance does not know how to handle the provided id. - -```csharp -public string? GetUrl(DefaultDocumentation.IGeneralContext context, string id); -``` -#### Parameters - - - -`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - - - -`id` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The id to get the url for. - -Implements [GetUrl(IGeneralContext, string)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IUrlFactory.GetUrl(IGeneralContext,string).md 'DefaultDocumentation.Api.IUrlFactory.GetUrl(DefaultDocumentation.IGeneralContext,System.String)') - -#### Returns -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The url of the given id. \ No newline at end of file diff --git a/documentation/markdown/DocItemFactory.Name.md b/documentation/markdown/DocItemFactory.Name.md deleted file mode 100644 index 3709f20c..00000000 --- a/documentation/markdown/DocItemFactory.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.UrlFactories](index.md#DefaultDocumentation.Markdown.UrlFactories 'DefaultDocumentation.Markdown.UrlFactories').[DocItemFactory](DocItemFactory.md 'DefaultDocumentation.Markdown.UrlFactories.DocItemFactory') - -## DocItemFactory.Name Property - -Gets the name of the factory, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IUrlFactory.Name.md 'DefaultDocumentation.Api.IUrlFactory.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/DocItemFactory.md b/documentation/markdown/DocItemFactory.md deleted file mode 100644 index e254d208..00000000 --- a/documentation/markdown/DocItemFactory.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.UrlFactories](index.md#DefaultDocumentation.Markdown.UrlFactories 'DefaultDocumentation.Markdown.UrlFactories') - -## DocItemFactory Class - -Handles id for known [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class DocItemFactory : -DefaultDocumentation.Api.IUrlFactory -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DocItemFactory - -Implements [IUrlFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IUrlFactory.md 'DefaultDocumentation.Api.IUrlFactory') - -| Fields | | -| :--- | :--- | -| [ConfigName](DocItemFactory.ConfigName.md 'DefaultDocumentation.Markdown.UrlFactories.DocItemFactory.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](DocItemFactory.Name.md 'DefaultDocumentation.Markdown.UrlFactories.DocItemFactory.Name') | Gets the name of the factory, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [GetUrl(IGeneralContext, string)](DocItemFactory.GetUrl(IGeneralContext,string).md 'DefaultDocumentation.Markdown.UrlFactories.DocItemFactory.GetUrl(DefaultDocumentation.IGeneralContext, string)') | Gets the url of the given id. Returns null of the instance does not know how to handle the provided id. | diff --git a/documentation/markdown/DotnetApiFactory.ConfigName.md b/documentation/markdown/DotnetApiFactory.ConfigName.md deleted file mode 100644 index 1c342f5e..00000000 --- a/documentation/markdown/DotnetApiFactory.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.UrlFactories](index.md#DefaultDocumentation.Markdown.UrlFactories 'DefaultDocumentation.Markdown.UrlFactories').[DotnetApiFactory](DotnetApiFactory.md 'DefaultDocumentation.Markdown.UrlFactories.DotnetApiFactory') - -## DotnetApiFactory.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = DotnetApi; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/DotnetApiFactory.GetUrl(IGeneralContext,string).md b/documentation/markdown/DotnetApiFactory.GetUrl(IGeneralContext,string).md deleted file mode 100644 index f54443e3..00000000 --- a/documentation/markdown/DotnetApiFactory.GetUrl(IGeneralContext,string).md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.UrlFactories](index.md#DefaultDocumentation.Markdown.UrlFactories 'DefaultDocumentation.Markdown.UrlFactories').[DotnetApiFactory](DotnetApiFactory.md 'DefaultDocumentation.Markdown.UrlFactories.DotnetApiFactory') - -## DotnetApiFactory.GetUrl(IGeneralContext, string) Method - -Gets the url of the given id. Returns null of the instance does not know how to handle the provided id. - -```csharp -public string GetUrl(DefaultDocumentation.IGeneralContext context, string id); -``` -#### Parameters - - - -`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - - - -`id` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The id to get the url for. - -Implements [GetUrl(IGeneralContext, string)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IUrlFactory.GetUrl(IGeneralContext,string).md 'DefaultDocumentation.Api.IUrlFactory.GetUrl(DefaultDocumentation.IGeneralContext,System.String)') - -#### Returns -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The url of the given id. \ No newline at end of file diff --git a/documentation/markdown/DotnetApiFactory.Name.md b/documentation/markdown/DotnetApiFactory.Name.md deleted file mode 100644 index b152e8bf..00000000 --- a/documentation/markdown/DotnetApiFactory.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.UrlFactories](index.md#DefaultDocumentation.Markdown.UrlFactories 'DefaultDocumentation.Markdown.UrlFactories').[DotnetApiFactory](DotnetApiFactory.md 'DefaultDocumentation.Markdown.UrlFactories.DotnetApiFactory') - -## DotnetApiFactory.Name Property - -Gets the name of the factory, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IUrlFactory.Name.md 'DefaultDocumentation.Api.IUrlFactory.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/DotnetApiFactory.md b/documentation/markdown/DotnetApiFactory.md deleted file mode 100644 index 255e0b7e..00000000 --- a/documentation/markdown/DotnetApiFactory.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.UrlFactories](index.md#DefaultDocumentation.Markdown.UrlFactories 'DefaultDocumentation.Markdown.UrlFactories') - -## DotnetApiFactory Class - -Transforms any id as a dotnet api url. - -```csharp -public sealed class DotnetApiFactory : -DefaultDocumentation.Api.IUrlFactory -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 DotnetApiFactory - -Implements [IUrlFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IUrlFactory.md 'DefaultDocumentation.Api.IUrlFactory') - -| Fields | | -| :--- | :--- | -| [ConfigName](DotnetApiFactory.ConfigName.md 'DefaultDocumentation.Markdown.UrlFactories.DotnetApiFactory.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](DotnetApiFactory.Name.md 'DefaultDocumentation.Markdown.UrlFactories.DotnetApiFactory.Name') | Gets the name of the factory, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [GetUrl(IGeneralContext, string)](DotnetApiFactory.GetUrl(IGeneralContext,string).md 'DefaultDocumentation.Markdown.UrlFactories.DotnetApiFactory.GetUrl(DefaultDocumentation.IGeneralContext, string)') | Gets the url of the given id. Returns null of the instance does not know how to handle the provided id. | diff --git a/documentation/markdown/EnumFieldsSection.ConfigName.md b/documentation/markdown/EnumFieldsSection.ConfigName.md deleted file mode 100644 index 3885d25a..00000000 --- a/documentation/markdown/EnumFieldsSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[EnumFieldsSection](EnumFieldsSection.md 'DefaultDocumentation.Markdown.Sections.EnumFieldsSection') - -## EnumFieldsSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = EnumFields; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/EnumFieldsSection.EnumFieldsSection().md b/documentation/markdown/EnumFieldsSection.EnumFieldsSection().md deleted file mode 100644 index 54bf407c..00000000 --- a/documentation/markdown/EnumFieldsSection.EnumFieldsSection().md +++ /dev/null @@ -1,10 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[EnumFieldsSection](EnumFieldsSection.md 'DefaultDocumentation.Markdown.Sections.EnumFieldsSection') - -## EnumFieldsSection() Constructor - -Initialize a new instance of the [EnumFieldsSection](EnumFieldsSection.md 'DefaultDocumentation.Markdown.Sections.EnumFieldsSection') type. - -```csharp -public EnumFieldsSection(); -``` \ No newline at end of file diff --git a/documentation/markdown/EnumFieldsSection.md b/documentation/markdown/EnumFieldsSection.md deleted file mode 100644 index 9f072477..00000000 --- a/documentation/markdown/EnumFieldsSection.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## EnumFieldsSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [EnumFieldDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/EnumFieldDocItem.md 'DefaultDocumentation.Models.Members.EnumFieldDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class EnumFieldsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DefaultDocumentation.Markdown.Sections.ChildrenSection<](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection')[EnumFieldDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/EnumFieldDocItem.md 'DefaultDocumentation.Models.Members.EnumFieldDocItem')[>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') 🡒 EnumFieldsSection - -| Constructors | | -| :--- | :--- | -| [EnumFieldsSection()](EnumFieldsSection.EnumFieldsSection().md 'DefaultDocumentation.Markdown.Sections.EnumFieldsSection.EnumFieldsSection()') | Initialize a new instance of the [EnumFieldsSection](EnumFieldsSection.md 'DefaultDocumentation.Markdown.Sections.EnumFieldsSection') type. | - -| Fields | | -| :--- | :--- | -| [ConfigName](EnumFieldsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.EnumFieldsSection.ConfigName') | The name of this implementation used at the configuration level. | diff --git a/documentation/markdown/EnumsSection.ConfigName.md b/documentation/markdown/EnumsSection.ConfigName.md deleted file mode 100644 index 948e0d9b..00000000 --- a/documentation/markdown/EnumsSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[EnumsSection](EnumsSection.md 'DefaultDocumentation.Markdown.Sections.EnumsSection') - -## EnumsSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Enums; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/EnumsSection.EnumsSection().md b/documentation/markdown/EnumsSection.EnumsSection().md deleted file mode 100644 index fb53ed5a..00000000 --- a/documentation/markdown/EnumsSection.EnumsSection().md +++ /dev/null @@ -1,10 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[EnumsSection](EnumsSection.md 'DefaultDocumentation.Markdown.Sections.EnumsSection') - -## EnumsSection() Constructor - -Initialize a new instance of the [EnumsSection](EnumsSection.md 'DefaultDocumentation.Markdown.Sections.EnumsSection') type. - -```csharp -public EnumsSection(); -``` \ No newline at end of file diff --git a/documentation/markdown/EnumsSection.md b/documentation/markdown/EnumsSection.md deleted file mode 100644 index 5eaaf75d..00000000 --- a/documentation/markdown/EnumsSection.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## EnumsSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [EnumDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/EnumDocItem.md 'DefaultDocumentation.Models.Types.EnumDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class EnumsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DefaultDocumentation.Markdown.Sections.ChildrenSection<](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection')[EnumDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/EnumDocItem.md 'DefaultDocumentation.Models.Types.EnumDocItem')[>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') 🡒 EnumsSection - -| Constructors | | -| :--- | :--- | -| [EnumsSection()](EnumsSection.EnumsSection().md 'DefaultDocumentation.Markdown.Sections.EnumsSection.EnumsSection()') | Initialize a new instance of the [EnumsSection](EnumsSection.md 'DefaultDocumentation.Markdown.Sections.EnumsSection') type. | - -| Fields | | -| :--- | :--- | -| [ConfigName](EnumsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.EnumsSection.ConfigName') | The name of this implementation used at the configuration level. | diff --git a/documentation/markdown/EventTypeSection.ConfigName.md b/documentation/markdown/EventTypeSection.ConfigName.md deleted file mode 100644 index 4c336fa5..00000000 --- a/documentation/markdown/EventTypeSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[EventTypeSection](EventTypeSection.md 'DefaultDocumentation.Markdown.Sections.EventTypeSection') - -## EventTypeSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = EventType; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/EventTypeSection.Name.md b/documentation/markdown/EventTypeSection.Name.md deleted file mode 100644 index 5a2c78e8..00000000 --- a/documentation/markdown/EventTypeSection.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[EventTypeSection](EventTypeSection.md 'DefaultDocumentation.Markdown.Sections.EventTypeSection') - -## EventTypeSection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/EventTypeSection.Write(IWriter).md b/documentation/markdown/EventTypeSection.Write(IWriter).md deleted file mode 100644 index cfabb2fa..00000000 --- a/documentation/markdown/EventTypeSection.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[EventTypeSection](EventTypeSection.md 'DefaultDocumentation.Markdown.Sections.EventTypeSection') - -## EventTypeSection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/EventTypeSection.md b/documentation/markdown/EventTypeSection.md deleted file mode 100644 index e3c159e3..00000000 --- a/documentation/markdown/EventTypeSection.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## EventTypeSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the event type of [EventDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/EventDocItem.md 'DefaultDocumentation.Models.Members.EventDocItem'). - -```csharp -public sealed class EventTypeSection : -DefaultDocumentation.Api.ISection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 EventTypeSection - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Fields | | -| :--- | :--- | -| [ConfigName](EventTypeSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.EventTypeSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](EventTypeSection.Name.md 'DefaultDocumentation.Markdown.Sections.EventTypeSection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](EventTypeSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.EventTypeSection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/EventsSection.ConfigName.md b/documentation/markdown/EventsSection.ConfigName.md deleted file mode 100644 index 7e136841..00000000 --- a/documentation/markdown/EventsSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[EventsSection](EventsSection.md 'DefaultDocumentation.Markdown.Sections.EventsSection') - -## EventsSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Events; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/EventsSection.EventsSection().md b/documentation/markdown/EventsSection.EventsSection().md deleted file mode 100644 index 0bca6a4d..00000000 --- a/documentation/markdown/EventsSection.EventsSection().md +++ /dev/null @@ -1,10 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[EventsSection](EventsSection.md 'DefaultDocumentation.Markdown.Sections.EventsSection') - -## EventsSection() Constructor - -Initialize a new instance of the [EventsSection](EventsSection.md 'DefaultDocumentation.Markdown.Sections.EventsSection') type. - -```csharp -public EventsSection(); -``` \ No newline at end of file diff --git a/documentation/markdown/EventsSection.md b/documentation/markdown/EventsSection.md deleted file mode 100644 index 80666fa0..00000000 --- a/documentation/markdown/EventsSection.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## EventsSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [EventDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/EventDocItem.md 'DefaultDocumentation.Models.Members.EventDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class EventsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DefaultDocumentation.Markdown.Sections.ChildrenSection<](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection')[EventDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/EventDocItem.md 'DefaultDocumentation.Models.Members.EventDocItem')[>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') 🡒 EventsSection - -| Constructors | | -| :--- | :--- | -| [EventsSection()](EventsSection.EventsSection().md 'DefaultDocumentation.Markdown.Sections.EventsSection.EventsSection()') | Initialize a new instance of the [EventsSection](EventsSection.md 'DefaultDocumentation.Markdown.Sections.EventsSection') type. | - -| Fields | | -| :--- | :--- | -| [ConfigName](EventsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.EventsSection.ConfigName') | The name of this implementation used at the configuration level. | diff --git a/documentation/markdown/ExampleSection.ConfigName.md b/documentation/markdown/ExampleSection.ConfigName.md deleted file mode 100644 index 06fe12dc..00000000 --- a/documentation/markdown/ExampleSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ExampleSection](ExampleSection.md 'DefaultDocumentation.Markdown.Sections.ExampleSection') - -## ExampleSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = example; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/ExampleSection.Name.md b/documentation/markdown/ExampleSection.Name.md deleted file mode 100644 index da45d9c8..00000000 --- a/documentation/markdown/ExampleSection.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ExampleSection](ExampleSection.md 'DefaultDocumentation.Markdown.Sections.ExampleSection') - -## ExampleSection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/ExampleSection.Write(IWriter).md b/documentation/markdown/ExampleSection.Write(IWriter).md deleted file mode 100644 index c5234dfa..00000000 --- a/documentation/markdown/ExampleSection.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ExampleSection](ExampleSection.md 'DefaultDocumentation.Markdown.Sections.ExampleSection') - -## ExampleSection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/ExampleSection.md b/documentation/markdown/ExampleSection.md deleted file mode 100644 index fbdc6a76..00000000 --- a/documentation/markdown/ExampleSection.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## ExampleSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the `example` top level element. - -```csharp -public sealed class ExampleSection : -DefaultDocumentation.Api.ISection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ExampleSection - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Fields | | -| :--- | :--- | -| [ConfigName](ExampleSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.ExampleSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](ExampleSection.Name.md 'DefaultDocumentation.Markdown.Sections.ExampleSection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](ExampleSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.ExampleSection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/ExceptionSection.ConfigName.md b/documentation/markdown/ExceptionSection.ConfigName.md deleted file mode 100644 index 9205c4b0..00000000 --- a/documentation/markdown/ExceptionSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ExceptionSection](ExceptionSection.md 'DefaultDocumentation.Markdown.Sections.ExceptionSection') - -## ExceptionSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = exception; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/ExceptionSection.Name.md b/documentation/markdown/ExceptionSection.Name.md deleted file mode 100644 index c34c65f3..00000000 --- a/documentation/markdown/ExceptionSection.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ExceptionSection](ExceptionSection.md 'DefaultDocumentation.Markdown.Sections.ExceptionSection') - -## ExceptionSection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/ExceptionSection.Write(IWriter).md b/documentation/markdown/ExceptionSection.Write(IWriter).md deleted file mode 100644 index 65c9d68b..00000000 --- a/documentation/markdown/ExceptionSection.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ExceptionSection](ExceptionSection.md 'DefaultDocumentation.Markdown.Sections.ExceptionSection') - -## ExceptionSection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/ExceptionSection.md b/documentation/markdown/ExceptionSection.md deleted file mode 100644 index 6b11b562..00000000 --- a/documentation/markdown/ExceptionSection.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## ExceptionSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the `exception` top level elements. - -```csharp -public sealed class ExceptionSection : -DefaultDocumentation.Api.ISection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ExceptionSection - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Fields | | -| :--- | :--- | -| [ConfigName](ExceptionSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.ExceptionSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](ExceptionSection.Name.md 'DefaultDocumentation.Markdown.Sections.ExceptionSection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](ExceptionSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.ExceptionSection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/ExplicitInterfaceImplementationsSection.ConfigName.md b/documentation/markdown/ExplicitInterfaceImplementationsSection.ConfigName.md deleted file mode 100644 index ae130971..00000000 --- a/documentation/markdown/ExplicitInterfaceImplementationsSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ExplicitInterfaceImplementationsSection](ExplicitInterfaceImplementationsSection.md 'DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection') - -## ExplicitInterfaceImplementationsSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Explicitinterfaceimplementations; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/ExplicitInterfaceImplementationsSection.ExplicitInterfaceImplementationsSection().md b/documentation/markdown/ExplicitInterfaceImplementationsSection.ExplicitInterfaceImplementationsSection().md deleted file mode 100644 index b855a136..00000000 --- a/documentation/markdown/ExplicitInterfaceImplementationsSection.ExplicitInterfaceImplementationsSection().md +++ /dev/null @@ -1,10 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ExplicitInterfaceImplementationsSection](ExplicitInterfaceImplementationsSection.md 'DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection') - -## ExplicitInterfaceImplementationsSection() Constructor - -Initialize a new instance of the [ExplicitInterfaceImplementationsSection](ExplicitInterfaceImplementationsSection.md 'DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection') type. - -```csharp -public ExplicitInterfaceImplementationsSection(); -``` \ No newline at end of file diff --git a/documentation/markdown/ExplicitInterfaceImplementationsSection.md b/documentation/markdown/ExplicitInterfaceImplementationsSection.md deleted file mode 100644 index 8586af18..00000000 --- a/documentation/markdown/ExplicitInterfaceImplementationsSection.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## ExplicitInterfaceImplementationsSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [ExplicitInterfaceImplementationDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class ExplicitInterfaceImplementationsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DefaultDocumentation.Markdown.Sections.ChildrenSection<](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection')[ExplicitInterfaceImplementationDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem')[>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') 🡒 ExplicitInterfaceImplementationsSection - -| Constructors | | -| :--- | :--- | -| [ExplicitInterfaceImplementationsSection()](ExplicitInterfaceImplementationsSection.ExplicitInterfaceImplementationsSection().md 'DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection.ExplicitInterfaceImplementationsSection()') | Initialize a new instance of the [ExplicitInterfaceImplementationsSection](ExplicitInterfaceImplementationsSection.md 'DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection') type. | - -| Fields | | -| :--- | :--- | -| [ConfigName](ExplicitInterfaceImplementationsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection.ConfigName') | The name of this implementation used at the configuration level. | diff --git a/documentation/markdown/FieldValueSection.ConfigName.md b/documentation/markdown/FieldValueSection.ConfigName.md deleted file mode 100644 index b335b6e9..00000000 --- a/documentation/markdown/FieldValueSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[FieldValueSection](FieldValueSection.md 'DefaultDocumentation.Markdown.Sections.FieldValueSection') - -## FieldValueSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = FieldValue; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/FieldValueSection.Name.md b/documentation/markdown/FieldValueSection.Name.md deleted file mode 100644 index 3812da0e..00000000 --- a/documentation/markdown/FieldValueSection.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[FieldValueSection](FieldValueSection.md 'DefaultDocumentation.Markdown.Sections.FieldValueSection') - -## FieldValueSection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/FieldValueSection.Write(IWriter).md b/documentation/markdown/FieldValueSection.Write(IWriter).md deleted file mode 100644 index 974ea979..00000000 --- a/documentation/markdown/FieldValueSection.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[FieldValueSection](FieldValueSection.md 'DefaultDocumentation.Markdown.Sections.FieldValueSection') - -## FieldValueSection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/FieldValueSection.md b/documentation/markdown/FieldValueSection.md deleted file mode 100644 index 80fd9e12..00000000 --- a/documentation/markdown/FieldValueSection.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## FieldValueSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the field type of [FieldDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/FieldDocItem.md 'DefaultDocumentation.Models.Members.FieldDocItem'). - -```csharp -public sealed class FieldValueSection : -DefaultDocumentation.Api.ISection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 FieldValueSection - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Fields | | -| :--- | :--- | -| [ConfigName](FieldValueSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.FieldValueSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](FieldValueSection.Name.md 'DefaultDocumentation.Markdown.Sections.FieldValueSection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](FieldValueSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.FieldValueSection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/FieldsSection.ConfigName.md b/documentation/markdown/FieldsSection.ConfigName.md deleted file mode 100644 index 986601b3..00000000 --- a/documentation/markdown/FieldsSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[FieldsSection](FieldsSection.md 'DefaultDocumentation.Markdown.Sections.FieldsSection') - -## FieldsSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Fields; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/FieldsSection.FieldsSection().md b/documentation/markdown/FieldsSection.FieldsSection().md deleted file mode 100644 index a3dfc793..00000000 --- a/documentation/markdown/FieldsSection.FieldsSection().md +++ /dev/null @@ -1,10 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[FieldsSection](FieldsSection.md 'DefaultDocumentation.Markdown.Sections.FieldsSection') - -## FieldsSection() Constructor - -Initialize a new instance of the [FieldsSection](FieldsSection.md 'DefaultDocumentation.Markdown.Sections.FieldsSection') type. - -```csharp -public FieldsSection(); -``` \ No newline at end of file diff --git a/documentation/markdown/FieldsSection.md b/documentation/markdown/FieldsSection.md deleted file mode 100644 index a060633d..00000000 --- a/documentation/markdown/FieldsSection.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## FieldsSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [FieldDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/FieldDocItem.md 'DefaultDocumentation.Models.Members.FieldDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class FieldsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DefaultDocumentation.Markdown.Sections.ChildrenSection<](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection')[FieldDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/FieldDocItem.md 'DefaultDocumentation.Models.Members.FieldDocItem')[>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') 🡒 FieldsSection - -| Constructors | | -| :--- | :--- | -| [FieldsSection()](FieldsSection.FieldsSection().md 'DefaultDocumentation.Markdown.Sections.FieldsSection.FieldsSection()') | Initialize a new instance of the [FieldsSection](FieldsSection.md 'DefaultDocumentation.Markdown.Sections.FieldsSection') type. | - -| Fields | | -| :--- | :--- | -| [ConfigName](FieldsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.FieldsSection.ConfigName') | The name of this implementation used at the configuration level. | diff --git a/documentation/markdown/FooterSection.ConfigName.md b/documentation/markdown/FooterSection.ConfigName.md deleted file mode 100644 index e01c6cd4..00000000 --- a/documentation/markdown/FooterSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[FooterSection](FooterSection.md 'DefaultDocumentation.Markdown.Sections.FooterSection') - -## FooterSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Footer; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/FooterSection.Name.md b/documentation/markdown/FooterSection.Name.md deleted file mode 100644 index 84939ba0..00000000 --- a/documentation/markdown/FooterSection.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[FooterSection](FooterSection.md 'DefaultDocumentation.Markdown.Sections.FooterSection') - -## FooterSection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/FooterSection.Write(IWriter).md b/documentation/markdown/FooterSection.Write(IWriter).md deleted file mode 100644 index 03ceaab3..00000000 --- a/documentation/markdown/FooterSection.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[FooterSection](FooterSection.md 'DefaultDocumentation.Markdown.Sections.FooterSection') - -## FooterSection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/FooterSection.md b/documentation/markdown/FooterSection.md deleted file mode 100644 index 49fd36e8..00000000 --- a/documentation/markdown/FooterSection.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## FooterSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write a link to [DefaultDocumentation](https://github.com/Doraku/DefaultDocumentation 'https://github.com/Doraku/DefaultDocumentation'). - -```csharp -public sealed class FooterSection : -DefaultDocumentation.Api.ISection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 FooterSection - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Fields | | -| :--- | :--- | -| [ConfigName](FooterSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.FooterSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](FooterSection.Name.md 'DefaultDocumentation.Markdown.Sections.FooterSection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](FooterSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.FooterSection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/FullNameFactory.ConfigName.md b/documentation/markdown/FullNameFactory.ConfigName.md deleted file mode 100644 index a28d2185..00000000 --- a/documentation/markdown/FullNameFactory.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[FullNameFactory](FullNameFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory') - -## FullNameFactory.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = FullName; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/FullNameFactory.GetMarkdownFileName(IGeneralContext,DocItem).md b/documentation/markdown/FullNameFactory.GetMarkdownFileName(IGeneralContext,DocItem).md deleted file mode 100644 index 532b853d..00000000 --- a/documentation/markdown/FullNameFactory.GetMarkdownFileName(IGeneralContext,DocItem).md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[FullNameFactory](FullNameFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory') - -## FullNameFactory.GetMarkdownFileName(IGeneralContext, DocItem) Method - -Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -protected override string GetMarkdownFileName(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); -``` -#### Parameters - - - -`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - - - -`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which to get the documentation file name. - -#### Returns -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The file name to use. \ No newline at end of file diff --git a/documentation/markdown/FullNameFactory.Name.md b/documentation/markdown/FullNameFactory.Name.md deleted file mode 100644 index 81b19639..00000000 --- a/documentation/markdown/FullNameFactory.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[FullNameFactory](FullNameFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory') - -## FullNameFactory.Name Property - -Gets the name of the factory, used to identify it at the configuration level. - -```csharp -public override string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.Name.md 'DefaultDocumentation.Api.IFileNameFactory.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/FullNameFactory.md b/documentation/markdown/FullNameFactory.md deleted file mode 100644 index a426c0a0..00000000 --- a/documentation/markdown/FullNameFactory.md +++ /dev/null @@ -1,24 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories') - -## FullNameFactory Class - -[IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') implementation using [FullName](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.FullName.md 'DefaultDocumentation.Models.DocItem.FullName') as file name. - -```csharp -public sealed class FullNameFactory : DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [AMarkdownFactory](AMarkdownFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory') 🡒 FullNameFactory - -| Fields | | -| :--- | :--- | -| [ConfigName](FullNameFactory.ConfigName.md 'DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](FullNameFactory.Name.md 'DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory.Name') | Gets the name of the factory, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [GetMarkdownFileName(IGeneralContext, DocItem)](FullNameFactory.GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)') | Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). | diff --git a/documentation/markdown/HeaderSection.ConfigName.md b/documentation/markdown/HeaderSection.ConfigName.md deleted file mode 100644 index 26074baa..00000000 --- a/documentation/markdown/HeaderSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[HeaderSection](HeaderSection.md 'DefaultDocumentation.Markdown.Sections.HeaderSection') - -## HeaderSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Header; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/HeaderSection.Name.md b/documentation/markdown/HeaderSection.Name.md deleted file mode 100644 index 61ddd257..00000000 --- a/documentation/markdown/HeaderSection.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[HeaderSection](HeaderSection.md 'DefaultDocumentation.Markdown.Sections.HeaderSection') - -## HeaderSection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/HeaderSection.Write(IWriter).md b/documentation/markdown/HeaderSection.Write(IWriter).md deleted file mode 100644 index f3d0fa24..00000000 --- a/documentation/markdown/HeaderSection.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[HeaderSection](HeaderSection.md 'DefaultDocumentation.Markdown.Sections.HeaderSection') - -## HeaderSection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/HeaderSection.md b/documentation/markdown/HeaderSection.md deleted file mode 100644 index 958674d7..00000000 --- a/documentation/markdown/HeaderSection.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## HeaderSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write a link to the top level documentation page. - -```csharp -public sealed class HeaderSection : -DefaultDocumentation.Api.ISection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 HeaderSection - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Fields | | -| :--- | :--- | -| [ConfigName](HeaderSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.HeaderSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](HeaderSection.Name.md 'DefaultDocumentation.Markdown.Sections.HeaderSection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](HeaderSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.HeaderSection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/IGeneralContextExtension.GetChildren_T_(thisIGeneralContext,DocItem).md b/documentation/markdown/IGeneralContextExtension.GetChildren_T_(thisIGeneralContext,DocItem).md deleted file mode 100644 index 39dfa981..00000000 --- a/documentation/markdown/IGeneralContextExtension.GetChildren_T_(thisIGeneralContext,DocItem).md +++ /dev/null @@ -1,35 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContextExtension](IGeneralContextExtension.md 'DefaultDocumentation.IGeneralContextExtension') - -## IGeneralContextExtension.GetChildren(this IGeneralContext, DocItem) Method - -Gets the children of a specific [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') type of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') instance. - -```csharp -public static System.Collections.Generic.IEnumerable GetChildren(this DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item) - where T : DefaultDocumentation.Models.DocItem; -``` -#### Type parameters - - - -`T` - -The type of the children to look for. -#### Parameters - - - -`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation file. - - - -`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') instance for which to get its children. - -#### Returns -[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[T](IGeneralContextExtension.GetChildren_T_(thisIGeneralContext,DocItem).md#DefaultDocumentation.IGeneralContextExtension.GetChildren_T_(thisDefaultDocumentation.IGeneralContext,DefaultDocumentation.Models.DocItem).T 'DefaultDocumentation.IGeneralContextExtension.GetChildren(this DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem).T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') -The children of the provided [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). \ No newline at end of file diff --git a/documentation/markdown/IGeneralContextExtension.GetInvalidCharReplacement(thisIGeneralContext).md b/documentation/markdown/IGeneralContextExtension.GetInvalidCharReplacement(thisIGeneralContext).md deleted file mode 100644 index 608dee8f..00000000 --- a/documentation/markdown/IGeneralContextExtension.GetInvalidCharReplacement(thisIGeneralContext).md +++ /dev/null @@ -1,21 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContextExtension](IGeneralContextExtension.md 'DefaultDocumentation.IGeneralContextExtension') - -## IGeneralContextExtension.GetInvalidCharReplacement(this IGeneralContext) Method - -Gets the [Markdown.InvalidCharReplacement](https://github.com/Doraku/DefaultDocumentation#invalidcharreplacement 'https://github.com/Doraku/DefaultDocumentation#invalidcharreplacement') setting. - -```csharp -public static string? GetInvalidCharReplacement(this DefaultDocumentation.IGeneralContext context); -``` -#### Parameters - - - -`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation file. - -#### Returns -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') to use to replace invalid chars in generated file name. \ No newline at end of file diff --git a/documentation/markdown/IGeneralContextExtension.GetNestedTypeVisibilities(thisIGeneralContext,Type).md b/documentation/markdown/IGeneralContextExtension.GetNestedTypeVisibilities(thisIGeneralContext,Type).md deleted file mode 100644 index 269c543f..00000000 --- a/documentation/markdown/IGeneralContextExtension.GetNestedTypeVisibilities(thisIGeneralContext,Type).md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContextExtension](IGeneralContextExtension.md 'DefaultDocumentation.IGeneralContextExtension') - -## IGeneralContextExtension.GetNestedTypeVisibilities(this IGeneralContext, Type) Method - -Gets the [Markdown.NestedTypeVisibilities](https://github.com/Doraku/DefaultDocumentation#nestedtypevisibilities 'https://github.com/Doraku/DefaultDocumentation#nestedtypevisibilities') setting. - -```csharp -public static DefaultDocumentation.NestedTypeVisibilities GetNestedTypeVisibilities(this DefaultDocumentation.IGeneralContext context, System.Type type); -``` -#### Parameters - - - -`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation file. - - - -`type` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type') - -The [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type') for which to get the setting. - -#### Returns -[NestedTypeVisibilities](NestedTypeVisibilities.md 'DefaultDocumentation.NestedTypeVisibilities') -The [NestedTypeVisibilities](NestedTypeVisibilities.md 'DefaultDocumentation.NestedTypeVisibilities') to use. \ No newline at end of file diff --git a/documentation/markdown/IGeneralContextExtension.GetRemoveFileExtensionFromUrl(thisIGeneralContext).md b/documentation/markdown/IGeneralContextExtension.GetRemoveFileExtensionFromUrl(thisIGeneralContext).md deleted file mode 100644 index 6263551d..00000000 --- a/documentation/markdown/IGeneralContextExtension.GetRemoveFileExtensionFromUrl(thisIGeneralContext).md +++ /dev/null @@ -1,21 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation').[IGeneralContextExtension](IGeneralContextExtension.md 'DefaultDocumentation.IGeneralContextExtension') - -## IGeneralContextExtension.GetRemoveFileExtensionFromUrl(this IGeneralContext) Method - -Gets the [Markdown.RemoveFileExtensionFromUrl](https://github.com/Doraku/DefaultDocumentation#removefileextensionfromurl 'https://github.com/Doraku/DefaultDocumentation#removefileextensionfromurl') setting. - -```csharp -public static bool GetRemoveFileExtensionFromUrl(this DefaultDocumentation.IGeneralContext context); -``` -#### Parameters - - - -`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation file. - -#### Returns -[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') -Whether to include the file extension in urls. \ No newline at end of file diff --git a/documentation/markdown/IGeneralContextExtension.md b/documentation/markdown/IGeneralContextExtension.md deleted file mode 100644 index b60542e8..00000000 --- a/documentation/markdown/IGeneralContextExtension.md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation') - -## IGeneralContextExtension Class - -Provides extension methods on the [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') type. - -```csharp -public static class IGeneralContextExtension -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 IGeneralContextExtension - -| Methods | | -| :--- | :--- | -| [GetChildren<T>(this IGeneralContext, DocItem)](IGeneralContextExtension.GetChildren_T_(thisIGeneralContext,DocItem).md 'DefaultDocumentation.IGeneralContextExtension.GetChildren(this DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)') | Gets the children of a specific [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') type of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') instance. | -| [GetInvalidCharReplacement(this IGeneralContext)](IGeneralContextExtension.GetInvalidCharReplacement(thisIGeneralContext).md 'DefaultDocumentation.IGeneralContextExtension.GetInvalidCharReplacement(this DefaultDocumentation.IGeneralContext)') | Gets the [Markdown.InvalidCharReplacement](https://github.com/Doraku/DefaultDocumentation#invalidcharreplacement 'https://github.com/Doraku/DefaultDocumentation#invalidcharreplacement') setting. | -| [GetNestedTypeVisibilities(this IGeneralContext, Type)](IGeneralContextExtension.GetNestedTypeVisibilities(thisIGeneralContext,Type).md 'DefaultDocumentation.IGeneralContextExtension.GetNestedTypeVisibilities(this DefaultDocumentation.IGeneralContext, System.Type)') | Gets the [Markdown.NestedTypeVisibilities](https://github.com/Doraku/DefaultDocumentation#nestedtypevisibilities 'https://github.com/Doraku/DefaultDocumentation#nestedtypevisibilities') setting. | -| [GetRemoveFileExtensionFromUrl(this IGeneralContext)](IGeneralContextExtension.GetRemoveFileExtensionFromUrl(thisIGeneralContext).md 'DefaultDocumentation.IGeneralContextExtension.GetRemoveFileExtensionFromUrl(this DefaultDocumentation.IGeneralContext)') | Gets the [Markdown.RemoveFileExtensionFromUrl](https://github.com/Doraku/DefaultDocumentation#removefileextensionfromurl 'https://github.com/Doraku/DefaultDocumentation#removefileextensionfromurl') setting. | diff --git a/documentation/markdown/IWriterExtension.AppendAsMarkdown(thisIWriter,XElement).md b/documentation/markdown/IWriterExtension.AppendAsMarkdown(thisIWriter,XElement).md deleted file mode 100644 index 23ce6573..00000000 --- a/documentation/markdown/IWriterExtension.AppendAsMarkdown(thisIWriter,XElement).md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Extensions](index.md#DefaultDocumentation.Markdown.Extensions 'DefaultDocumentation.Markdown.Extensions').[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension') - -## IWriterExtension.AppendAsMarkdown(this IWriter, XElement) Method - -Appends a [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') decorating the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') with a [MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter'). - -```csharp -public static DefaultDocumentation.Api.IWriter AppendAsMarkdown(this DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement? element); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to use. - - - -`element` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') to write. - -#### Returns -[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') -The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/markdown/IWriterExtension.AppendLink(thisIWriter,DocItem,INamedElement).md b/documentation/markdown/IWriterExtension.AppendLink(thisIWriter,DocItem,INamedElement).md deleted file mode 100644 index ac21984a..00000000 --- a/documentation/markdown/IWriterExtension.AppendLink(thisIWriter,DocItem,INamedElement).md +++ /dev/null @@ -1,33 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Extensions](index.md#DefaultDocumentation.Markdown.Extensions 'DefaultDocumentation.Markdown.Extensions').[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension') - -## IWriterExtension.AppendLink(this IWriter, DocItem, INamedElement) Method - -Append an link to an [ICSharpCode.Decompiler.TypeSystem.INamedElement](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.TypeSystem.INamedElement 'ICSharpCode.Decompiler.TypeSystem.INamedElement') in the markdown format. - -```csharp -public static DefaultDocumentation.Api.IWriter AppendLink(this DefaultDocumentation.Api.IWriter writer, DefaultDocumentation.Models.DocItem item, INamedElement element); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to use. - - - -`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') parent of the element, to get generic information if needed. - - - -`element` [ICSharpCode.Decompiler.TypeSystem.INamedElement](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.TypeSystem.INamedElement 'ICSharpCode.Decompiler.TypeSystem.INamedElement') - -The [ICSharpCode.Decompiler.TypeSystem.INamedElement](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.TypeSystem.INamedElement 'ICSharpCode.Decompiler.TypeSystem.INamedElement') to link to. - -#### Returns -[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') -The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/markdown/IWriterExtension.AppendLink(thisIWriter,DocItem,string).md b/documentation/markdown/IWriterExtension.AppendLink(thisIWriter,DocItem,string).md deleted file mode 100644 index b01b7dcb..00000000 --- a/documentation/markdown/IWriterExtension.AppendLink(thisIWriter,DocItem,string).md +++ /dev/null @@ -1,33 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Extensions](index.md#DefaultDocumentation.Markdown.Extensions 'DefaultDocumentation.Markdown.Extensions').[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension') - -## IWriterExtension.AppendLink(this IWriter, DocItem, string) Method - -Append an link to a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') in the markdown format. - -```csharp -public static DefaultDocumentation.Api.IWriter AppendLink(this DefaultDocumentation.Api.IWriter writer, DefaultDocumentation.Models.DocItem item, string? displayedName=null); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to use. - - - -`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') to link to. - - - -`displayedName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The displayed name of the link. - -#### Returns -[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') -The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/markdown/IWriterExtension.AppendLink(thisIWriter,string,string).md b/documentation/markdown/IWriterExtension.AppendLink(thisIWriter,string,string).md deleted file mode 100644 index ca929632..00000000 --- a/documentation/markdown/IWriterExtension.AppendLink(thisIWriter,string,string).md +++ /dev/null @@ -1,33 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Extensions](index.md#DefaultDocumentation.Markdown.Extensions 'DefaultDocumentation.Markdown.Extensions').[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension') - -## IWriterExtension.AppendLink(this IWriter, string, string) Method - -Append an link to an id using [GetUrl(string)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.GetUrl(string).md 'DefaultDocumentation.IGeneralContext.GetUrl(System.String)') to resolve the url in the markdown format. - -```csharp -public static DefaultDocumentation.Api.IWriter AppendLink(this DefaultDocumentation.Api.IWriter writer, string id, string? displayedName=null); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to use. - - - -`id` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The id to link to. - - - -`displayedName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The displayed name of the link. - -#### Returns -[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') -The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/markdown/IWriterExtension.AppendUrl(thisIWriter,string,string,string).md b/documentation/markdown/IWriterExtension.AppendUrl(thisIWriter,string,string,string).md deleted file mode 100644 index 83b51bc3..00000000 --- a/documentation/markdown/IWriterExtension.AppendUrl(thisIWriter,string,string,string).md +++ /dev/null @@ -1,39 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Extensions](index.md#DefaultDocumentation.Markdown.Extensions 'DefaultDocumentation.Markdown.Extensions').[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension') - -## IWriterExtension.AppendUrl(this IWriter, string, string, string) Method - -Append an url in the markdown format. - -```csharp -public static DefaultDocumentation.Api.IWriter AppendUrl(this DefaultDocumentation.Api.IWriter writer, string url, string? displayedName=null, string? tooltip=null); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to use. - - - -`url` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The url of the link. - - - -`displayedName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The displayed name of the link. - - - -`tooltip` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The tooltip of the link. - -#### Returns -[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') -The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/markdown/IWriterExtension.EnsureLineStart(thisIWriter).md b/documentation/markdown/IWriterExtension.EnsureLineStart(thisIWriter).md deleted file mode 100644 index 0e4f33f2..00000000 --- a/documentation/markdown/IWriterExtension.EnsureLineStart(thisIWriter).md +++ /dev/null @@ -1,21 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Extensions](index.md#DefaultDocumentation.Markdown.Extensions 'DefaultDocumentation.Markdown.Extensions').[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension') - -## IWriterExtension.EnsureLineStart(this IWriter) Method - -Ensures that the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') ends with a line break and call [AppendLine()](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.AppendLine().md 'DefaultDocumentation.Api.IWriter.AppendLine') if it's not the case. - -```csharp -public static DefaultDocumentation.Api.IWriter EnsureLineStart(this DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to check. - -#### Returns -[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') -The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/markdown/IWriterExtension.EnsureLineStartAndAppendLine(thisIWriter).md b/documentation/markdown/IWriterExtension.EnsureLineStartAndAppendLine(thisIWriter).md deleted file mode 100644 index 9e7ceab9..00000000 --- a/documentation/markdown/IWriterExtension.EnsureLineStartAndAppendLine(thisIWriter).md +++ /dev/null @@ -1,21 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Extensions](index.md#DefaultDocumentation.Markdown.Extensions 'DefaultDocumentation.Markdown.Extensions').[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension') - -## IWriterExtension.EnsureLineStartAndAppendLine(this IWriter) Method - -Calls [EnsureLineStart(this IWriter)](IWriterExtension.EnsureLineStart(thisIWriter).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.EnsureLineStart(this DefaultDocumentation.Api.IWriter)') and [AppendLine()](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.AppendLine().md 'DefaultDocumentation.Api.IWriter.AppendLine'). - -```csharp -public static DefaultDocumentation.Api.IWriter EnsureLineStartAndAppendLine(this DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -#### Returns -[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') -The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/markdown/IWriterExtension.GetCurrentItem(thisIWriter).md b/documentation/markdown/IWriterExtension.GetCurrentItem(thisIWriter).md deleted file mode 100644 index 3d1c721d..00000000 --- a/documentation/markdown/IWriterExtension.GetCurrentItem(thisIWriter).md +++ /dev/null @@ -1,22 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Extensions](index.md#DefaultDocumentation.Markdown.Extensions 'DefaultDocumentation.Markdown.Extensions').[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension') - -## IWriterExtension.GetCurrentItem(this IWriter) Method - -Gets the current item that is being processed by this [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -It can be different from the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.DocItem.md 'DefaultDocumentation.Api.IWriter.DocItem') when inlining child documentation in its parent page. - -```csharp -public static DefaultDocumentation.Models.DocItem GetCurrentItem(this DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') for which to get the current item. - -#### Returns -[DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') -The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which the documentation is being generated. \ No newline at end of file diff --git a/documentation/markdown/IWriterExtension.GetDisplayAsSingleLine(thisIWriter).md b/documentation/markdown/IWriterExtension.GetDisplayAsSingleLine(thisIWriter).md deleted file mode 100644 index b0b92520..00000000 --- a/documentation/markdown/IWriterExtension.GetDisplayAsSingleLine(thisIWriter).md +++ /dev/null @@ -1,22 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Extensions](index.md#DefaultDocumentation.Markdown.Extensions 'DefaultDocumentation.Markdown.Extensions').[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension') - -## IWriterExtension.GetDisplayAsSingleLine(this IWriter) Method - -Gets whether all futur data appended to the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') should stay on the same line (usefull for table). -This setting is used by the [MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') type. - -```csharp -public static bool GetDisplayAsSingleLine(this DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') for which to get this setting. - -#### Returns -[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') -Whether all futur data to happend should stay on the same line. \ No newline at end of file diff --git a/documentation/markdown/IWriterExtension.GetIgnoreLineBreak(thisIWriter).md b/documentation/markdown/IWriterExtension.GetIgnoreLineBreak(thisIWriter).md deleted file mode 100644 index 6e09fc83..00000000 --- a/documentation/markdown/IWriterExtension.GetIgnoreLineBreak(thisIWriter).md +++ /dev/null @@ -1,25 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Extensions](index.md#DefaultDocumentation.Markdown.Extensions 'DefaultDocumentation.Markdown.Extensions').[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension') - -## IWriterExtension.GetIgnoreLineBreak(this IWriter) Method - -Gets whether line break in the xml documentation should be ignored in the generated markdown. -This setting is used by the [MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') type. - -```csharp -public static bool GetIgnoreLineBreak(this DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') for which to get this setting. - -#### Returns -[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') -Whether line break in the xml documentation should be ignored in the generated markdown. - -### See Also -- [Markdown.IgnoreLineBreak](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_IgnoreLineBreak 'https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_IgnoreLineBreak') \ No newline at end of file diff --git a/documentation/markdown/IWriterExtension.SetCurrentItem(thisIWriter,DocItem).md b/documentation/markdown/IWriterExtension.SetCurrentItem(thisIWriter,DocItem).md deleted file mode 100644 index 69b70bfe..00000000 --- a/documentation/markdown/IWriterExtension.SetCurrentItem(thisIWriter,DocItem).md +++ /dev/null @@ -1,28 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Extensions](index.md#DefaultDocumentation.Markdown.Extensions 'DefaultDocumentation.Markdown.Extensions').[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension') - -## IWriterExtension.SetCurrentItem(this IWriter, DocItem) Method - -Sets the current item that is being processed by this [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -It can be different from the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.DocItem.md 'DefaultDocumentation.Api.IWriter.DocItem') when inlining child documentation in its parent page. - -```csharp -public static DefaultDocumentation.Api.IWriter SetCurrentItem(this DefaultDocumentation.Api.IWriter writer, DefaultDocumentation.Models.DocItem value); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') for which to set the current item. - - - -`value` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which the documentation is being generated. - -#### Returns -[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') -The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/markdown/IWriterExtension.SetDisplayAsSingleLine(thisIWriter,Nullable_bool_).md b/documentation/markdown/IWriterExtension.SetDisplayAsSingleLine(thisIWriter,Nullable_bool_).md deleted file mode 100644 index 2b66b88d..00000000 --- a/documentation/markdown/IWriterExtension.SetDisplayAsSingleLine(thisIWriter,Nullable_bool_).md +++ /dev/null @@ -1,28 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Extensions](index.md#DefaultDocumentation.Markdown.Extensions 'DefaultDocumentation.Markdown.Extensions').[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension') - -## IWriterExtension.SetDisplayAsSingleLine(this IWriter, Nullable) Method - -Sets whether all futur data appended to the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') should stay on the same line (usefull for table). -This setting is used by the [MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') type. - -```csharp -public static DefaultDocumentation.Api.IWriter SetDisplayAsSingleLine(this DefaultDocumentation.Api.IWriter writer, System.Nullable value); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') for which to set this setting. - - - -`value` [System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') - -Whether all futur data to happend should stay on the same line. - -#### Returns -[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') -The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/markdown/IWriterExtension.SetIgnoreLineBreakLine(thisIWriter,Nullable_bool_).md b/documentation/markdown/IWriterExtension.SetIgnoreLineBreakLine(thisIWriter,Nullable_bool_).md deleted file mode 100644 index 43dac1c7..00000000 --- a/documentation/markdown/IWriterExtension.SetIgnoreLineBreakLine(thisIWriter,Nullable_bool_).md +++ /dev/null @@ -1,31 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Extensions](index.md#DefaultDocumentation.Markdown.Extensions 'DefaultDocumentation.Markdown.Extensions').[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension') - -## IWriterExtension.SetIgnoreLineBreakLine(this IWriter, Nullable) Method - -Sets whether line break in the xml documentation should be ignored in the generated markdown. -This setting is used by the [MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') type. - -```csharp -public static DefaultDocumentation.Api.IWriter SetIgnoreLineBreakLine(this DefaultDocumentation.Api.IWriter writer, System.Nullable value); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') for which to set this setting. - - - -`value` [System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1') - -Whether line break in the xml documentation should be ignored in the generated markdown. - -#### Returns -[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') -The given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -### See Also -- [Markdown.IgnoreLineBreak](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_IgnoreLineBreak 'https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_IgnoreLineBreak') \ No newline at end of file diff --git a/documentation/markdown/IWriterExtension.ToOverrideWriter(thisIWriter).md b/documentation/markdown/IWriterExtension.ToOverrideWriter(thisIWriter).md deleted file mode 100644 index 31a00c51..00000000 --- a/documentation/markdown/IWriterExtension.ToOverrideWriter(thisIWriter).md +++ /dev/null @@ -1,21 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Extensions](index.md#DefaultDocumentation.Markdown.Extensions 'DefaultDocumentation.Markdown.Extensions').[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension') - -## IWriterExtension.ToOverrideWriter(this IWriter) Method - -Decorates the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') with a [OverrideWriter](OverrideWriter.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter') to override its setting in a given scope. - -```csharp -public static DefaultDocumentation.Api.IWriter ToOverrideWriter(this DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to decorate. - -#### Returns -[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') -The decorated [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/markdown/IWriterExtension.ToPrefixedWriter(thisIWriter,string).md b/documentation/markdown/IWriterExtension.ToPrefixedWriter(thisIWriter,string).md deleted file mode 100644 index 9174e340..00000000 --- a/documentation/markdown/IWriterExtension.ToPrefixedWriter(thisIWriter,string).md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Extensions](index.md#DefaultDocumentation.Markdown.Extensions 'DefaultDocumentation.Markdown.Extensions').[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension') - -## IWriterExtension.ToPrefixedWriter(this IWriter, string) Method - -Decorates the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') with a [PrefixedWriter](PrefixedWriter.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter') to prefix every new line with the given prefix. - -```csharp -public static DefaultDocumentation.Api.IWriter ToPrefixedWriter(this DefaultDocumentation.Api.IWriter writer, string prefix); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to decorate. - - - -`prefix` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The string to prefix every new line with. - -#### Returns -[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') -The decorated [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/markdown/IWriterExtension.md b/documentation/markdown/IWriterExtension.md deleted file mode 100644 index 715e8773..00000000 --- a/documentation/markdown/IWriterExtension.md +++ /dev/null @@ -1,30 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Extensions](index.md#DefaultDocumentation.Markdown.Extensions 'DefaultDocumentation.Markdown.Extensions') - -## IWriterExtension Class - -Provides extension methods on the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') type. - -```csharp -public static class IWriterExtension -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 IWriterExtension - -| Methods | | -| :--- | :--- | -| [AppendAsMarkdown(this IWriter, XElement)](IWriterExtension.AppendAsMarkdown(thisIWriter,XElement).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.AppendAsMarkdown(this DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)') | Appends a [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') decorating the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') with a [MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter'). | -| [AppendLink(this IWriter, DocItem, INamedElement)](IWriterExtension.AppendLink(thisIWriter,DocItem,INamedElement).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.AppendLink(this DefaultDocumentation.Api.IWriter, DefaultDocumentation.Models.DocItem, INamedElement)') | Append an link to an [ICSharpCode.Decompiler.TypeSystem.INamedElement](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.TypeSystem.INamedElement 'ICSharpCode.Decompiler.TypeSystem.INamedElement') in the markdown format. | -| [AppendLink(this IWriter, DocItem, string)](IWriterExtension.AppendLink(thisIWriter,DocItem,string).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.AppendLink(this DefaultDocumentation.Api.IWriter, DefaultDocumentation.Models.DocItem, string)') | Append an link to a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') in the markdown format. | -| [AppendLink(this IWriter, string, string)](IWriterExtension.AppendLink(thisIWriter,string,string).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.AppendLink(this DefaultDocumentation.Api.IWriter, string, string)') | Append an link to an id using [GetUrl(string)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.GetUrl(string).md 'DefaultDocumentation.IGeneralContext.GetUrl(System.String)') to resolve the url in the markdown format. | -| [AppendUrl(this IWriter, string, string, string)](IWriterExtension.AppendUrl(thisIWriter,string,string,string).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.AppendUrl(this DefaultDocumentation.Api.IWriter, string, string, string)') | Append an url in the markdown format. | -| [EnsureLineStart(this IWriter)](IWriterExtension.EnsureLineStart(thisIWriter).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.EnsureLineStart(this DefaultDocumentation.Api.IWriter)') | Ensures that the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') ends with a line break and call [AppendLine()](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.AppendLine().md 'DefaultDocumentation.Api.IWriter.AppendLine') if it's not the case. | -| [EnsureLineStartAndAppendLine(this IWriter)](IWriterExtension.EnsureLineStartAndAppendLine(thisIWriter).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.EnsureLineStartAndAppendLine(this DefaultDocumentation.Api.IWriter)') | Calls [EnsureLineStart(this IWriter)](IWriterExtension.EnsureLineStart(thisIWriter).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.EnsureLineStart(this DefaultDocumentation.Api.IWriter)') and [AppendLine()](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.AppendLine().md 'DefaultDocumentation.Api.IWriter.AppendLine'). | -| [GetCurrentItem(this IWriter)](IWriterExtension.GetCurrentItem(thisIWriter).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.GetCurrentItem(this DefaultDocumentation.Api.IWriter)') | Gets the current item that is being processed by this [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter').
It can be different from the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.DocItem.md 'DefaultDocumentation.Api.IWriter.DocItem') when inlining child documentation in its parent page. | -| [GetDisplayAsSingleLine(this IWriter)](IWriterExtension.GetDisplayAsSingleLine(thisIWriter).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.GetDisplayAsSingleLine(this DefaultDocumentation.Api.IWriter)') | Gets whether all futur data appended to the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') should stay on the same line (usefull for table).
This setting is used by the [MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') type. | -| [GetIgnoreLineBreak(this IWriter)](IWriterExtension.GetIgnoreLineBreak(thisIWriter).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.GetIgnoreLineBreak(this DefaultDocumentation.Api.IWriter)') | Gets whether line break in the xml documentation should be ignored in the generated markdown.
This setting is used by the [MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') type. | -| [SetCurrentItem(this IWriter, DocItem)](IWriterExtension.SetCurrentItem(thisIWriter,DocItem).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.SetCurrentItem(this DefaultDocumentation.Api.IWriter, DefaultDocumentation.Models.DocItem)') | Sets the current item that is being processed by this [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter').
It can be different from the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.DocItem.md 'DefaultDocumentation.Api.IWriter.DocItem') when inlining child documentation in its parent page. | -| [SetDisplayAsSingleLine(this IWriter, Nullable<bool>)](IWriterExtension.SetDisplayAsSingleLine(thisIWriter,Nullable_bool_).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.SetDisplayAsSingleLine(this DefaultDocumentation.Api.IWriter, System.Nullable)') | Sets whether all futur data appended to the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') should stay on the same line (usefull for table).
This setting is used by the [MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') type. | -| [SetIgnoreLineBreakLine(this IWriter, Nullable<bool>)](IWriterExtension.SetIgnoreLineBreakLine(thisIWriter,Nullable_bool_).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.SetIgnoreLineBreakLine(this DefaultDocumentation.Api.IWriter, System.Nullable)') | Sets whether line break in the xml documentation should be ignored in the generated markdown.
This setting is used by the [MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') type. | -| [ToOverrideWriter(this IWriter)](IWriterExtension.ToOverrideWriter(thisIWriter).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.ToOverrideWriter(this DefaultDocumentation.Api.IWriter)') | Decorates the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') with a [OverrideWriter](OverrideWriter.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter') to override its setting in a given scope. | -| [ToPrefixedWriter(this IWriter, string)](IWriterExtension.ToPrefixedWriter(thisIWriter,string).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.ToPrefixedWriter(this DefaultDocumentation.Api.IWriter, string)') | Decorates the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') with a [PrefixedWriter](PrefixedWriter.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter') to prefix every new line with the given prefix. | diff --git a/documentation/markdown/ImplementSection.ConfigName.md b/documentation/markdown/ImplementSection.ConfigName.md deleted file mode 100644 index 44a63490..00000000 --- a/documentation/markdown/ImplementSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ImplementSection](ImplementSection.md 'DefaultDocumentation.Markdown.Sections.ImplementSection') - -## ImplementSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Implement; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/ImplementSection.Name.md b/documentation/markdown/ImplementSection.Name.md deleted file mode 100644 index 35a64f16..00000000 --- a/documentation/markdown/ImplementSection.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ImplementSection](ImplementSection.md 'DefaultDocumentation.Markdown.Sections.ImplementSection') - -## ImplementSection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/ImplementSection.Write(IWriter).md b/documentation/markdown/ImplementSection.Write(IWriter).md deleted file mode 100644 index eefb4586..00000000 --- a/documentation/markdown/ImplementSection.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ImplementSection](ImplementSection.md 'DefaultDocumentation.Markdown.Sections.ImplementSection') - -## ImplementSection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/ImplementSection.md b/documentation/markdown/ImplementSection.md deleted file mode 100644 index 6fc84ac7..00000000 --- a/documentation/markdown/ImplementSection.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## ImplementSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the types/members implemented by the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class ImplementSection : -DefaultDocumentation.Api.ISection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ImplementSection - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Fields | | -| :--- | :--- | -| [ConfigName](ImplementSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.ImplementSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](ImplementSection.Name.md 'DefaultDocumentation.Markdown.Sections.ImplementSection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](ImplementSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.ImplementSection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/InheritanceSection.ConfigName.md b/documentation/markdown/InheritanceSection.ConfigName.md deleted file mode 100644 index 90927072..00000000 --- a/documentation/markdown/InheritanceSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[InheritanceSection](InheritanceSection.md 'DefaultDocumentation.Markdown.Sections.InheritanceSection') - -## InheritanceSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Inheritance; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/InheritanceSection.Name.md b/documentation/markdown/InheritanceSection.Name.md deleted file mode 100644 index c5e21060..00000000 --- a/documentation/markdown/InheritanceSection.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[InheritanceSection](InheritanceSection.md 'DefaultDocumentation.Markdown.Sections.InheritanceSection') - -## InheritanceSection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/InheritanceSection.Write(IWriter).md b/documentation/markdown/InheritanceSection.Write(IWriter).md deleted file mode 100644 index 13a7487a..00000000 --- a/documentation/markdown/InheritanceSection.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[InheritanceSection](InheritanceSection.md 'DefaultDocumentation.Markdown.Sections.InheritanceSection') - -## InheritanceSection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/InheritanceSection.md b/documentation/markdown/InheritanceSection.md deleted file mode 100644 index 9a172e2a..00000000 --- a/documentation/markdown/InheritanceSection.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## InheritanceSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the types inherited by the [TypeDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem'). - -```csharp -public sealed class InheritanceSection : -DefaultDocumentation.Api.ISection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 InheritanceSection - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Fields | | -| :--- | :--- | -| [ConfigName](InheritanceSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.InheritanceSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](InheritanceSection.Name.md 'DefaultDocumentation.Markdown.Sections.InheritanceSection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](InheritanceSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.InheritanceSection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/InterfacesSection.ConfigName.md b/documentation/markdown/InterfacesSection.ConfigName.md deleted file mode 100644 index dd8cbee7..00000000 --- a/documentation/markdown/InterfacesSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[InterfacesSection](InterfacesSection.md 'DefaultDocumentation.Markdown.Sections.InterfacesSection') - -## InterfacesSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Interfaces; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/InterfacesSection.InterfacesSection().md b/documentation/markdown/InterfacesSection.InterfacesSection().md deleted file mode 100644 index 7be690ca..00000000 --- a/documentation/markdown/InterfacesSection.InterfacesSection().md +++ /dev/null @@ -1,10 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[InterfacesSection](InterfacesSection.md 'DefaultDocumentation.Markdown.Sections.InterfacesSection') - -## InterfacesSection() Constructor - -Initialize a new instance of the [InterfacesSection](InterfacesSection.md 'DefaultDocumentation.Markdown.Sections.InterfacesSection') type. - -```csharp -public InterfacesSection(); -``` \ No newline at end of file diff --git a/documentation/markdown/InterfacesSection.md b/documentation/markdown/InterfacesSection.md deleted file mode 100644 index 9ddbd209..00000000 --- a/documentation/markdown/InterfacesSection.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## InterfacesSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [InterfaceDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/InterfaceDocItem.md 'DefaultDocumentation.Models.Types.InterfaceDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class InterfacesSection : DefaultDocumentation.Markdown.Sections.ChildrenSection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DefaultDocumentation.Markdown.Sections.ChildrenSection<](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection')[InterfaceDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/InterfaceDocItem.md 'DefaultDocumentation.Models.Types.InterfaceDocItem')[>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') 🡒 InterfacesSection - -| Constructors | | -| :--- | :--- | -| [InterfacesSection()](InterfacesSection.InterfacesSection().md 'DefaultDocumentation.Markdown.Sections.InterfacesSection.InterfacesSection()') | Initialize a new instance of the [InterfacesSection](InterfacesSection.md 'DefaultDocumentation.Markdown.Sections.InterfacesSection') type. | - -| Fields | | -| :--- | :--- | -| [ConfigName](InterfacesSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.InterfacesSection.ConfigName') | The name of this implementation used at the configuration level. | diff --git a/documentation/markdown/ListElement.Name.md b/documentation/markdown/ListElement.Name.md deleted file mode 100644 index 63694255..00000000 --- a/documentation/markdown/ListElement.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements').[ListElement](ListElement.md 'DefaultDocumentation.Markdown.Elements.ListElement') - -## ListElement.Name Property - -Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.Name.md 'DefaultDocumentation.Api.IElement.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/ListElement.Write(IWriter,XElement).md b/documentation/markdown/ListElement.Write(IWriter,XElement).md deleted file mode 100644 index 64db2c9e..00000000 --- a/documentation/markdown/ListElement.Write(IWriter,XElement).md +++ /dev/null @@ -1,25 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements').[ListElement](ListElement.md 'DefaultDocumentation.Markdown.Elements.ListElement') - -## ListElement.Write(IWriter, XElement) Method - -Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - - - -`element` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') to write. - -Implements [Write(IWriter, XElement)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.Write(IWriter,XElement).md 'DefaultDocumentation.Api.IElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)') \ No newline at end of file diff --git a/documentation/markdown/ListElement.md b/documentation/markdown/ListElement.md deleted file mode 100644 index 05a9204f..00000000 --- a/documentation/markdown/ListElement.md +++ /dev/null @@ -1,23 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements') - -## ListElement Class - -Handles `list` xml element. - -```csharp -public sealed class ListElement : -DefaultDocumentation.Api.IElement -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ListElement - -Implements [IElement](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.md 'DefaultDocumentation.Api.IElement') - -| Properties | | -| :--- | :--- | -| [Name](ListElement.Name.md 'DefaultDocumentation.Markdown.Elements.ListElement.Name') | Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter, XElement)](ListElement.Write(IWriter,XElement).md 'DefaultDocumentation.Markdown.Elements.ListElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)') | Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). | diff --git a/documentation/markdown/MarkdownWriter.Append(string).md b/documentation/markdown/MarkdownWriter.Append(string).md deleted file mode 100644 index 1cefc0c9..00000000 --- a/documentation/markdown/MarkdownWriter.Append(string).md +++ /dev/null @@ -1,21 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') - -## MarkdownWriter.Append(string) Method - -Appends a string at the end of the documentation text. - -```csharp -public DefaultDocumentation.Api.IWriter Append(string value); -``` -#### Parameters - - - -`value` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -Implements [Append(string)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.Append(string).md 'DefaultDocumentation.Api.IWriter.Append(System.String)') - -#### Returns -[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') -The current [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/markdown/MarkdownWriter.AppendLine().md b/documentation/markdown/MarkdownWriter.AppendLine().md deleted file mode 100644 index 910dede7..00000000 --- a/documentation/markdown/MarkdownWriter.AppendLine().md +++ /dev/null @@ -1,16 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') - -## MarkdownWriter.AppendLine() Method - -Appends a [System.Environment.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System.Environment.NewLine') or a `` at the end of the documentation text depending of the current setting. - -```csharp -public DefaultDocumentation.Api.IWriter AppendLine(); -``` - -Implements [AppendLine()](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.AppendLine().md 'DefaultDocumentation.Api.IWriter.AppendLine') - -#### Returns -[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') -The current [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/markdown/MarkdownWriter.Context.md b/documentation/markdown/MarkdownWriter.Context.md deleted file mode 100644 index fa66d45a..00000000 --- a/documentation/markdown/MarkdownWriter.Context.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') - -## MarkdownWriter.Context Property - -Gets the [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - -```csharp -public DefaultDocumentation.IGeneralContext Context { get; } -``` - -Implements [Context](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.Context.md 'DefaultDocumentation.Api.IWriter.Context') - -#### Property Value -[IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') \ No newline at end of file diff --git a/documentation/markdown/MarkdownWriter.DocItem.md b/documentation/markdown/MarkdownWriter.DocItem.md deleted file mode 100644 index 6e860866..00000000 --- a/documentation/markdown/MarkdownWriter.DocItem.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') - -## MarkdownWriter.DocItem Property - -Gets the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which the documentation is being generated. - -```csharp -public DefaultDocumentation.Models.DocItem DocItem { get; } -``` - -Implements [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.DocItem.md 'DefaultDocumentation.Api.IWriter.DocItem') - -#### Property Value -[DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') \ No newline at end of file diff --git a/documentation/markdown/MarkdownWriter.EndsWith(string).md b/documentation/markdown/MarkdownWriter.EndsWith(string).md deleted file mode 100644 index 9e6ac6b5..00000000 --- a/documentation/markdown/MarkdownWriter.EndsWith(string).md +++ /dev/null @@ -1,23 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') - -## MarkdownWriter.EndsWith(string) Method - -Returns whether the documentation text ends with the given string. - -```csharp -public bool EndsWith(string value); -``` -#### Parameters - - - -`value` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') to check. - -Implements [EndsWith(string)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.EndsWith(string).md 'DefaultDocumentation.Api.IWriter.EndsWith(System.String)') - -#### Returns -[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') -[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if the documentation text ends with [value](MarkdownWriter.EndsWith(string).md#DefaultDocumentation.Markdown.Writers.MarkdownWriter.EndsWith(string).value 'DefaultDocumentation.Markdown.Writers.MarkdownWriter.EndsWith(string).value'), else [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). \ No newline at end of file diff --git a/documentation/markdown/MarkdownWriter.Length.md b/documentation/markdown/MarkdownWriter.Length.md deleted file mode 100644 index ec451def..00000000 --- a/documentation/markdown/MarkdownWriter.Length.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') - -## MarkdownWriter.Length Property - -Gets or sets the length of the documentation text currently produced. - -```csharp -public int Length { get; set; } -``` - -Implements [Length](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.Length.md 'DefaultDocumentation.Api.IWriter.Length') - -#### Property Value -[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') \ No newline at end of file diff --git a/documentation/markdown/MarkdownWriter.MarkdownWriter(IWriter).md b/documentation/markdown/MarkdownWriter.MarkdownWriter(IWriter).md deleted file mode 100644 index 6c807025..00000000 --- a/documentation/markdown/MarkdownWriter.MarkdownWriter(IWriter).md +++ /dev/null @@ -1,17 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') - -## MarkdownWriter(IWriter) Constructor - -Initializes a new instance of the [MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') type. - -```csharp -public MarkdownWriter(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') instance to decorate. \ No newline at end of file diff --git a/documentation/markdown/MarkdownWriter.md b/documentation/markdown/MarkdownWriter.md deleted file mode 100644 index 1058c24f..00000000 --- a/documentation/markdown/MarkdownWriter.md +++ /dev/null @@ -1,33 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers') - -## MarkdownWriter Class - -Decorator of the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') type to handle the [Markdown.IgnoreLineBreak](https://github.com/Doraku/DefaultDocumentation#ignorelinebreak 'https://github.com/Doraku/DefaultDocumentation#ignorelinebreak') setting. -It also uses a [OverrideWriter](OverrideWriter.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter') internally to further decorate the instance. - -```csharp -public sealed class MarkdownWriter : -DefaultDocumentation.Api.IWriter -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 MarkdownWriter - -Implements [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -| Constructors | | -| :--- | :--- | -| [MarkdownWriter(IWriter)](MarkdownWriter.MarkdownWriter(IWriter).md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter.MarkdownWriter(DefaultDocumentation.Api.IWriter)') | Initializes a new instance of the [MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') type. | - -| Properties | | -| :--- | :--- | -| [Context](MarkdownWriter.Context.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter.Context') | Gets the [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. | -| [DocItem](MarkdownWriter.DocItem.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter.DocItem') | Gets the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which the documentation is being generated. | -| [Length](MarkdownWriter.Length.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter.Length') | Gets or sets the length of the documentation text currently produced. | -| [this[string]](MarkdownWriter.this[string].md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter.this[string]') | Gets or sets extra data for the current [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') documentation generation. | - -| Methods | | -| :--- | :--- | -| [Append(string)](MarkdownWriter.Append(string).md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter.Append(string)') | Appends a string at the end of the documentation text. | -| [AppendLine()](MarkdownWriter.AppendLine().md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter.AppendLine()') | Appends a [System.Environment.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System.Environment.NewLine') or a `` at the end of the documentation text depending of the current setting. | -| [EndsWith(string)](MarkdownWriter.EndsWith(string).md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter.EndsWith(string)') | Returns whether the documentation text ends with the given string. | diff --git a/documentation/markdown/MarkdownWriter.this[string].md b/documentation/markdown/MarkdownWriter.this[string].md deleted file mode 100644 index 1052e2e7..00000000 --- a/documentation/markdown/MarkdownWriter.this[string].md +++ /dev/null @@ -1,22 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') - -## MarkdownWriter.this[string] Property - -Gets or sets extra data for the current [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') documentation generation. - -```csharp -public object? this[string key] { get; set; } -``` -#### Parameters - - - -`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The key of the data. - -Implements [this[string]](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.this[string].md 'DefaultDocumentation.Api.IWriter.Item(System.String)') - -#### Property Value -[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') \ No newline at end of file diff --git a/documentation/markdown/Md5Factory.ConfigName.md b/documentation/markdown/Md5Factory.ConfigName.md deleted file mode 100644 index ecca4545..00000000 --- a/documentation/markdown/Md5Factory.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[Md5Factory](Md5Factory.md 'DefaultDocumentation.Markdown.FileNameFactories.Md5Factory') - -## Md5Factory.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Md5; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/Md5Factory.GetMarkdownFileName(IGeneralContext,DocItem).md b/documentation/markdown/Md5Factory.GetMarkdownFileName(IGeneralContext,DocItem).md deleted file mode 100644 index ad2d1ce6..00000000 --- a/documentation/markdown/Md5Factory.GetMarkdownFileName(IGeneralContext,DocItem).md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[Md5Factory](Md5Factory.md 'DefaultDocumentation.Markdown.FileNameFactories.Md5Factory') - -## Md5Factory.GetMarkdownFileName(IGeneralContext, DocItem) Method - -Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -protected override string GetMarkdownFileName(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); -``` -#### Parameters - - - -`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - - - -`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which to get the documentation file name. - -#### Returns -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The file name to use. \ No newline at end of file diff --git a/documentation/markdown/Md5Factory.Name.md b/documentation/markdown/Md5Factory.Name.md deleted file mode 100644 index 51b3e788..00000000 --- a/documentation/markdown/Md5Factory.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[Md5Factory](Md5Factory.md 'DefaultDocumentation.Markdown.FileNameFactories.Md5Factory') - -## Md5Factory.Name Property - -Gets the name of the factory, used to identify it at the configuration level. - -```csharp -public override string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.Name.md 'DefaultDocumentation.Api.IFileNameFactory.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/Md5Factory.md b/documentation/markdown/Md5Factory.md deleted file mode 100644 index 4b5a2da7..00000000 --- a/documentation/markdown/Md5Factory.md +++ /dev/null @@ -1,24 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories') - -## Md5Factory Class - -[IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') implementation using an md5 on the [FullName](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.FullName.md 'DefaultDocumentation.Models.DocItem.FullName') as file name. - -```csharp -public sealed class Md5Factory : DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [AMarkdownFactory](AMarkdownFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory') 🡒 Md5Factory - -| Fields | | -| :--- | :--- | -| [ConfigName](Md5Factory.ConfigName.md 'DefaultDocumentation.Markdown.FileNameFactories.Md5Factory.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](Md5Factory.Name.md 'DefaultDocumentation.Markdown.FileNameFactories.Md5Factory.Name') | Gets the name of the factory, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [GetMarkdownFileName(IGeneralContext, DocItem)](Md5Factory.GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.FileNameFactories.Md5Factory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)') | Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). | diff --git a/documentation/markdown/MethodsSection.ConfigName.md b/documentation/markdown/MethodsSection.ConfigName.md deleted file mode 100644 index 8f8816f2..00000000 --- a/documentation/markdown/MethodsSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[MethodsSection](MethodsSection.md 'DefaultDocumentation.Markdown.Sections.MethodsSection') - -## MethodsSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Methods; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/MethodsSection.MethodsSection().md b/documentation/markdown/MethodsSection.MethodsSection().md deleted file mode 100644 index 19f39c0b..00000000 --- a/documentation/markdown/MethodsSection.MethodsSection().md +++ /dev/null @@ -1,10 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[MethodsSection](MethodsSection.md 'DefaultDocumentation.Markdown.Sections.MethodsSection') - -## MethodsSection() Constructor - -Initialize a new instance of the [MethodsSection](MethodsSection.md 'DefaultDocumentation.Markdown.Sections.MethodsSection') type. - -```csharp -public MethodsSection(); -``` \ No newline at end of file diff --git a/documentation/markdown/MethodsSection.md b/documentation/markdown/MethodsSection.md deleted file mode 100644 index 2849667b..00000000 --- a/documentation/markdown/MethodsSection.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## MethodsSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [MethodDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/MethodDocItem.md 'DefaultDocumentation.Models.Members.MethodDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class MethodsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DefaultDocumentation.Markdown.Sections.ChildrenSection<](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection')[MethodDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/MethodDocItem.md 'DefaultDocumentation.Models.Members.MethodDocItem')[>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') 🡒 MethodsSection - -| Constructors | | -| :--- | :--- | -| [MethodsSection()](MethodsSection.MethodsSection().md 'DefaultDocumentation.Markdown.Sections.MethodsSection.MethodsSection()') | Initialize a new instance of the [MethodsSection](MethodsSection.md 'DefaultDocumentation.Markdown.Sections.MethodsSection') type. | - -| Fields | | -| :--- | :--- | -| [ConfigName](MethodsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.MethodsSection.ConfigName') | The name of this implementation used at the configuration level. | diff --git a/documentation/markdown/NameAndMd5MixFactory.ConfigName.md b/documentation/markdown/NameAndMd5MixFactory.ConfigName.md deleted file mode 100644 index 1faedf75..00000000 --- a/documentation/markdown/NameAndMd5MixFactory.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[NameAndMd5MixFactory](NameAndMd5MixFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory') - -## NameAndMd5MixFactory.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = NameAndMd5Mix; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/NameAndMd5MixFactory.GetMarkdownFileName(IGeneralContext,DocItem).md b/documentation/markdown/NameAndMd5MixFactory.GetMarkdownFileName(IGeneralContext,DocItem).md deleted file mode 100644 index bbecca74..00000000 --- a/documentation/markdown/NameAndMd5MixFactory.GetMarkdownFileName(IGeneralContext,DocItem).md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[NameAndMd5MixFactory](NameAndMd5MixFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory') - -## NameAndMd5MixFactory.GetMarkdownFileName(IGeneralContext, DocItem) Method - -Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -protected override string GetMarkdownFileName(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); -``` -#### Parameters - - - -`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - - - -`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which to get the documentation file name. - -#### Returns -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The file name to use. \ No newline at end of file diff --git a/documentation/markdown/NameAndMd5MixFactory.Name.md b/documentation/markdown/NameAndMd5MixFactory.Name.md deleted file mode 100644 index 7abfe456..00000000 --- a/documentation/markdown/NameAndMd5MixFactory.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[NameAndMd5MixFactory](NameAndMd5MixFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory') - -## NameAndMd5MixFactory.Name Property - -Gets the name of the factory, used to identify it at the configuration level. - -```csharp -public override string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.Name.md 'DefaultDocumentation.Api.IFileNameFactory.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/NameAndMd5MixFactory.md b/documentation/markdown/NameAndMd5MixFactory.md deleted file mode 100644 index 739d78cb..00000000 --- a/documentation/markdown/NameAndMd5MixFactory.md +++ /dev/null @@ -1,24 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories') - -## NameAndMd5MixFactory Class - -[IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') implementation using [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.Name.md 'DefaultDocumentation.Models.DocItem.Name') and an md5 on the [FullName](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.FullName.md 'DefaultDocumentation.Models.DocItem.FullName') as file name. - -```csharp -public sealed class NameAndMd5MixFactory : DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [AMarkdownFactory](AMarkdownFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory') 🡒 NameAndMd5MixFactory - -| Fields | | -| :--- | :--- | -| [ConfigName](NameAndMd5MixFactory.ConfigName.md 'DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](NameAndMd5MixFactory.Name.md 'DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory.Name') | Gets the name of the factory, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [GetMarkdownFileName(IGeneralContext, DocItem)](NameAndMd5MixFactory.GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)') | Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). | diff --git a/documentation/markdown/NameFactory.ConfigName.md b/documentation/markdown/NameFactory.ConfigName.md deleted file mode 100644 index daf42c30..00000000 --- a/documentation/markdown/NameFactory.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[NameFactory](NameFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.NameFactory') - -## NameFactory.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Name; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/NameFactory.GetMarkdownFileName(IGeneralContext,DocItem).md b/documentation/markdown/NameFactory.GetMarkdownFileName(IGeneralContext,DocItem).md deleted file mode 100644 index 51b68ec0..00000000 --- a/documentation/markdown/NameFactory.GetMarkdownFileName(IGeneralContext,DocItem).md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[NameFactory](NameFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.NameFactory') - -## NameFactory.GetMarkdownFileName(IGeneralContext, DocItem) Method - -Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -protected override string GetMarkdownFileName(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); -``` -#### Parameters - - - -`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - - - -`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which to get the documentation file name. - -#### Returns -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The file name to use. \ No newline at end of file diff --git a/documentation/markdown/NameFactory.Name.md b/documentation/markdown/NameFactory.Name.md deleted file mode 100644 index 987c0f2d..00000000 --- a/documentation/markdown/NameFactory.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories').[NameFactory](NameFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.NameFactory') - -## NameFactory.Name Property - -Gets the name of the factory, used to identify it at the configuration level. - -```csharp -public override string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.Name.md 'DefaultDocumentation.Api.IFileNameFactory.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/NameFactory.md b/documentation/markdown/NameFactory.md deleted file mode 100644 index 1130f1d7..00000000 --- a/documentation/markdown/NameFactory.md +++ /dev/null @@ -1,24 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.FileNameFactories](index.md#DefaultDocumentation.Markdown.FileNameFactories 'DefaultDocumentation.Markdown.FileNameFactories') - -## NameFactory Class - -[IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') implementation using [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.Name.md 'DefaultDocumentation.Models.DocItem.Name') as file name. - -```csharp -public sealed class NameFactory : DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [AMarkdownFactory](AMarkdownFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory') 🡒 NameFactory - -| Fields | | -| :--- | :--- | -| [ConfigName](NameFactory.ConfigName.md 'DefaultDocumentation.Markdown.FileNameFactories.NameFactory.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](NameFactory.Name.md 'DefaultDocumentation.Markdown.FileNameFactories.NameFactory.Name') | Gets the name of the factory, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [GetMarkdownFileName(IGeneralContext, DocItem)](NameFactory.GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.FileNameFactories.NameFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)') | Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). | diff --git a/documentation/markdown/NamespacesSection.ConfigName.md b/documentation/markdown/NamespacesSection.ConfigName.md deleted file mode 100644 index a4315655..00000000 --- a/documentation/markdown/NamespacesSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[NamespacesSection](NamespacesSection.md 'DefaultDocumentation.Markdown.Sections.NamespacesSection') - -## NamespacesSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Namespaces; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/NamespacesSection.NamespacesSection().md b/documentation/markdown/NamespacesSection.NamespacesSection().md deleted file mode 100644 index 9101e9ac..00000000 --- a/documentation/markdown/NamespacesSection.NamespacesSection().md +++ /dev/null @@ -1,10 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[NamespacesSection](NamespacesSection.md 'DefaultDocumentation.Markdown.Sections.NamespacesSection') - -## NamespacesSection() Constructor - -Initialize a new instance of the [NamespacesSection](NamespacesSection.md 'DefaultDocumentation.Markdown.Sections.NamespacesSection') type. - -```csharp -public NamespacesSection(); -``` \ No newline at end of file diff --git a/documentation/markdown/NamespacesSection.md b/documentation/markdown/NamespacesSection.md deleted file mode 100644 index 94064b89..00000000 --- a/documentation/markdown/NamespacesSection.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## NamespacesSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [NamespaceDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/NamespaceDocItem.md 'DefaultDocumentation.Models.NamespaceDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class NamespacesSection : DefaultDocumentation.Markdown.Sections.ChildrenSection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DefaultDocumentation.Markdown.Sections.ChildrenSection<](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection')[NamespaceDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/NamespaceDocItem.md 'DefaultDocumentation.Models.NamespaceDocItem')[>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') 🡒 NamespacesSection - -| Constructors | | -| :--- | :--- | -| [NamespacesSection()](NamespacesSection.NamespacesSection().md 'DefaultDocumentation.Markdown.Sections.NamespacesSection.NamespacesSection()') | Initialize a new instance of the [NamespacesSection](NamespacesSection.md 'DefaultDocumentation.Markdown.Sections.NamespacesSection') type. | - -| Fields | | -| :--- | :--- | -| [ConfigName](NamespacesSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.NamespacesSection.ConfigName') | The name of this implementation used at the configuration level. | diff --git a/documentation/markdown/NestedTypeVisibilities.md b/documentation/markdown/NestedTypeVisibilities.md deleted file mode 100644 index 2239ef01..00000000 --- a/documentation/markdown/NestedTypeVisibilities.md +++ /dev/null @@ -1,29 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation](index.md#DefaultDocumentation 'DefaultDocumentation') - -## NestedTypeVisibilities Enum - -Specifies where nested types should be displayed in the generated documentation. - -```csharp -public enum NestedTypeVisibilities -``` -### Fields - - - -`DeclaringType` 2 - -Generates nested types in declaring type page. - - - -`Default` 0 - -Same as [Namespace](NestedTypeVisibilities.md#DefaultDocumentation.NestedTypeVisibilities.Namespace 'DefaultDocumentation.NestedTypeVisibilities.Namespace'). - - - -`Namespace` 1 - -Generates nested types in namespace page. \ No newline at end of file diff --git a/documentation/markdown/NoteElement.Name.md b/documentation/markdown/NoteElement.Name.md deleted file mode 100644 index 1f0ca83e..00000000 --- a/documentation/markdown/NoteElement.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements').[NoteElement](NoteElement.md 'DefaultDocumentation.Markdown.Elements.NoteElement') - -## NoteElement.Name Property - -Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.Name.md 'DefaultDocumentation.Api.IElement.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/NoteElement.Write(IWriter,XElement).md b/documentation/markdown/NoteElement.Write(IWriter,XElement).md deleted file mode 100644 index d1425712..00000000 --- a/documentation/markdown/NoteElement.Write(IWriter,XElement).md +++ /dev/null @@ -1,25 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements').[NoteElement](NoteElement.md 'DefaultDocumentation.Markdown.Elements.NoteElement') - -## NoteElement.Write(IWriter, XElement) Method - -Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - - - -`element` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') to write. - -Implements [Write(IWriter, XElement)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.Write(IWriter,XElement).md 'DefaultDocumentation.Api.IElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)') \ No newline at end of file diff --git a/documentation/markdown/NoteElement.md b/documentation/markdown/NoteElement.md deleted file mode 100644 index f8395149..00000000 --- a/documentation/markdown/NoteElement.md +++ /dev/null @@ -1,23 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements') - -## NoteElement Class - -Handles `note` xml element. - -```csharp -public sealed class NoteElement : -DefaultDocumentation.Api.IElement -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 NoteElement - -Implements [IElement](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.md 'DefaultDocumentation.Api.IElement') - -| Properties | | -| :--- | :--- | -| [Name](NoteElement.Name.md 'DefaultDocumentation.Markdown.Elements.NoteElement.Name') | Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter, XElement)](NoteElement.Write(IWriter,XElement).md 'DefaultDocumentation.Markdown.Elements.NoteElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)') | Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). | diff --git a/documentation/markdown/OperatorsSection.ConfigName.md b/documentation/markdown/OperatorsSection.ConfigName.md deleted file mode 100644 index c33ca926..00000000 --- a/documentation/markdown/OperatorsSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[OperatorsSection](OperatorsSection.md 'DefaultDocumentation.Markdown.Sections.OperatorsSection') - -## OperatorsSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Operators; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/OperatorsSection.OperatorsSection().md b/documentation/markdown/OperatorsSection.OperatorsSection().md deleted file mode 100644 index d0f8494d..00000000 --- a/documentation/markdown/OperatorsSection.OperatorsSection().md +++ /dev/null @@ -1,10 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[OperatorsSection](OperatorsSection.md 'DefaultDocumentation.Markdown.Sections.OperatorsSection') - -## OperatorsSection() Constructor - -Initialize a new instance of the [OperatorsSection](OperatorsSection.md 'DefaultDocumentation.Markdown.Sections.OperatorsSection') type. - -```csharp -public OperatorsSection(); -``` \ No newline at end of file diff --git a/documentation/markdown/OperatorsSection.md b/documentation/markdown/OperatorsSection.md deleted file mode 100644 index e3d5b527..00000000 --- a/documentation/markdown/OperatorsSection.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## OperatorsSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [OperatorDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/OperatorDocItem.md 'DefaultDocumentation.Models.Members.OperatorDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class OperatorsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DefaultDocumentation.Markdown.Sections.ChildrenSection<](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection')[OperatorDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/OperatorDocItem.md 'DefaultDocumentation.Models.Members.OperatorDocItem')[>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') 🡒 OperatorsSection - -| Constructors | | -| :--- | :--- | -| [OperatorsSection()](OperatorsSection.OperatorsSection().md 'DefaultDocumentation.Markdown.Sections.OperatorsSection.OperatorsSection()') | Initialize a new instance of the [OperatorsSection](OperatorsSection.md 'DefaultDocumentation.Markdown.Sections.OperatorsSection') type. | - -| Fields | | -| :--- | :--- | -| [ConfigName](OperatorsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.OperatorsSection.ConfigName') | The name of this implementation used at the configuration level. | diff --git a/documentation/markdown/OverrideWriter.Append(string).md b/documentation/markdown/OverrideWriter.Append(string).md deleted file mode 100644 index 861ba5f2..00000000 --- a/documentation/markdown/OverrideWriter.Append(string).md +++ /dev/null @@ -1,21 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[OverrideWriter](OverrideWriter.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter') - -## OverrideWriter.Append(string) Method - -Appends a string at the end of the documentation text. - -```csharp -public DefaultDocumentation.Api.IWriter Append(string value); -``` -#### Parameters - - - -`value` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -Implements [Append(string)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.Append(string).md 'DefaultDocumentation.Api.IWriter.Append(System.String)') - -#### Returns -[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') -The current [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/markdown/OverrideWriter.AppendLine().md b/documentation/markdown/OverrideWriter.AppendLine().md deleted file mode 100644 index c6f54c43..00000000 --- a/documentation/markdown/OverrideWriter.AppendLine().md +++ /dev/null @@ -1,16 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[OverrideWriter](OverrideWriter.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter') - -## OverrideWriter.AppendLine() Method - -Appends a [System.Environment.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System.Environment.NewLine') at the end of the documentation text. - -```csharp -public DefaultDocumentation.Api.IWriter AppendLine(); -``` - -Implements [AppendLine()](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.AppendLine().md 'DefaultDocumentation.Api.IWriter.AppendLine') - -#### Returns -[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') -The current [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/markdown/OverrideWriter.Context.md b/documentation/markdown/OverrideWriter.Context.md deleted file mode 100644 index de970ba7..00000000 --- a/documentation/markdown/OverrideWriter.Context.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[OverrideWriter](OverrideWriter.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter') - -## OverrideWriter.Context Property - -Gets the [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - -```csharp -public DefaultDocumentation.IGeneralContext Context { get; } -``` - -Implements [Context](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.Context.md 'DefaultDocumentation.Api.IWriter.Context') - -#### Property Value -[IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') \ No newline at end of file diff --git a/documentation/markdown/OverrideWriter.DocItem.md b/documentation/markdown/OverrideWriter.DocItem.md deleted file mode 100644 index b2b725c0..00000000 --- a/documentation/markdown/OverrideWriter.DocItem.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[OverrideWriter](OverrideWriter.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter') - -## OverrideWriter.DocItem Property - -Gets the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which the documentation is being generated. - -```csharp -public DefaultDocumentation.Models.DocItem DocItem { get; } -``` - -Implements [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.DocItem.md 'DefaultDocumentation.Api.IWriter.DocItem') - -#### Property Value -[DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') \ No newline at end of file diff --git a/documentation/markdown/OverrideWriter.EndsWith(string).md b/documentation/markdown/OverrideWriter.EndsWith(string).md deleted file mode 100644 index 1deaced6..00000000 --- a/documentation/markdown/OverrideWriter.EndsWith(string).md +++ /dev/null @@ -1,23 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[OverrideWriter](OverrideWriter.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter') - -## OverrideWriter.EndsWith(string) Method - -Returns whether the documentation text ends with the given string. - -```csharp -public bool EndsWith(string value); -``` -#### Parameters - - - -`value` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') to check. - -Implements [EndsWith(string)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.EndsWith(string).md 'DefaultDocumentation.Api.IWriter.EndsWith(System.String)') - -#### Returns -[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') -[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if the documentation text ends with [value](OverrideWriter.EndsWith(string).md#DefaultDocumentation.Markdown.Writers.OverrideWriter.EndsWith(string).value 'DefaultDocumentation.Markdown.Writers.OverrideWriter.EndsWith(string).value'), else [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). \ No newline at end of file diff --git a/documentation/markdown/OverrideWriter.Length.md b/documentation/markdown/OverrideWriter.Length.md deleted file mode 100644 index e6e82157..00000000 --- a/documentation/markdown/OverrideWriter.Length.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[OverrideWriter](OverrideWriter.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter') - -## OverrideWriter.Length Property - -Gets or sets the length of the documentation text currently produced. - -```csharp -public int Length { get; set; } -``` - -Implements [Length](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.Length.md 'DefaultDocumentation.Api.IWriter.Length') - -#### Property Value -[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') \ No newline at end of file diff --git a/documentation/markdown/OverrideWriter.OverrideWriter(IWriter).md b/documentation/markdown/OverrideWriter.OverrideWriter(IWriter).md deleted file mode 100644 index 2b0ccaac..00000000 --- a/documentation/markdown/OverrideWriter.OverrideWriter(IWriter).md +++ /dev/null @@ -1,17 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[OverrideWriter](OverrideWriter.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter') - -## OverrideWriter(IWriter) Constructor - -Initializes a new instance of the [OverrideWriter](OverrideWriter.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter') type. - -```csharp -public OverrideWriter(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') instance to decorate. \ No newline at end of file diff --git a/documentation/markdown/OverrideWriter.md b/documentation/markdown/OverrideWriter.md deleted file mode 100644 index 7dc0825e..00000000 --- a/documentation/markdown/OverrideWriter.md +++ /dev/null @@ -1,32 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers') - -## OverrideWriter Class - -Decorator of the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') type to override its data without changing its actual values. - -```csharp -public sealed class OverrideWriter : -DefaultDocumentation.Api.IWriter -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 OverrideWriter - -Implements [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -| Constructors | | -| :--- | :--- | -| [OverrideWriter(IWriter)](OverrideWriter.OverrideWriter(IWriter).md 'DefaultDocumentation.Markdown.Writers.OverrideWriter.OverrideWriter(DefaultDocumentation.Api.IWriter)') | Initializes a new instance of the [OverrideWriter](OverrideWriter.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter') type. | - -| Properties | | -| :--- | :--- | -| [Context](OverrideWriter.Context.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter.Context') | Gets the [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. | -| [DocItem](OverrideWriter.DocItem.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter.DocItem') | Gets the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which the documentation is being generated. | -| [Length](OverrideWriter.Length.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter.Length') | Gets or sets the length of the documentation text currently produced. | -| [this[string]](OverrideWriter.this[string].md 'DefaultDocumentation.Markdown.Writers.OverrideWriter.this[string]') | Gets or sets extra data for the current [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') documentation generation. | - -| Methods | | -| :--- | :--- | -| [Append(string)](OverrideWriter.Append(string).md 'DefaultDocumentation.Markdown.Writers.OverrideWriter.Append(string)') | Appends a string at the end of the documentation text. | -| [AppendLine()](OverrideWriter.AppendLine().md 'DefaultDocumentation.Markdown.Writers.OverrideWriter.AppendLine()') | Appends a [System.Environment.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System.Environment.NewLine') at the end of the documentation text. | -| [EndsWith(string)](OverrideWriter.EndsWith(string).md 'DefaultDocumentation.Markdown.Writers.OverrideWriter.EndsWith(string)') | Returns whether the documentation text ends with the given string. | diff --git a/documentation/markdown/OverrideWriter.this[string].md b/documentation/markdown/OverrideWriter.this[string].md deleted file mode 100644 index 9ec6655d..00000000 --- a/documentation/markdown/OverrideWriter.this[string].md +++ /dev/null @@ -1,22 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[OverrideWriter](OverrideWriter.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter') - -## OverrideWriter.this[string] Property - -Gets or sets extra data for the current [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') documentation generation. - -```csharp -public object? this[string key] { get; set; } -``` -#### Parameters - - - -`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The key of the data. - -Implements [this[string]](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.this[string].md 'DefaultDocumentation.Api.IWriter.Item(System.String)') - -#### Property Value -[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') \ No newline at end of file diff --git a/documentation/markdown/ParaElement.Name.md b/documentation/markdown/ParaElement.Name.md deleted file mode 100644 index bd625b04..00000000 --- a/documentation/markdown/ParaElement.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements').[ParaElement](ParaElement.md 'DefaultDocumentation.Markdown.Elements.ParaElement') - -## ParaElement.Name Property - -Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.Name.md 'DefaultDocumentation.Api.IElement.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/ParaElement.Write(IWriter,XElement).md b/documentation/markdown/ParaElement.Write(IWriter,XElement).md deleted file mode 100644 index e7623efc..00000000 --- a/documentation/markdown/ParaElement.Write(IWriter,XElement).md +++ /dev/null @@ -1,25 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements').[ParaElement](ParaElement.md 'DefaultDocumentation.Markdown.Elements.ParaElement') - -## ParaElement.Write(IWriter, XElement) Method - -Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - - - -`element` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') to write. - -Implements [Write(IWriter, XElement)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.Write(IWriter,XElement).md 'DefaultDocumentation.Api.IElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)') \ No newline at end of file diff --git a/documentation/markdown/ParaElement.md b/documentation/markdown/ParaElement.md deleted file mode 100644 index 3fa5b286..00000000 --- a/documentation/markdown/ParaElement.md +++ /dev/null @@ -1,23 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements') - -## ParaElement Class - -Handles `para` xml element. - -```csharp -public sealed class ParaElement : -DefaultDocumentation.Api.IElement -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ParaElement - -Implements [IElement](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.md 'DefaultDocumentation.Api.IElement') - -| Properties | | -| :--- | :--- | -| [Name](ParaElement.Name.md 'DefaultDocumentation.Markdown.Elements.ParaElement.Name') | Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter, XElement)](ParaElement.Write(IWriter,XElement).md 'DefaultDocumentation.Markdown.Elements.ParaElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)') | Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). | diff --git a/documentation/markdown/ParamRefElement.Name.md b/documentation/markdown/ParamRefElement.Name.md deleted file mode 100644 index 2bc5383a..00000000 --- a/documentation/markdown/ParamRefElement.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements').[ParamRefElement](ParamRefElement.md 'DefaultDocumentation.Markdown.Elements.ParamRefElement') - -## ParamRefElement.Name Property - -Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.Name.md 'DefaultDocumentation.Api.IElement.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/ParamRefElement.Write(IWriter,XElement).md b/documentation/markdown/ParamRefElement.Write(IWriter,XElement).md deleted file mode 100644 index 274cf263..00000000 --- a/documentation/markdown/ParamRefElement.Write(IWriter,XElement).md +++ /dev/null @@ -1,25 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements').[ParamRefElement](ParamRefElement.md 'DefaultDocumentation.Markdown.Elements.ParamRefElement') - -## ParamRefElement.Write(IWriter, XElement) Method - -Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - - - -`element` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') to write. - -Implements [Write(IWriter, XElement)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.Write(IWriter,XElement).md 'DefaultDocumentation.Api.IElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)') \ No newline at end of file diff --git a/documentation/markdown/ParamRefElement.md b/documentation/markdown/ParamRefElement.md deleted file mode 100644 index 9a861f2c..00000000 --- a/documentation/markdown/ParamRefElement.md +++ /dev/null @@ -1,23 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements') - -## ParamRefElement Class - -Handles `paramref` xml element. - -```csharp -public sealed class ParamRefElement : -DefaultDocumentation.Api.IElement -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ParamRefElement - -Implements [IElement](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.md 'DefaultDocumentation.Api.IElement') - -| Properties | | -| :--- | :--- | -| [Name](ParamRefElement.Name.md 'DefaultDocumentation.Markdown.Elements.ParamRefElement.Name') | Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter, XElement)](ParamRefElement.Write(IWriter,XElement).md 'DefaultDocumentation.Markdown.Elements.ParamRefElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)') | Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). | diff --git a/documentation/markdown/ParametersSection.ConfigName.md b/documentation/markdown/ParametersSection.ConfigName.md deleted file mode 100644 index 62239d32..00000000 --- a/documentation/markdown/ParametersSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ParametersSection](ParametersSection.md 'DefaultDocumentation.Markdown.Sections.ParametersSection') - -## ParametersSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Parameters; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/ParametersSection.GetChildren(IGeneralContext,DocItem).md b/documentation/markdown/ParametersSection.GetChildren(IGeneralContext,DocItem).md deleted file mode 100644 index 6168df29..00000000 --- a/documentation/markdown/ParametersSection.GetChildren(IGeneralContext,DocItem).md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ParametersSection](ParametersSection.md 'DefaultDocumentation.Markdown.Sections.ParametersSection') - -## ParametersSection.GetChildren(IGeneralContext, DocItem) Method - -Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') to write. - -```csharp -protected override System.Collections.Generic.IEnumerable? GetChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); -``` -#### Parameters - - - -`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - - - -`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which to write its children. - -#### Returns -[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[ParameterDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') -The children to write. \ No newline at end of file diff --git a/documentation/markdown/ParametersSection.ParametersSection().md b/documentation/markdown/ParametersSection.ParametersSection().md deleted file mode 100644 index ceaacf86..00000000 --- a/documentation/markdown/ParametersSection.ParametersSection().md +++ /dev/null @@ -1,10 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ParametersSection](ParametersSection.md 'DefaultDocumentation.Markdown.Sections.ParametersSection') - -## ParametersSection() Constructor - -Initialize a new instance of the [ParametersSection](ParametersSection.md 'DefaultDocumentation.Markdown.Sections.ParametersSection') type. - -```csharp -public ParametersSection(); -``` \ No newline at end of file diff --git a/documentation/markdown/ParametersSection.md b/documentation/markdown/ParametersSection.md deleted file mode 100644 index 414df878..00000000 --- a/documentation/markdown/ParametersSection.md +++ /dev/null @@ -1,24 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## ParametersSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [ParameterDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class ParametersSection : DefaultDocumentation.Markdown.Sections.ChildrenSection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DefaultDocumentation.Markdown.Sections.ChildrenSection<](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection')[ParameterDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem')[>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') 🡒 ParametersSection - -| Constructors | | -| :--- | :--- | -| [ParametersSection()](ParametersSection.ParametersSection().md 'DefaultDocumentation.Markdown.Sections.ParametersSection.ParametersSection()') | Initialize a new instance of the [ParametersSection](ParametersSection.md 'DefaultDocumentation.Markdown.Sections.ParametersSection') type. | - -| Fields | | -| :--- | :--- | -| [ConfigName](ParametersSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.ParametersSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Methods | | -| :--- | :--- | -| [GetChildren(IGeneralContext, DocItem)](ParametersSection.GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.Sections.ParametersSection.GetChildren(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)') | Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') to write. | diff --git a/documentation/markdown/PrefixedWriter.Append(string).md b/documentation/markdown/PrefixedWriter.Append(string).md deleted file mode 100644 index 149b6adf..00000000 --- a/documentation/markdown/PrefixedWriter.Append(string).md +++ /dev/null @@ -1,21 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[PrefixedWriter](PrefixedWriter.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter') - -## PrefixedWriter.Append(string) Method - -Appends a string at the end of the documentation text. - -```csharp -public DefaultDocumentation.Api.IWriter Append(string value); -``` -#### Parameters - - - -`value` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -Implements [Append(string)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.Append(string).md 'DefaultDocumentation.Api.IWriter.Append(System.String)') - -#### Returns -[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') -The current [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/markdown/PrefixedWriter.AppendLine().md b/documentation/markdown/PrefixedWriter.AppendLine().md deleted file mode 100644 index c39c550e..00000000 --- a/documentation/markdown/PrefixedWriter.AppendLine().md +++ /dev/null @@ -1,16 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[PrefixedWriter](PrefixedWriter.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter') - -## PrefixedWriter.AppendLine() Method - -Appends a [System.Environment.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System.Environment.NewLine') at the end of the documentation text. - -```csharp -public DefaultDocumentation.Api.IWriter AppendLine(); -``` - -Implements [AppendLine()](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.AppendLine().md 'DefaultDocumentation.Api.IWriter.AppendLine') - -#### Returns -[IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') -The current [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). \ No newline at end of file diff --git a/documentation/markdown/PrefixedWriter.Context.md b/documentation/markdown/PrefixedWriter.Context.md deleted file mode 100644 index a1f7f065..00000000 --- a/documentation/markdown/PrefixedWriter.Context.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[PrefixedWriter](PrefixedWriter.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter') - -## PrefixedWriter.Context Property - -Gets the [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - -```csharp -public DefaultDocumentation.IGeneralContext Context { get; } -``` - -Implements [Context](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.Context.md 'DefaultDocumentation.Api.IWriter.Context') - -#### Property Value -[IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') \ No newline at end of file diff --git a/documentation/markdown/PrefixedWriter.DocItem.md b/documentation/markdown/PrefixedWriter.DocItem.md deleted file mode 100644 index b7cd98e1..00000000 --- a/documentation/markdown/PrefixedWriter.DocItem.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[PrefixedWriter](PrefixedWriter.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter') - -## PrefixedWriter.DocItem Property - -Gets the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which the documentation is being generated. - -```csharp -public DefaultDocumentation.Models.DocItem DocItem { get; } -``` - -Implements [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.DocItem.md 'DefaultDocumentation.Api.IWriter.DocItem') - -#### Property Value -[DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') \ No newline at end of file diff --git a/documentation/markdown/PrefixedWriter.EndsWith(string).md b/documentation/markdown/PrefixedWriter.EndsWith(string).md deleted file mode 100644 index 8e8e72f0..00000000 --- a/documentation/markdown/PrefixedWriter.EndsWith(string).md +++ /dev/null @@ -1,23 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[PrefixedWriter](PrefixedWriter.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter') - -## PrefixedWriter.EndsWith(string) Method - -Returns whether the documentation text ends with the given string. - -```csharp -public bool EndsWith(string value); -``` -#### Parameters - - - -`value` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') to check. - -Implements [EndsWith(string)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.EndsWith(string).md 'DefaultDocumentation.Api.IWriter.EndsWith(System.String)') - -#### Returns -[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') -[true](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool') if the documentation text ends with [value](PrefixedWriter.EndsWith(string).md#DefaultDocumentation.Markdown.Writers.PrefixedWriter.EndsWith(string).value 'DefaultDocumentation.Markdown.Writers.PrefixedWriter.EndsWith(string).value'), else [false](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/bool'). \ No newline at end of file diff --git a/documentation/markdown/PrefixedWriter.Length.md b/documentation/markdown/PrefixedWriter.Length.md deleted file mode 100644 index e8bb6967..00000000 --- a/documentation/markdown/PrefixedWriter.Length.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[PrefixedWriter](PrefixedWriter.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter') - -## PrefixedWriter.Length Property - -Gets or sets the length of the documentation text currently produced. - -```csharp -public int Length { get; set; } -``` - -Implements [Length](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.Length.md 'DefaultDocumentation.Api.IWriter.Length') - -#### Property Value -[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') \ No newline at end of file diff --git a/documentation/markdown/PrefixedWriter.PrefixedWriter(IWriter,string).md b/documentation/markdown/PrefixedWriter.PrefixedWriter(IWriter,string).md deleted file mode 100644 index a9d636b1..00000000 --- a/documentation/markdown/PrefixedWriter.PrefixedWriter(IWriter,string).md +++ /dev/null @@ -1,23 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[PrefixedWriter](PrefixedWriter.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter') - -## PrefixedWriter(IWriter, string) Constructor - -Initializes a new instance of the [PrefixedWriter](PrefixedWriter.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter') type. - -```csharp -public PrefixedWriter(DefaultDocumentation.Api.IWriter writer, string prefix); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') instance to decorate. - - - -`prefix` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The prefix to use at every new line start. \ No newline at end of file diff --git a/documentation/markdown/PrefixedWriter.md b/documentation/markdown/PrefixedWriter.md deleted file mode 100644 index b88e17b5..00000000 --- a/documentation/markdown/PrefixedWriter.md +++ /dev/null @@ -1,32 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers') - -## PrefixedWriter Class - -Decorator of the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') type to prefix every new line with a specific [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String'). - -```csharp -public sealed class PrefixedWriter : -DefaultDocumentation.Api.IWriter -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 PrefixedWriter - -Implements [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -| Constructors | | -| :--- | :--- | -| [PrefixedWriter(IWriter, string)](PrefixedWriter.PrefixedWriter(IWriter,string).md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter.PrefixedWriter(DefaultDocumentation.Api.IWriter, string)') | Initializes a new instance of the [PrefixedWriter](PrefixedWriter.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter') type. | - -| Properties | | -| :--- | :--- | -| [Context](PrefixedWriter.Context.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter.Context') | Gets the [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. | -| [DocItem](PrefixedWriter.DocItem.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter.DocItem') | Gets the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which the documentation is being generated. | -| [Length](PrefixedWriter.Length.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter.Length') | Gets or sets the length of the documentation text currently produced. | -| [this[string]](PrefixedWriter.this[string].md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter.this[string]') | Gets or sets extra data for the current [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') documentation generation. | - -| Methods | | -| :--- | :--- | -| [Append(string)](PrefixedWriter.Append(string).md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter.Append(string)') | Appends a string at the end of the documentation text. | -| [AppendLine()](PrefixedWriter.AppendLine().md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter.AppendLine()') | Appends a [System.Environment.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System.Environment.NewLine') at the end of the documentation text. | -| [EndsWith(string)](PrefixedWriter.EndsWith(string).md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter.EndsWith(string)') | Returns whether the documentation text ends with the given string. | diff --git a/documentation/markdown/PrefixedWriter.this[string].md b/documentation/markdown/PrefixedWriter.this[string].md deleted file mode 100644 index 7a3b8131..00000000 --- a/documentation/markdown/PrefixedWriter.this[string].md +++ /dev/null @@ -1,22 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Writers](index.md#DefaultDocumentation.Markdown.Writers 'DefaultDocumentation.Markdown.Writers').[PrefixedWriter](PrefixedWriter.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter') - -## PrefixedWriter.this[string] Property - -Gets or sets extra data for the current [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') documentation generation. - -```csharp -public object? this[string key] { get; set; } -``` -#### Parameters - - - -`key` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') - -The key of the data. - -Implements [this[string]](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.this[string].md 'DefaultDocumentation.Api.IWriter.Item(System.String)') - -#### Property Value -[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') \ No newline at end of file diff --git a/documentation/markdown/PropertiesSection.ConfigName.md b/documentation/markdown/PropertiesSection.ConfigName.md deleted file mode 100644 index 29b60902..00000000 --- a/documentation/markdown/PropertiesSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[PropertiesSection](PropertiesSection.md 'DefaultDocumentation.Markdown.Sections.PropertiesSection') - -## PropertiesSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Properties; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/PropertiesSection.PropertiesSection().md b/documentation/markdown/PropertiesSection.PropertiesSection().md deleted file mode 100644 index d9cb1e21..00000000 --- a/documentation/markdown/PropertiesSection.PropertiesSection().md +++ /dev/null @@ -1,10 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[PropertiesSection](PropertiesSection.md 'DefaultDocumentation.Markdown.Sections.PropertiesSection') - -## PropertiesSection() Constructor - -Initialize a new instance of the [PropertiesSection](PropertiesSection.md 'DefaultDocumentation.Markdown.Sections.PropertiesSection') type. - -```csharp -public PropertiesSection(); -``` \ No newline at end of file diff --git a/documentation/markdown/PropertiesSection.md b/documentation/markdown/PropertiesSection.md deleted file mode 100644 index 3b02a406..00000000 --- a/documentation/markdown/PropertiesSection.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## PropertiesSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [PropertyDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/PropertyDocItem.md 'DefaultDocumentation.Models.Members.PropertyDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class PropertiesSection : DefaultDocumentation.Markdown.Sections.ChildrenSection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DefaultDocumentation.Markdown.Sections.ChildrenSection<](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection')[PropertyDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/PropertyDocItem.md 'DefaultDocumentation.Models.Members.PropertyDocItem')[>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') 🡒 PropertiesSection - -| Constructors | | -| :--- | :--- | -| [PropertiesSection()](PropertiesSection.PropertiesSection().md 'DefaultDocumentation.Markdown.Sections.PropertiesSection.PropertiesSection()') | Initialize a new instance of the [PropertiesSection](PropertiesSection.md 'DefaultDocumentation.Markdown.Sections.PropertiesSection') type. | - -| Fields | | -| :--- | :--- | -| [ConfigName](PropertiesSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.PropertiesSection.ConfigName') | The name of this implementation used at the configuration level. | diff --git a/documentation/markdown/RemarksSection.ConfigName.md b/documentation/markdown/RemarksSection.ConfigName.md deleted file mode 100644 index bde9bb20..00000000 --- a/documentation/markdown/RemarksSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[RemarksSection](RemarksSection.md 'DefaultDocumentation.Markdown.Sections.RemarksSection') - -## RemarksSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = remarks; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/RemarksSection.Name.md b/documentation/markdown/RemarksSection.Name.md deleted file mode 100644 index 21e1fb09..00000000 --- a/documentation/markdown/RemarksSection.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[RemarksSection](RemarksSection.md 'DefaultDocumentation.Markdown.Sections.RemarksSection') - -## RemarksSection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/RemarksSection.Write(IWriter).md b/documentation/markdown/RemarksSection.Write(IWriter).md deleted file mode 100644 index 862f6548..00000000 --- a/documentation/markdown/RemarksSection.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[RemarksSection](RemarksSection.md 'DefaultDocumentation.Markdown.Sections.RemarksSection') - -## RemarksSection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/RemarksSection.md b/documentation/markdown/RemarksSection.md deleted file mode 100644 index 6d882cf2..00000000 --- a/documentation/markdown/RemarksSection.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## RemarksSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the `remarks` top level element. - -```csharp -public sealed class RemarksSection : -DefaultDocumentation.Api.ISection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 RemarksSection - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Fields | | -| :--- | :--- | -| [ConfigName](RemarksSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.RemarksSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](RemarksSection.Name.md 'DefaultDocumentation.Markdown.Sections.RemarksSection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](RemarksSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.RemarksSection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/ReturnsSection.ConfigName.md b/documentation/markdown/ReturnsSection.ConfigName.md deleted file mode 100644 index 3eb840f7..00000000 --- a/documentation/markdown/ReturnsSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ReturnsSection](ReturnsSection.md 'DefaultDocumentation.Markdown.Sections.ReturnsSection') - -## ReturnsSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = returns; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/ReturnsSection.Name.md b/documentation/markdown/ReturnsSection.Name.md deleted file mode 100644 index 11d6a819..00000000 --- a/documentation/markdown/ReturnsSection.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ReturnsSection](ReturnsSection.md 'DefaultDocumentation.Markdown.Sections.ReturnsSection') - -## ReturnsSection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/ReturnsSection.Write(IWriter).md b/documentation/markdown/ReturnsSection.Write(IWriter).md deleted file mode 100644 index d59b89f3..00000000 --- a/documentation/markdown/ReturnsSection.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ReturnsSection](ReturnsSection.md 'DefaultDocumentation.Markdown.Sections.ReturnsSection') - -## ReturnsSection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/ReturnsSection.md b/documentation/markdown/ReturnsSection.md deleted file mode 100644 index e3f16072..00000000 --- a/documentation/markdown/ReturnsSection.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## ReturnsSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the `returns` top level element. - -```csharp -public sealed class ReturnsSection : -DefaultDocumentation.Api.ISection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ReturnsSection - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Fields | | -| :--- | :--- | -| [ConfigName](ReturnsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.ReturnsSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](ReturnsSection.Name.md 'DefaultDocumentation.Markdown.Sections.ReturnsSection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](ReturnsSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.ReturnsSection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/SeeAlsoSection.ConfigName.md b/documentation/markdown/SeeAlsoSection.ConfigName.md deleted file mode 100644 index f4af9adc..00000000 --- a/documentation/markdown/SeeAlsoSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[SeeAlsoSection](SeeAlsoSection.md 'DefaultDocumentation.Markdown.Sections.SeeAlsoSection') - -## SeeAlsoSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = seealso; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/SeeAlsoSection.Name.md b/documentation/markdown/SeeAlsoSection.Name.md deleted file mode 100644 index 454ab613..00000000 --- a/documentation/markdown/SeeAlsoSection.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[SeeAlsoSection](SeeAlsoSection.md 'DefaultDocumentation.Markdown.Sections.SeeAlsoSection') - -## SeeAlsoSection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/SeeAlsoSection.Write(IWriter).md b/documentation/markdown/SeeAlsoSection.Write(IWriter).md deleted file mode 100644 index cec96876..00000000 --- a/documentation/markdown/SeeAlsoSection.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[SeeAlsoSection](SeeAlsoSection.md 'DefaultDocumentation.Markdown.Sections.SeeAlsoSection') - -## SeeAlsoSection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/SeeAlsoSection.md b/documentation/markdown/SeeAlsoSection.md deleted file mode 100644 index ff3806db..00000000 --- a/documentation/markdown/SeeAlsoSection.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## SeeAlsoSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the `seealso` top level elements. - -```csharp -public sealed class SeeAlsoSection : -DefaultDocumentation.Api.ISection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 SeeAlsoSection - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Fields | | -| :--- | :--- | -| [ConfigName](SeeAlsoSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.SeeAlsoSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](SeeAlsoSection.Name.md 'DefaultDocumentation.Markdown.Sections.SeeAlsoSection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](SeeAlsoSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.SeeAlsoSection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/SeeElement.Name.md b/documentation/markdown/SeeElement.Name.md deleted file mode 100644 index 7fa8606f..00000000 --- a/documentation/markdown/SeeElement.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements').[SeeElement](SeeElement.md 'DefaultDocumentation.Markdown.Elements.SeeElement') - -## SeeElement.Name Property - -Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.Name.md 'DefaultDocumentation.Api.IElement.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/SeeElement.Write(IWriter,XElement).md b/documentation/markdown/SeeElement.Write(IWriter,XElement).md deleted file mode 100644 index bd16745e..00000000 --- a/documentation/markdown/SeeElement.Write(IWriter,XElement).md +++ /dev/null @@ -1,25 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements').[SeeElement](SeeElement.md 'DefaultDocumentation.Markdown.Elements.SeeElement') - -## SeeElement.Write(IWriter, XElement) Method - -Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - - - -`element` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') to write. - -Implements [Write(IWriter, XElement)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.Write(IWriter,XElement).md 'DefaultDocumentation.Api.IElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)') \ No newline at end of file diff --git a/documentation/markdown/SeeElement.md b/documentation/markdown/SeeElement.md deleted file mode 100644 index add18a4e..00000000 --- a/documentation/markdown/SeeElement.md +++ /dev/null @@ -1,23 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements') - -## SeeElement Class - -Handles `see` xml element. - -```csharp -public sealed class SeeElement : -DefaultDocumentation.Api.IElement -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 SeeElement - -Implements [IElement](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.md 'DefaultDocumentation.Api.IElement') - -| Properties | | -| :--- | :--- | -| [Name](SeeElement.Name.md 'DefaultDocumentation.Markdown.Elements.SeeElement.Name') | Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter, XElement)](SeeElement.Write(IWriter,XElement).md 'DefaultDocumentation.Markdown.Elements.SeeElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)') | Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). | diff --git a/documentation/markdown/StructsSection.ConfigName.md b/documentation/markdown/StructsSection.ConfigName.md deleted file mode 100644 index ccdf8319..00000000 --- a/documentation/markdown/StructsSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[StructsSection](StructsSection.md 'DefaultDocumentation.Markdown.Sections.StructsSection') - -## StructsSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Structs; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/StructsSection.StructsSection().md b/documentation/markdown/StructsSection.StructsSection().md deleted file mode 100644 index 820d086f..00000000 --- a/documentation/markdown/StructsSection.StructsSection().md +++ /dev/null @@ -1,10 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[StructsSection](StructsSection.md 'DefaultDocumentation.Markdown.Sections.StructsSection') - -## StructsSection() Constructor - -Initialize a new instance of the [StructsSection](StructsSection.md 'DefaultDocumentation.Markdown.Sections.StructsSection') type. - -```csharp -public StructsSection(); -``` \ No newline at end of file diff --git a/documentation/markdown/StructsSection.md b/documentation/markdown/StructsSection.md deleted file mode 100644 index cbaee6ce..00000000 --- a/documentation/markdown/StructsSection.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## StructsSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [StructDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/StructDocItem.md 'DefaultDocumentation.Models.Types.StructDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class StructsSection : DefaultDocumentation.Markdown.Sections.ChildrenSection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DefaultDocumentation.Markdown.Sections.ChildrenSection<](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection')[StructDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/StructDocItem.md 'DefaultDocumentation.Models.Types.StructDocItem')[>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') 🡒 StructsSection - -| Constructors | | -| :--- | :--- | -| [StructsSection()](StructsSection.StructsSection().md 'DefaultDocumentation.Markdown.Sections.StructsSection.StructsSection()') | Initialize a new instance of the [StructsSection](StructsSection.md 'DefaultDocumentation.Markdown.Sections.StructsSection') type. | - -| Fields | | -| :--- | :--- | -| [ConfigName](StructsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.StructsSection.ConfigName') | The name of this implementation used at the configuration level. | diff --git a/documentation/markdown/SummarySection.ConfigName.md b/documentation/markdown/SummarySection.ConfigName.md deleted file mode 100644 index 4bb55ae9..00000000 --- a/documentation/markdown/SummarySection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[SummarySection](SummarySection.md 'DefaultDocumentation.Markdown.Sections.SummarySection') - -## SummarySection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = summary; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/SummarySection.Name.md b/documentation/markdown/SummarySection.Name.md deleted file mode 100644 index 7cb11f6f..00000000 --- a/documentation/markdown/SummarySection.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[SummarySection](SummarySection.md 'DefaultDocumentation.Markdown.Sections.SummarySection') - -## SummarySection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/SummarySection.Write(IWriter).md b/documentation/markdown/SummarySection.Write(IWriter).md deleted file mode 100644 index d1e8da28..00000000 --- a/documentation/markdown/SummarySection.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[SummarySection](SummarySection.md 'DefaultDocumentation.Markdown.Sections.SummarySection') - -## SummarySection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/SummarySection.md b/documentation/markdown/SummarySection.md deleted file mode 100644 index 32ae4626..00000000 --- a/documentation/markdown/SummarySection.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## SummarySection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the `summary` top level element. - -```csharp -public sealed class SummarySection : -DefaultDocumentation.Api.ISection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 SummarySection - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Fields | | -| :--- | :--- | -| [ConfigName](SummarySection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.SummarySection.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](SummarySection.Name.md 'DefaultDocumentation.Markdown.Sections.SummarySection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](SummarySection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.SummarySection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/TableOfContentsSection.ConfigName.md b/documentation/markdown/TableOfContentsSection.ConfigName.md deleted file mode 100644 index edf9087a..00000000 --- a/documentation/markdown/TableOfContentsSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[TableOfContentsSection](TableOfContentsSection.md 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection') - -## TableOfContentsSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = TableOfContents; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/TableOfContentsSection.Modes.md b/documentation/markdown/TableOfContentsSection.Modes.md deleted file mode 100644 index 87488935..00000000 --- a/documentation/markdown/TableOfContentsSection.Modes.md +++ /dev/null @@ -1,47 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[TableOfContentsSection](TableOfContentsSection.md 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection') - -## TableOfContentsSection.Modes Enum - -The different options to customize the table of contents. - -```csharp -public enum TableOfContentsSection.Modes -``` -### Fields - - - -`Grouped` 1 - -[DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') will appear in their kind section. - - - -`IncludeKind` 2 - -The kind of each [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') will appear explicitely. - - - -`IncludeNewLine` 8 - -There should be a new line when displaying the summary of the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - - -`IncludeSummary` 4 - -The summary of each [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') will be displayed. - - - -`IncludeSummaryWithNewLine` 12 - -Same as [IncludeSummary](TableOfContentsSection.Modes.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummary 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummary') and [IncludeNewLine](TableOfContentsSection.Modes.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeNewLine 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeNewLine') - - - -`None` 0 - -Default generation. \ No newline at end of file diff --git a/documentation/markdown/TableOfContentsSection.Name.md b/documentation/markdown/TableOfContentsSection.Name.md deleted file mode 100644 index 6f14f6cd..00000000 --- a/documentation/markdown/TableOfContentsSection.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[TableOfContentsSection](TableOfContentsSection.md 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection') - -## TableOfContentsSection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/TableOfContentsSection.Write(IWriter).md b/documentation/markdown/TableOfContentsSection.Write(IWriter).md deleted file mode 100644 index 607d1082..00000000 --- a/documentation/markdown/TableOfContentsSection.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[TableOfContentsSection](TableOfContentsSection.md 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection') - -## TableOfContentsSection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/TableOfContentsSection.md b/documentation/markdown/TableOfContentsSection.md deleted file mode 100644 index c74ac204..00000000 --- a/documentation/markdown/TableOfContentsSection.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## TableOfContentsSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write a table of content of all children of the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class TableOfContentsSection : -DefaultDocumentation.Api.ISection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TableOfContentsSection - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Fields | | -| :--- | :--- | -| [ConfigName](TableOfContentsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](TableOfContentsSection.Name.md 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](TableOfContentsSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/TitleSection.ConfigName.md b/documentation/markdown/TitleSection.ConfigName.md deleted file mode 100644 index ead34e65..00000000 --- a/documentation/markdown/TitleSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[TitleSection](TitleSection.md 'DefaultDocumentation.Markdown.Sections.TitleSection') - -## TitleSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = Title; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/TitleSection.Name.md b/documentation/markdown/TitleSection.Name.md deleted file mode 100644 index f7cdabc5..00000000 --- a/documentation/markdown/TitleSection.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[TitleSection](TitleSection.md 'DefaultDocumentation.Markdown.Sections.TitleSection') - -## TitleSection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/TitleSection.Write(IWriter).md b/documentation/markdown/TitleSection.Write(IWriter).md deleted file mode 100644 index 1f28d4ee..00000000 --- a/documentation/markdown/TitleSection.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[TitleSection](TitleSection.md 'DefaultDocumentation.Markdown.Sections.TitleSection') - -## TitleSection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/TitleSection.md b/documentation/markdown/TitleSection.md deleted file mode 100644 index cf6eb6fa..00000000 --- a/documentation/markdown/TitleSection.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## TitleSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write a title of the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class TitleSection : -DefaultDocumentation.Api.ISection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TitleSection - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Fields | | -| :--- | :--- | -| [ConfigName](TitleSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.TitleSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](TitleSection.Name.md 'DefaultDocumentation.Markdown.Sections.TitleSection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](TitleSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.TitleSection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/TypeParamRefElement.Name.md b/documentation/markdown/TypeParamRefElement.Name.md deleted file mode 100644 index 07e5ff29..00000000 --- a/documentation/markdown/TypeParamRefElement.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements').[TypeParamRefElement](TypeParamRefElement.md 'DefaultDocumentation.Markdown.Elements.TypeParamRefElement') - -## TypeParamRefElement.Name Property - -Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.Name.md 'DefaultDocumentation.Api.IElement.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/TypeParamRefElement.Write(IWriter,XElement).md b/documentation/markdown/TypeParamRefElement.Write(IWriter,XElement).md deleted file mode 100644 index e5b3cd30..00000000 --- a/documentation/markdown/TypeParamRefElement.Write(IWriter,XElement).md +++ /dev/null @@ -1,25 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements').[TypeParamRefElement](TypeParamRefElement.md 'DefaultDocumentation.Markdown.Elements.TypeParamRefElement') - -## TypeParamRefElement.Write(IWriter, XElement) Method - -Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer, System.Xml.Linq.XElement element); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - - - -`element` [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') - -The [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') to write. - -Implements [Write(IWriter, XElement)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.Write(IWriter,XElement).md 'DefaultDocumentation.Api.IElement.Write(DefaultDocumentation.Api.IWriter,System.Xml.Linq.XElement)') \ No newline at end of file diff --git a/documentation/markdown/TypeParamRefElement.md b/documentation/markdown/TypeParamRefElement.md deleted file mode 100644 index dda90dd4..00000000 --- a/documentation/markdown/TypeParamRefElement.md +++ /dev/null @@ -1,23 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Elements](index.md#DefaultDocumentation.Markdown.Elements 'DefaultDocumentation.Markdown.Elements') - -## TypeParamRefElement Class - -Handles `typeparamref` xml element. - -```csharp -public sealed class TypeParamRefElement : -DefaultDocumentation.Api.IElement -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 TypeParamRefElement - -Implements [IElement](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IElement.md 'DefaultDocumentation.Api.IElement') - -| Properties | | -| :--- | :--- | -| [Name](TypeParamRefElement.Name.md 'DefaultDocumentation.Markdown.Elements.TypeParamRefElement.Name') | Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter, XElement)](TypeParamRefElement.Write(IWriter,XElement).md 'DefaultDocumentation.Markdown.Elements.TypeParamRefElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)') | Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). | diff --git a/documentation/markdown/TypeParametersSection.ConfigName.md b/documentation/markdown/TypeParametersSection.ConfigName.md deleted file mode 100644 index 6afd13cb..00000000 --- a/documentation/markdown/TypeParametersSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[TypeParametersSection](TypeParametersSection.md 'DefaultDocumentation.Markdown.Sections.TypeParametersSection') - -## TypeParametersSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = TypeParameters; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/TypeParametersSection.GetChildren(IGeneralContext,DocItem).md b/documentation/markdown/TypeParametersSection.GetChildren(IGeneralContext,DocItem).md deleted file mode 100644 index 950f1086..00000000 --- a/documentation/markdown/TypeParametersSection.GetChildren(IGeneralContext,DocItem).md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[TypeParametersSection](TypeParametersSection.md 'DefaultDocumentation.Markdown.Sections.TypeParametersSection') - -## TypeParametersSection.GetChildren(IGeneralContext, DocItem) Method - -Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') to write. - -```csharp -protected override System.Collections.Generic.IEnumerable? GetChildren(DefaultDocumentation.IGeneralContext context, DefaultDocumentation.Models.DocItem item); -``` -#### Parameters - - - -`context` [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') - -The [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - - - -`item` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') - -The [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which to write its children. - -#### Returns -[System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[TypeParameterDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') -The children to write. \ No newline at end of file diff --git a/documentation/markdown/TypeParametersSection.TypeParametersSection().md b/documentation/markdown/TypeParametersSection.TypeParametersSection().md deleted file mode 100644 index 99334831..00000000 --- a/documentation/markdown/TypeParametersSection.TypeParametersSection().md +++ /dev/null @@ -1,10 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[TypeParametersSection](TypeParametersSection.md 'DefaultDocumentation.Markdown.Sections.TypeParametersSection') - -## TypeParametersSection() Constructor - -Initialize a new instance of the [TypeParametersSection](TypeParametersSection.md 'DefaultDocumentation.Markdown.Sections.TypeParametersSection') type. - -```csharp -public TypeParametersSection(); -``` \ No newline at end of file diff --git a/documentation/markdown/TypeParametersSection.md b/documentation/markdown/TypeParametersSection.md deleted file mode 100644 index 4951b968..00000000 --- a/documentation/markdown/TypeParametersSection.md +++ /dev/null @@ -1,24 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## TypeParametersSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [TypeParameterDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - -```csharp -public sealed class TypeParametersSection : DefaultDocumentation.Markdown.Sections.ChildrenSection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [DefaultDocumentation.Markdown.Sections.ChildrenSection<](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection')[TypeParameterDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem')[>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') 🡒 TypeParametersSection - -| Constructors | | -| :--- | :--- | -| [TypeParametersSection()](TypeParametersSection.TypeParametersSection().md 'DefaultDocumentation.Markdown.Sections.TypeParametersSection.TypeParametersSection()') | Initialize a new instance of the [TypeParametersSection](TypeParametersSection.md 'DefaultDocumentation.Markdown.Sections.TypeParametersSection') type. | - -| Fields | | -| :--- | :--- | -| [ConfigName](TypeParametersSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.TypeParametersSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Methods | | -| :--- | :--- | -| [GetChildren(IGeneralContext, DocItem)](TypeParametersSection.GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.Sections.TypeParametersSection.GetChildren(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)') | Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') to write. | diff --git a/documentation/markdown/ValueSection.ConfigName.md b/documentation/markdown/ValueSection.ConfigName.md deleted file mode 100644 index f735dc20..00000000 --- a/documentation/markdown/ValueSection.ConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ValueSection](ValueSection.md 'DefaultDocumentation.Markdown.Sections.ValueSection') - -## ValueSection.ConfigName Field - -The name of this implementation used at the configuration level. - -```csharp -public const string ConfigName = value; -``` - -#### Field Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/ValueSection.Name.md b/documentation/markdown/ValueSection.Name.md deleted file mode 100644 index 41e591fb..00000000 --- a/documentation/markdown/ValueSection.Name.md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ValueSection](ValueSection.md 'DefaultDocumentation.Markdown.Sections.ValueSection') - -## ValueSection.Name Property - -Gets the name of the section, used to identify it at the configuration level. - -```csharp -public string Name { get; } -``` - -Implements [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Name.md 'DefaultDocumentation.Api.ISection.Name') - -#### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file diff --git a/documentation/markdown/ValueSection.Write(IWriter).md b/documentation/markdown/ValueSection.Write(IWriter).md deleted file mode 100644 index ea0160d9..00000000 --- a/documentation/markdown/ValueSection.Write(IWriter).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections').[ValueSection](ValueSection.md 'DefaultDocumentation.Markdown.Sections.ValueSection') - -## ValueSection.Write(IWriter) Method - -Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - -```csharp -public void Write(DefaultDocumentation.Api.IWriter writer); -``` -#### Parameters - - - -`writer` [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') - -The [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') to write to. - -Implements [Write(IWriter)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.Write(IWriter).md 'DefaultDocumentation.Api.ISection.Write(DefaultDocumentation.Api.IWriter)') \ No newline at end of file diff --git a/documentation/markdown/ValueSection.md b/documentation/markdown/ValueSection.md deleted file mode 100644 index afdae861..00000000 --- a/documentation/markdown/ValueSection.md +++ /dev/null @@ -1,27 +0,0 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') -### [DefaultDocumentation.Markdown.Sections](index.md#DefaultDocumentation.Markdown.Sections 'DefaultDocumentation.Markdown.Sections') - -## ValueSection Class - -[ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the `value` top level element. - -```csharp -public sealed class ValueSection : -DefaultDocumentation.Api.ISection -``` - -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 ValueSection - -Implements [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') - -| Fields | | -| :--- | :--- | -| [ConfigName](ValueSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.ValueSection.ConfigName') | The name of this implementation used at the configuration level. | - -| Properties | | -| :--- | :--- | -| [Name](ValueSection.Name.md 'DefaultDocumentation.Markdown.Sections.ValueSection.Name') | Gets the name of the section, used to identify it at the configuration level. | - -| Methods | | -| :--- | :--- | -| [Write(IWriter)](ValueSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.ValueSection.Write(DefaultDocumentation.Api.IWriter)') | Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). | diff --git a/documentation/markdown/index.md b/documentation/markdown/index.md index e24639a9..fb82e44b 100644 --- a/documentation/markdown/index.md +++ b/documentation/markdown/index.md @@ -1,318 +1,357 @@ -#### [DefaultDocumentation.Markdown](index.md 'index') +#### [DefaultDocumentation\.Markdown](index.md 'index') -## DefaultDocumentation.Markdown Assembly +## DefaultDocumentation\.Markdown Assembly ### Namespaces ## DefaultDocumentation Namespace -- **[IGeneralContextExtension](IGeneralContextExtension.md 'DefaultDocumentation.IGeneralContextExtension')** `Class` Provides extension methods on the [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') type. - - **[GetChildren<T>(this IGeneralContext, DocItem)](IGeneralContextExtension.GetChildren_T_(thisIGeneralContext,DocItem).md 'DefaultDocumentation.IGeneralContextExtension.GetChildren(this DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)')** `Method` Gets the children of a specific [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') type of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') instance. - - **[GetInvalidCharReplacement(this IGeneralContext)](IGeneralContextExtension.GetInvalidCharReplacement(thisIGeneralContext).md 'DefaultDocumentation.IGeneralContextExtension.GetInvalidCharReplacement(this DefaultDocumentation.IGeneralContext)')** `Method` Gets the [Markdown.InvalidCharReplacement](https://github.com/Doraku/DefaultDocumentation#invalidcharreplacement 'https://github.com/Doraku/DefaultDocumentation#invalidcharreplacement') setting. - - **[GetNestedTypeVisibilities(this IGeneralContext, Type)](IGeneralContextExtension.GetNestedTypeVisibilities(thisIGeneralContext,Type).md 'DefaultDocumentation.IGeneralContextExtension.GetNestedTypeVisibilities(this DefaultDocumentation.IGeneralContext, System.Type)')** `Method` Gets the [Markdown.NestedTypeVisibilities](https://github.com/Doraku/DefaultDocumentation#nestedtypevisibilities 'https://github.com/Doraku/DefaultDocumentation#nestedtypevisibilities') setting. - - **[GetRemoveFileExtensionFromUrl(this IGeneralContext)](IGeneralContextExtension.GetRemoveFileExtensionFromUrl(thisIGeneralContext).md 'DefaultDocumentation.IGeneralContextExtension.GetRemoveFileExtensionFromUrl(this DefaultDocumentation.IGeneralContext)')** `Method` Gets the [Markdown.RemoveFileExtensionFromUrl](https://github.com/Doraku/DefaultDocumentation#removefileextensionfromurl 'https://github.com/Doraku/DefaultDocumentation#removefileextensionfromurl') setting. -- **[NestedTypeVisibilities](NestedTypeVisibilities.md 'DefaultDocumentation.NestedTypeVisibilities')** `Enum` Specifies where nested types should be displayed in the generated documentation. - - **[DeclaringType](NestedTypeVisibilities.md#DefaultDocumentation.NestedTypeVisibilities.DeclaringType 'DefaultDocumentation.NestedTypeVisibilities.DeclaringType')** `Field` Generates nested types in declaring type page. - - **[Default](NestedTypeVisibilities.md#DefaultDocumentation.NestedTypeVisibilities.Default 'DefaultDocumentation.NestedTypeVisibilities.Default')** `Field` Same as [Namespace](NestedTypeVisibilities.md#DefaultDocumentation.NestedTypeVisibilities.Namespace 'DefaultDocumentation.NestedTypeVisibilities.Namespace'). - - **[Namespace](NestedTypeVisibilities.md#DefaultDocumentation.NestedTypeVisibilities.Namespace 'DefaultDocumentation.NestedTypeVisibilities.Namespace')** `Field` Generates nested types in namespace page. +- **[IGeneralContextExtensions](DefaultDocumentation/IGeneralContextExtensions/index.md 'DefaultDocumentation\.IGeneralContextExtensions')** `Class` Provides extension methods on the [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/index.md 'DefaultDocumentation\.IGeneralContext') type\. + - **[GetChildren<T>\(this IGeneralContext, DocItem\)](DefaultDocumentation/IGeneralContextExtensions/GetChildren_T_(thisIGeneralContext,DocItem).md 'DefaultDocumentation\.IGeneralContextExtensions\.GetChildren\\(this DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the children of a specific [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') type of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') instance\. + - **[GetInvalidCharReplacement\(this IGeneralContext\)](DefaultDocumentation/IGeneralContextExtensions/GetInvalidCharReplacement(thisIGeneralContext).md 'DefaultDocumentation\.IGeneralContextExtensions\.GetInvalidCharReplacement\(this DefaultDocumentation\.IGeneralContext\)')** `Method` Gets the [Markdown\.InvalidCharReplacement](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_InvalidCharReplacement 'https://github\.com/Doraku/DefaultDocumentation\#MarkdownConfiguration\_InvalidCharReplacement') setting\. + - **[GetNestedTypeVisibilities\(this IGeneralContext, Type\)](DefaultDocumentation/IGeneralContextExtensions/GetNestedTypeVisibilities(thisIGeneralContext,Type).md 'DefaultDocumentation\.IGeneralContextExtensions\.GetNestedTypeVisibilities\(this DefaultDocumentation\.IGeneralContext, System\.Type\)')** `Method` Gets the [Markdown\.NestedTypeVisibilities](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_NestedTypeVisibilities 'https://github\.com/Doraku/DefaultDocumentation\#MarkdownConfiguration\_NestedTypeVisibilities') setting\. + - **[GetRemoveFileExtensionFromUrl\(this IGeneralContext\)](DefaultDocumentation/IGeneralContextExtensions/GetRemoveFileExtensionFromUrl(thisIGeneralContext).md 'DefaultDocumentation\.IGeneralContextExtensions\.GetRemoveFileExtensionFromUrl\(this DefaultDocumentation\.IGeneralContext\)')** `Method` Gets the [Markdown\.RemoveFileExtensionFromUrl](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_RemoveFileExtensionFromUrl 'https://github\.com/Doraku/DefaultDocumentation\#MarkdownConfiguration\_RemoveFileExtensionFromUrl') setting\. + - **[GetUseFullUrl\(this IGeneralContext\)](DefaultDocumentation/IGeneralContextExtensions/GetUseFullUrl(thisIGeneralContext).md 'DefaultDocumentation\.IGeneralContextExtensions\.GetUseFullUrl\(this DefaultDocumentation\.IGeneralContext\)')** `Method` Gets the [Markdown\.UseFullUrl](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_UseFullUrl 'https://github\.com/Doraku/DefaultDocumentation\#MarkdownConfiguration\_UseFullUrl') setting\. - + + +## DefaultDocumentation\.Api Namespace + +The [DefaultDocumentation\.Api](index.md#DefaultDocumentation.Api 'DefaultDocumentation\.Api') namespace contains interfaces that can be used to add custom features to the documentation generation\. +- **[IWriterExtensions](DefaultDocumentation/Api/IWriterExtensions/index.md 'DefaultDocumentation\.Api\.IWriterExtensions')** `Class` Provides extension methods on the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') type\. + - **[AppendAsMarkdown\(this IWriter, XElement\)](DefaultDocumentation/Api/IWriterExtensions/AppendAsMarkdown(thisIWriter,XElement).md 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendAsMarkdown\(this DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)')** `Method` Appends a [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') decorating the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') with a [MarkdownWriter](DefaultDocumentation/Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter')\. + - **[AppendAsRaw\(this IWriter\)](DefaultDocumentation/Api/IWriterExtensions/AppendAsRaw(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendAsRaw\(this DefaultDocumentation\.Api\.IWriter\)')** `Method` Append a string without sanitizing it for markdown regardless of the current [GetRenderAsRaw\(this IWriter\)](DefaultDocumentation/Api/IWriterExtensions/GetRenderAsRaw(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.GetRenderAsRaw\(this DefaultDocumentation\.Api\.IWriter\)') value\. + - **[AppendLink\(this IWriter, DocItem, INamedElement\)](DefaultDocumentation/Api/IWriterExtensions/AppendLink.md#DefaultDocumentation.Api.IWriterExtensions.AppendLink(thisDefaultDocumentation.Api.IWriter,DefaultDocumentation.Models.DocItem,INamedElement) 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendLink\(this DefaultDocumentation\.Api\.IWriter, DefaultDocumentation\.Models\.DocItem, INamedElement\)')** `Method` Append an link to an [ICSharpCode\.Decompiler\.TypeSystem\.INamedElement](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.TypeSystem.INamedElement 'ICSharpCode\.Decompiler\.TypeSystem\.INamedElement') in the markdown format\. + - **[AppendLink\(this IWriter, DocItem, string\)](DefaultDocumentation/Api/IWriterExtensions/AppendLink.md#DefaultDocumentation.Api.IWriterExtensions.AppendLink(thisDefaultDocumentation.Api.IWriter,DefaultDocumentation.Models.DocItem,string) 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendLink\(this DefaultDocumentation\.Api\.IWriter, DefaultDocumentation\.Models\.DocItem, string\)')** `Method` Append an link to a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') in the markdown format\. + - **[AppendLink\(this IWriter, string, string\)](DefaultDocumentation/Api/IWriterExtensions/AppendLink.md#DefaultDocumentation.Api.IWriterExtensions.AppendLink(thisDefaultDocumentation.Api.IWriter,string,string) 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendLink\(this DefaultDocumentation\.Api\.IWriter, string, string\)')** `Method` Append an link to an id using [UrlFactories](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IGeneralContext/UrlFactories.md 'DefaultDocumentation\.IGeneralContext\.UrlFactories') to resolve the url in the markdown format\. + - **[AppendUrl\(this IWriter, string, string, string\)](DefaultDocumentation/Api/IWriterExtensions/AppendUrl(thisIWriter,string,string,string).md 'DefaultDocumentation\.Api\.IWriterExtensions\.AppendUrl\(this DefaultDocumentation\.Api\.IWriter, string, string, string\)')** `Method` Append an url in the markdown format\. + - **[EnsureLineStart\(this IWriter\)](DefaultDocumentation/Api/IWriterExtensions/EnsureLineStart(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.EnsureLineStart\(this DefaultDocumentation\.Api\.IWriter\)')** `Method` Ensures that the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') ends with a line break and call [AppendLine\(\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/AppendLine().md 'DefaultDocumentation\.Api\.IWriter\.AppendLine') if it's not the case\. + - **[EnsureLineStartAndAppendLine\(this IWriter\)](DefaultDocumentation/Api/IWriterExtensions/EnsureLineStartAndAppendLine(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.EnsureLineStartAndAppendLine\(this DefaultDocumentation\.Api\.IWriter\)')** `Method` Calls [EnsureLineStart\(this IWriter\)](DefaultDocumentation/Api/IWriterExtensions/EnsureLineStart(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.EnsureLineStart\(this DefaultDocumentation\.Api\.IWriter\)') and [AppendLine\(\)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/AppendLine().md 'DefaultDocumentation\.Api\.IWriter\.AppendLine')\. + - **[GetCurrentItem\(this IWriter\)](DefaultDocumentation/Api/IWriterExtensions/GetCurrentItem(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.GetCurrentItem\(this DefaultDocumentation\.Api\.IWriter\)')** `Method` Gets the current item that is being processed by this [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. It can be different from the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/DocItem.md 'DefaultDocumentation\.IPageContext\.DocItem') when inlining child documentation in its parent page\. + - **[GetDisplayAsSingleLine\(this IWriter\)](DefaultDocumentation/Api/IWriterExtensions/GetDisplayAsSingleLine(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.GetDisplayAsSingleLine\(this DefaultDocumentation\.Api\.IWriter\)')** `Method` Gets whether all futur data appended to the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') should stay on the same line \(usefull for table\)\. This setting is used by the [MarkdownWriter](DefaultDocumentation/Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. + - **[GetHandleLineBreak\(this IWriter\)](DefaultDocumentation/Api/IWriterExtensions/GetHandleLineBreak(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.GetHandleLineBreak\(this DefaultDocumentation\.Api\.IWriter\)')** `Method` Gets whether line break in the xml documentation should be handled in the generated markdown\. This setting is used by the [MarkdownWriter](DefaultDocumentation/Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. + - **[GetRenderAsRaw\(this IWriter\)](DefaultDocumentation/Api/IWriterExtensions/GetRenderAsRaw(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.GetRenderAsRaw\(this DefaultDocumentation\.Api\.IWriter\)')** `Method` Gets whether the writer should append the next strings as is without sanitizing it\. This setting is used by the [MarkdownWriter](DefaultDocumentation/Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. + - **[GetUrlFormat\(this IWriter\)](DefaultDocumentation/Api/IWriterExtensions/GetUrlFormat(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.GetUrlFormat\(this DefaultDocumentation\.Api\.IWriter\)')** `Method` Gets the format that will be used to display urls\. + - **[SetCurrentItem\(this IWriter, DocItem\)](DefaultDocumentation/Api/IWriterExtensions/SetCurrentItem(thisIWriter,DocItem).md 'DefaultDocumentation\.Api\.IWriterExtensions\.SetCurrentItem\(this DefaultDocumentation\.Api\.IWriter, DefaultDocumentation\.Models\.DocItem\)')** `Method` Sets the current item that is being processed by this [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. It can be different from the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/DocItem.md 'DefaultDocumentation\.IPageContext\.DocItem') when inlining child documentation in its parent page\. + - **[SetDisplayAsSingleLine\(this IWriter, Nullable<bool>\)](DefaultDocumentation/Api/IWriterExtensions/SetDisplayAsSingleLine(thisIWriter,Nullable_bool_).md 'DefaultDocumentation\.Api\.IWriterExtensions\.SetDisplayAsSingleLine\(this DefaultDocumentation\.Api\.IWriter, System\.Nullable\\)')** `Method` Sets whether all futur data appended to the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') should stay on the same line \(usefull for table\)\. This setting is used by the [MarkdownWriter](DefaultDocumentation/Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. + - **[SetHandleLineBreak\(this IWriter, Nullable<bool>\)](DefaultDocumentation/Api/IWriterExtensions/SetHandleLineBreak(thisIWriter,Nullable_bool_).md 'DefaultDocumentation\.Api\.IWriterExtensions\.SetHandleLineBreak\(this DefaultDocumentation\.Api\.IWriter, System\.Nullable\\)')** `Method` Sets whether line break in the xml documentation should be handled in the generated markdown\. This setting is used by the [MarkdownWriter](DefaultDocumentation/Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. + - **[SetRenderAsRaw\(this IWriter, Nullable<bool>\)](DefaultDocumentation/Api/IWriterExtensions/SetRenderAsRaw(thisIWriter,Nullable_bool_).md 'DefaultDocumentation\.Api\.IWriterExtensions\.SetRenderAsRaw\(this DefaultDocumentation\.Api\.IWriter, System\.Nullable\\)')** `Method` Sets whether the writer should append the next strings as is without sanitizing it\. This setting is used by the [MarkdownWriter](DefaultDocumentation/Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. + - **[SetUrlFormat\(this IWriter, string\)](DefaultDocumentation/Api/IWriterExtensions/SetUrlFormat(thisIWriter,string).md 'DefaultDocumentation\.Api\.IWriterExtensions\.SetUrlFormat\(this DefaultDocumentation\.Api\.IWriter, string\)')** `Method` Sets the format that will be used to display url\. + - **[ToOverrideWriter\(this IWriter\)](DefaultDocumentation/Api/IWriterExtensions/ToOverrideWriter(thisIWriter).md 'DefaultDocumentation\.Api\.IWriterExtensions\.ToOverrideWriter\(this DefaultDocumentation\.Api\.IWriter\)')** `Method` Decorates the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') with a [OverrideWriter](DefaultDocumentation/Markdown/Writers/OverrideWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter') to override its setting in a given scope\. + - **[ToPrefixedWriter\(this IWriter, string\)](DefaultDocumentation/Api/IWriterExtensions/ToPrefixedWriter(thisIWriter,string).md 'DefaultDocumentation\.Api\.IWriterExtensions\.ToPrefixedWriter\(this DefaultDocumentation\.Api\.IWriter, string\)')** `Method` Decorates the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') with a [PrefixedWriter](DefaultDocumentation/Markdown/Writers/PrefixedWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter') to prefix every new line with the given prefix\. + + + +## DefaultDocumentation\.Markdown Namespace +- **[NestedTypeVisibilities](DefaultDocumentation/Markdown/NestedTypeVisibilities/index.md 'DefaultDocumentation\.Markdown\.NestedTypeVisibilities')** `Enum` Specifies where nested types should be displayed in the generated documentation\. + - **[DeclaringType](DefaultDocumentation/Markdown/NestedTypeVisibilities/index.md#DefaultDocumentation.Markdown.NestedTypeVisibilities.DeclaringType 'DefaultDocumentation\.Markdown\.NestedTypeVisibilities\.DeclaringType')** `Field` Generates nested types in declaring type page\. + - **[Default](DefaultDocumentation/Markdown/NestedTypeVisibilities/index.md#DefaultDocumentation.Markdown.NestedTypeVisibilities.Default 'DefaultDocumentation\.Markdown\.NestedTypeVisibilities\.Default')** `Field` Same as [Namespace](DefaultDocumentation/Markdown/NestedTypeVisibilities/index.md#DefaultDocumentation.Markdown.NestedTypeVisibilities.Namespace 'DefaultDocumentation\.Markdown\.NestedTypeVisibilities\.Namespace')\. + - **[Namespace](DefaultDocumentation/Markdown/NestedTypeVisibilities/index.md#DefaultDocumentation.Markdown.NestedTypeVisibilities.Namespace 'DefaultDocumentation\.Markdown\.NestedTypeVisibilities\.Namespace')** `Field` Generates nested types in namespace page\. -## DefaultDocumentation.Markdown.Elements Namespace -- **[CElement](CElement.md 'DefaultDocumentation.Markdown.Elements.CElement')** `Class` Handles `c` xml element. - - **[Name](CElement.Name.md 'DefaultDocumentation.Markdown.Elements.CElement.Name')** `Property` Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. - - **[Write(IWriter, XElement)](CElement.Write(IWriter,XElement).md 'DefaultDocumentation.Markdown.Elements.CElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)')** `Method` Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). -- **[CodeElement](CodeElement.md 'DefaultDocumentation.Markdown.Elements.CodeElement')** `Class` Handles `code` xml element. - - **[Name](CodeElement.Name.md 'DefaultDocumentation.Markdown.Elements.CodeElement.Name')** `Property` Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. - - **[Write(IWriter, XElement)](CodeElement.Write(IWriter,XElement).md 'DefaultDocumentation.Markdown.Elements.CodeElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)')** `Method` Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). -- **[ListElement](ListElement.md 'DefaultDocumentation.Markdown.Elements.ListElement')** `Class` Handles `list` xml element. - - **[Name](ListElement.Name.md 'DefaultDocumentation.Markdown.Elements.ListElement.Name')** `Property` Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. - - **[Write(IWriter, XElement)](ListElement.Write(IWriter,XElement).md 'DefaultDocumentation.Markdown.Elements.ListElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)')** `Method` Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). -- **[NoteElement](NoteElement.md 'DefaultDocumentation.Markdown.Elements.NoteElement')** `Class` Handles `note` xml element. - - **[Name](NoteElement.Name.md 'DefaultDocumentation.Markdown.Elements.NoteElement.Name')** `Property` Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. - - **[Write(IWriter, XElement)](NoteElement.Write(IWriter,XElement).md 'DefaultDocumentation.Markdown.Elements.NoteElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)')** `Method` Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). -- **[ParaElement](ParaElement.md 'DefaultDocumentation.Markdown.Elements.ParaElement')** `Class` Handles `para` xml element. - - **[Name](ParaElement.Name.md 'DefaultDocumentation.Markdown.Elements.ParaElement.Name')** `Property` Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. - - **[Write(IWriter, XElement)](ParaElement.Write(IWriter,XElement).md 'DefaultDocumentation.Markdown.Elements.ParaElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)')** `Method` Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). -- **[ParamRefElement](ParamRefElement.md 'DefaultDocumentation.Markdown.Elements.ParamRefElement')** `Class` Handles `paramref` xml element. - - **[Name](ParamRefElement.Name.md 'DefaultDocumentation.Markdown.Elements.ParamRefElement.Name')** `Property` Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. - - **[Write(IWriter, XElement)](ParamRefElement.Write(IWriter,XElement).md 'DefaultDocumentation.Markdown.Elements.ParamRefElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)')** `Method` Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). -- **[SeeElement](SeeElement.md 'DefaultDocumentation.Markdown.Elements.SeeElement')** `Class` Handles `see` xml element. - - **[Name](SeeElement.Name.md 'DefaultDocumentation.Markdown.Elements.SeeElement.Name')** `Property` Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. - - **[Write(IWriter, XElement)](SeeElement.Write(IWriter,XElement).md 'DefaultDocumentation.Markdown.Elements.SeeElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)')** `Method` Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). -- **[TypeParamRefElement](TypeParamRefElement.md 'DefaultDocumentation.Markdown.Elements.TypeParamRefElement')** `Class` Handles `typeparamref` xml element. - - **[Name](TypeParamRefElement.Name.md 'DefaultDocumentation.Markdown.Elements.TypeParamRefElement.Name')** `Property` Gets the name of the [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') this type handle. - - **[Write(IWriter, XElement)](TypeParamRefElement.Write(IWriter,XElement).md 'DefaultDocumentation.Markdown.Elements.TypeParamRefElement.Write(DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)')** `Method` Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') the provided [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement'). + - +## DefaultDocumentation\.Markdown\.DocItemGenerators Namespace +- **[ExcludeGenerator](DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/index.md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.ExcludeGenerator')** `Class` Implementation of the [IDocItemGenerator](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/index.md 'DefaultDocumentation\.Api\.IDocItemGenerator') to remove [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') from the documentation generation based on [Markdown\.Exclude](https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_Exclude 'https://github\.com/Doraku/DefaultDocumentation\#MarkdownConfiguration\_Exclude')\. + - **[ConfigName](DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/ConfigName.md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.ExcludeGenerator\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/Name.md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.ExcludeGenerator\.Name')** `Property` Gets the name of the generator, used to identify it at the configuration level\. + - **[Generate\(IDocItemsContext\)](DefaultDocumentation/Markdown/DocItemGenerators/ExcludeGenerator/Generate(IDocItemsContext).md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.ExcludeGenerator\.Generate\(DefaultDocumentation\.IDocItemsContext\)')** `Method` Modified the known [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') of the [IDocItemsContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext')\. +- **[OverloadsGenerator](DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/index.md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.OverloadsGenerator')** `Class` Implementation of the [IDocItemGenerator](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IDocItemGenerator/index.md 'DefaultDocumentation\.Api\.IDocItemGenerator') to add [ConstructorOverloadsDocItem](DefaultDocumentation/Markdown/Models/ConstructorOverloadsDocItem/index.md 'DefaultDocumentation\.Markdown\.Models\.ConstructorOverloadsDocItem') and [MethodOverloadsDocItem](DefaultDocumentation/Markdown/Models/MethodOverloadsDocItem/index.md 'DefaultDocumentation\.Markdown\.Models\.MethodOverloadsDocItem') to the documentation generated\. + - **[ConfigName](DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/ConfigName.md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.OverloadsGenerator\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/Name.md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.OverloadsGenerator\.Name')** `Property` Gets the name of the generator, used to identify it at the configuration level\. + - **[Generate\(IDocItemsContext\)](DefaultDocumentation/Markdown/DocItemGenerators/OverloadsGenerator/Generate(IDocItemsContext).md 'DefaultDocumentation\.Markdown\.DocItemGenerators\.OverloadsGenerator\.Generate\(DefaultDocumentation\.IDocItemsContext\)')** `Method` Modified the known [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') of the [IDocItemsContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IDocItemsContext/index.md 'DefaultDocumentation\.IDocItemsContext')\. -## DefaultDocumentation.Markdown.Extensions Namespace -- **[IWriterExtension](IWriterExtension.md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension')** `Class` Provides extension methods on the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') type. - - **[AppendAsMarkdown(this IWriter, XElement)](IWriterExtension.AppendAsMarkdown(thisIWriter,XElement).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.AppendAsMarkdown(this DefaultDocumentation.Api.IWriter, System.Xml.Linq.XElement)')** `Method` Appends a [System.Xml.Linq.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System.Xml.Linq.XElement') decorating the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') with a [MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter'). - - **[AppendLink(this IWriter, DocItem, INamedElement)](IWriterExtension.AppendLink(thisIWriter,DocItem,INamedElement).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.AppendLink(this DefaultDocumentation.Api.IWriter, DefaultDocumentation.Models.DocItem, INamedElement)')** `Method` Append an link to an [ICSharpCode.Decompiler.TypeSystem.INamedElement](https://docs.microsoft.com/en-us/dotnet/api/ICSharpCode.Decompiler.TypeSystem.INamedElement 'ICSharpCode.Decompiler.TypeSystem.INamedElement') in the markdown format. - - **[AppendLink(this IWriter, DocItem, string)](IWriterExtension.AppendLink(thisIWriter,DocItem,string).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.AppendLink(this DefaultDocumentation.Api.IWriter, DefaultDocumentation.Models.DocItem, string)')** `Method` Append an link to a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') in the markdown format. - - **[AppendLink(this IWriter, string, string)](IWriterExtension.AppendLink(thisIWriter,string,string).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.AppendLink(this DefaultDocumentation.Api.IWriter, string, string)')** `Method` Append an link to an id using [GetUrl(string)](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.GetUrl(string).md 'DefaultDocumentation.IGeneralContext.GetUrl(System.String)') to resolve the url in the markdown format. - - **[AppendUrl(this IWriter, string, string, string)](IWriterExtension.AppendUrl(thisIWriter,string,string,string).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.AppendUrl(this DefaultDocumentation.Api.IWriter, string, string, string)')** `Method` Append an url in the markdown format. - - **[EnsureLineStart(this IWriter)](IWriterExtension.EnsureLineStart(thisIWriter).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.EnsureLineStart(this DefaultDocumentation.Api.IWriter)')** `Method` Ensures that the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') ends with a line break and call [AppendLine()](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.AppendLine().md 'DefaultDocumentation.Api.IWriter.AppendLine') if it's not the case. - - **[EnsureLineStartAndAppendLine(this IWriter)](IWriterExtension.EnsureLineStartAndAppendLine(thisIWriter).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.EnsureLineStartAndAppendLine(this DefaultDocumentation.Api.IWriter)')** `Method` Calls [EnsureLineStart(this IWriter)](IWriterExtension.EnsureLineStart(thisIWriter).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.EnsureLineStart(this DefaultDocumentation.Api.IWriter)') and [AppendLine()](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.AppendLine().md 'DefaultDocumentation.Api.IWriter.AppendLine'). - - **[GetCurrentItem(this IWriter)](IWriterExtension.GetCurrentItem(thisIWriter).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.GetCurrentItem(this DefaultDocumentation.Api.IWriter)')** `Method` Gets the current item that is being processed by this [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - It can be different from the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.DocItem.md 'DefaultDocumentation.Api.IWriter.DocItem') when inlining child documentation in its parent page. - - **[GetDisplayAsSingleLine(this IWriter)](IWriterExtension.GetDisplayAsSingleLine(thisIWriter).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.GetDisplayAsSingleLine(this DefaultDocumentation.Api.IWriter)')** `Method` Gets whether all futur data appended to the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') should stay on the same line (usefull for table). - This setting is used by the [MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') type. - - **[GetIgnoreLineBreak(this IWriter)](IWriterExtension.GetIgnoreLineBreak(thisIWriter).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.GetIgnoreLineBreak(this DefaultDocumentation.Api.IWriter)')** `Method` Gets whether line break in the xml documentation should be ignored in the generated markdown. - This setting is used by the [MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') type. - - **[SetCurrentItem(this IWriter, DocItem)](IWriterExtension.SetCurrentItem(thisIWriter,DocItem).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.SetCurrentItem(this DefaultDocumentation.Api.IWriter, DefaultDocumentation.Models.DocItem)')** `Method` Sets the current item that is being processed by this [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). - It can be different from the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.DocItem.md 'DefaultDocumentation.Api.IWriter.DocItem') when inlining child documentation in its parent page. - - **[SetDisplayAsSingleLine(this IWriter, Nullable<bool>)](IWriterExtension.SetDisplayAsSingleLine(thisIWriter,Nullable_bool_).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.SetDisplayAsSingleLine(this DefaultDocumentation.Api.IWriter, System.Nullable)')** `Method` Sets whether all futur data appended to the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') should stay on the same line (usefull for table). - This setting is used by the [MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') type. - - **[SetIgnoreLineBreakLine(this IWriter, Nullable<bool>)](IWriterExtension.SetIgnoreLineBreakLine(thisIWriter,Nullable_bool_).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.SetIgnoreLineBreakLine(this DefaultDocumentation.Api.IWriter, System.Nullable)')** `Method` Sets whether line break in the xml documentation should be ignored in the generated markdown. - This setting is used by the [MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') type. - - **[ToOverrideWriter(this IWriter)](IWriterExtension.ToOverrideWriter(thisIWriter).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.ToOverrideWriter(this DefaultDocumentation.Api.IWriter)')** `Method` Decorates the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') with a [OverrideWriter](OverrideWriter.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter') to override its setting in a given scope. - - **[ToPrefixedWriter(this IWriter, string)](IWriterExtension.ToPrefixedWriter(thisIWriter,string).md 'DefaultDocumentation.Markdown.Extensions.IWriterExtension.ToPrefixedWriter(this DefaultDocumentation.Api.IWriter, string)')** `Method` Decorates the given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') with a [PrefixedWriter](PrefixedWriter.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter') to prefix every new line with the given prefix. + + +## DefaultDocumentation\.Markdown\.Elements Namespace +- **[BrElement](DefaultDocumentation/Markdown/Elements/BrElement/index.md 'DefaultDocumentation\.Markdown\.Elements\.BrElement')** `Class` Handles `br` xml element\. + - **[ConfigName](DefaultDocumentation/Markdown/Elements/BrElement/ConfigName.md 'DefaultDocumentation\.Markdown\.Elements\.BrElement\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Elements/BrElement/Name.md 'DefaultDocumentation\.Markdown\.Elements\.BrElement\.Name')** `Property` Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + - **[Write\(IWriter, XElement\)](DefaultDocumentation/Markdown/Elements/BrElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Markdown\.Elements\.BrElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)')** `Method` Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. +- **[CElement](DefaultDocumentation/Markdown/Elements/CElement/index.md 'DefaultDocumentation\.Markdown\.Elements\.CElement')** `Class` Handles `c` xml element\. + - **[ConfigName](DefaultDocumentation/Markdown/Elements/CElement/ConfigName.md 'DefaultDocumentation\.Markdown\.Elements\.CElement\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Elements/CElement/Name.md 'DefaultDocumentation\.Markdown\.Elements\.CElement\.Name')** `Property` Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + - **[Write\(IWriter, XElement\)](DefaultDocumentation/Markdown/Elements/CElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Markdown\.Elements\.CElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)')** `Method` Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. +- **[CodeElement](DefaultDocumentation/Markdown/Elements/CodeElement/index.md 'DefaultDocumentation\.Markdown\.Elements\.CodeElement')** `Class` Handles `code` xml element\. + - **[ConfigName](DefaultDocumentation/Markdown/Elements/CodeElement/ConfigName.md 'DefaultDocumentation\.Markdown\.Elements\.CodeElement\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Elements/CodeElement/Name.md 'DefaultDocumentation\.Markdown\.Elements\.CodeElement\.Name')** `Property` Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + - **[Write\(IWriter, XElement\)](DefaultDocumentation/Markdown/Elements/CodeElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Markdown\.Elements\.CodeElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)')** `Method` Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. +- **[ListElement](DefaultDocumentation/Markdown/Elements/ListElement/index.md 'DefaultDocumentation\.Markdown\.Elements\.ListElement')** `Class` Handles `list` xml element\. + - **[ConfigName](DefaultDocumentation/Markdown/Elements/ListElement/ConfigName.md 'DefaultDocumentation\.Markdown\.Elements\.ListElement\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Elements/ListElement/Name.md 'DefaultDocumentation\.Markdown\.Elements\.ListElement\.Name')** `Property` Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + - **[Write\(IWriter, XElement\)](DefaultDocumentation/Markdown/Elements/ListElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Markdown\.Elements\.ListElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)')** `Method` Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. +- **[NoteElement](DefaultDocumentation/Markdown/Elements/NoteElement/index.md 'DefaultDocumentation\.Markdown\.Elements\.NoteElement')** `Class` Handles `note` xml element\. + - **[ConfigName](DefaultDocumentation/Markdown/Elements/NoteElement/ConfigName.md 'DefaultDocumentation\.Markdown\.Elements\.NoteElement\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Elements/NoteElement/Name.md 'DefaultDocumentation\.Markdown\.Elements\.NoteElement\.Name')** `Property` Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + - **[Write\(IWriter, XElement\)](DefaultDocumentation/Markdown/Elements/NoteElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Markdown\.Elements\.NoteElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)')** `Method` Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. +- **[ParaElement](DefaultDocumentation/Markdown/Elements/ParaElement/index.md 'DefaultDocumentation\.Markdown\.Elements\.ParaElement')** `Class` Handles `para` xml element\. + - **[ConfigName](DefaultDocumentation/Markdown/Elements/ParaElement/ConfigName.md 'DefaultDocumentation\.Markdown\.Elements\.ParaElement\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Elements/ParaElement/Name.md 'DefaultDocumentation\.Markdown\.Elements\.ParaElement\.Name')** `Property` Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + - **[Write\(IWriter, XElement\)](DefaultDocumentation/Markdown/Elements/ParaElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Markdown\.Elements\.ParaElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)')** `Method` Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. +- **[ParamRefElement](DefaultDocumentation/Markdown/Elements/ParamRefElement/index.md 'DefaultDocumentation\.Markdown\.Elements\.ParamRefElement')** `Class` Handles `paramref` xml element\. + - **[ConfigName](DefaultDocumentation/Markdown/Elements/ParamRefElement/ConfigName.md 'DefaultDocumentation\.Markdown\.Elements\.ParamRefElement\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Elements/ParamRefElement/Name.md 'DefaultDocumentation\.Markdown\.Elements\.ParamRefElement\.Name')** `Property` Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + - **[Write\(IWriter, XElement\)](DefaultDocumentation/Markdown/Elements/ParamRefElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Markdown\.Elements\.ParamRefElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)')** `Method` Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. +- **[SeeElement](DefaultDocumentation/Markdown/Elements/SeeElement/index.md 'DefaultDocumentation\.Markdown\.Elements\.SeeElement')** `Class` Handles `see` xml element\. + - **[ConfigName](DefaultDocumentation/Markdown/Elements/SeeElement/ConfigName.md 'DefaultDocumentation\.Markdown\.Elements\.SeeElement\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Elements/SeeElement/Name.md 'DefaultDocumentation\.Markdown\.Elements\.SeeElement\.Name')** `Property` Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + - **[Write\(IWriter, XElement\)](DefaultDocumentation/Markdown/Elements/SeeElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Markdown\.Elements\.SeeElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)')** `Method` Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. +- **[TypeParamRefElement](DefaultDocumentation/Markdown/Elements/TypeParamRefElement/index.md 'DefaultDocumentation\.Markdown\.Elements\.TypeParamRefElement')** `Class` Handles `typeparamref` xml element\. + - **[ConfigName](DefaultDocumentation/Markdown/Elements/TypeParamRefElement/ConfigName.md 'DefaultDocumentation\.Markdown\.Elements\.TypeParamRefElement\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Elements/TypeParamRefElement/Name.md 'DefaultDocumentation\.Markdown\.Elements\.TypeParamRefElement\.Name')** `Property` Gets the name of the [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement') this type handle\. + - **[Write\(IWriter, XElement\)](DefaultDocumentation/Markdown/Elements/TypeParamRefElement/Write(IWriter,XElement).md 'DefaultDocumentation\.Markdown\.Elements\.TypeParamRefElement\.Write\(DefaultDocumentation\.Api\.IWriter, System\.Xml\.Linq\.XElement\)')** `Method` Writes to a [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') the provided [System\.Xml\.Linq\.XElement](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.Linq.XElement 'System\.Xml\.Linq\.XElement')\. -## DefaultDocumentation.Markdown.FileNameFactories Namespace -- **[AMarkdownFactory](AMarkdownFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory')** `Class` Base implementation of the [IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') to generate file with a `.md` extension. - It will also replace invalid char that may be present with the [Markdown.InvalidCharReplacement](https://github.com/Doraku/DefaultDocumentation#invalidcharreplacement 'https://github.com/Doraku/DefaultDocumentation#invalidcharreplacement') setting. - - **[Name](AMarkdownFactory.Name.md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level. - - **[Clean(IGeneralContext)](AMarkdownFactory.Clean(IGeneralContext).md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.Clean(DefaultDocumentation.IGeneralContext)')** `Method` Cleans the [OutputDirectory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISettings.OutputDirectory.md 'DefaultDocumentation.ISettings.OutputDirectory') of the previously generated documentation files. - - **[GetFileName(IGeneralContext, DocItem)](AMarkdownFactory.GetFileName(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.GetFileName(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)')** `Method` Gets the documentation file name for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[GetMarkdownFileName(IGeneralContext, DocItem)](AMarkdownFactory.GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.FileNameFactories.AMarkdownFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)')** `Method` Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). -- **[FullNameFactory](FullNameFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory')** `Class` [IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') implementation using [FullName](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.FullName.md 'DefaultDocumentation.Models.DocItem.FullName') as file name. - - **[ConfigName](FullNameFactory.ConfigName.md 'DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](FullNameFactory.Name.md 'DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level. - - **[GetMarkdownFileName(IGeneralContext, DocItem)](FullNameFactory.GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.FileNameFactories.FullNameFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)')** `Method` Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). -- **[Md5Factory](Md5Factory.md 'DefaultDocumentation.Markdown.FileNameFactories.Md5Factory')** `Class` [IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') implementation using an md5 on the [FullName](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.FullName.md 'DefaultDocumentation.Models.DocItem.FullName') as file name. - - **[ConfigName](Md5Factory.ConfigName.md 'DefaultDocumentation.Markdown.FileNameFactories.Md5Factory.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](Md5Factory.Name.md 'DefaultDocumentation.Markdown.FileNameFactories.Md5Factory.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level. - - **[GetMarkdownFileName(IGeneralContext, DocItem)](Md5Factory.GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.FileNameFactories.Md5Factory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)')** `Method` Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). -- **[NameAndMd5MixFactory](NameAndMd5MixFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory')** `Class` [IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') implementation using [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.Name.md 'DefaultDocumentation.Models.DocItem.Name') and an md5 on the [FullName](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.FullName.md 'DefaultDocumentation.Models.DocItem.FullName') as file name. - - **[ConfigName](NameAndMd5MixFactory.ConfigName.md 'DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](NameAndMd5MixFactory.Name.md 'DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level. - - **[GetMarkdownFileName(IGeneralContext, DocItem)](NameAndMd5MixFactory.GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.FileNameFactories.NameAndMd5MixFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)')** `Method` Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). -- **[NameFactory](NameFactory.md 'DefaultDocumentation.Markdown.FileNameFactories.NameFactory')** `Class` [IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IFileNameFactory.md 'DefaultDocumentation.Api.IFileNameFactory') implementation using [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.Name.md 'DefaultDocumentation.Models.DocItem.Name') as file name. - - **[ConfigName](NameFactory.ConfigName.md 'DefaultDocumentation.Markdown.FileNameFactories.NameFactory.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](NameFactory.Name.md 'DefaultDocumentation.Markdown.FileNameFactories.NameFactory.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level. - - **[GetMarkdownFileName(IGeneralContext, DocItem)](NameFactory.GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.FileNameFactories.NameFactory.GetMarkdownFileName(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)')** `Method` Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). +## DefaultDocumentation\.Markdown\.FileNameFactories Namespace +- **[BaseMarkdownFileNameFactory](DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.BaseMarkdownFileNameFactory')** `Class` Base implementation of the [IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory') to generate file with a `.md` extension\. It will also replace invalid char that may be present with the [Markdown\.InvalidCharReplacement](https://github.com/Doraku/DefaultDocumentation#invalidcharreplacement 'https://github\.com/Doraku/DefaultDocumentation\#invalidcharreplacement') setting\. + - **[Name](DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/Name.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.BaseMarkdownFileNameFactory\.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level\. + - **[Clean\(IGeneralContext\)](DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/Clean(IGeneralContext).md 'DefaultDocumentation\.Markdown\.FileNameFactories\.BaseMarkdownFileNameFactory\.Clean\(DefaultDocumentation\.IGeneralContext\)')** `Method` Cleans the [OutputDirectory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/ISettings/OutputDirectory.md 'DefaultDocumentation\.ISettings\.OutputDirectory') of the previously generated documentation files\. + - **[GetFileName\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/GetFileName(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.FileNameFactories\.BaseMarkdownFileNameFactory\.GetFileName\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the documentation file name for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[GetMarkdownFileName\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/FileNameFactories/BaseMarkdownFileNameFactory/GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.FileNameFactories\.BaseMarkdownFileNameFactory\.GetMarkdownFileName\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. +- **[DirectoryNameFactory](DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.DirectoryNameFactory')** `Class` [IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory') implementation using [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/Name.md 'DefaultDocumentation\.Models\.DocItem\.Name') as file name in a directory hierarchy\. + - **[ConfigName](DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/ConfigName.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.DirectoryNameFactory\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/Name.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.DirectoryNameFactory\.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level\. + - **[Clean\(IGeneralContext\)](DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/Clean(IGeneralContext).md 'DefaultDocumentation\.Markdown\.FileNameFactories\.DirectoryNameFactory\.Clean\(DefaultDocumentation\.IGeneralContext\)')** `Method` Cleans the [OutputDirectory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/ISettings/OutputDirectory.md 'DefaultDocumentation\.ISettings\.OutputDirectory') of the previously generated documentation files\. + - **[GetFileName\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/FileNameFactories/DirectoryNameFactory/GetFileName(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.FileNameFactories\.DirectoryNameFactory\.GetFileName\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the documentation file name for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. +- **[FullNameFactory](DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.FullNameFactory')** `Class` [IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory') implementation using [FullName](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/FullName.md 'DefaultDocumentation\.Models\.DocItem\.FullName') as file name\. + - **[ConfigName](DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/ConfigName.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.FullNameFactory\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/Name.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.FullNameFactory\.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level\. + - **[GetMarkdownFileName\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/FileNameFactories/FullNameFactory/GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.FileNameFactories\.FullNameFactory\.GetMarkdownFileName\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. +- **[Md5Factory](DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.Md5Factory')** `Class` [IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory') implementation using an md5 on the [FullName](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/FullName.md 'DefaultDocumentation\.Models\.DocItem\.FullName') as file name\. + - **[ConfigName](DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/ConfigName.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.Md5Factory\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/Name.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.Md5Factory\.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level\. + - **[GetMarkdownFileName\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/FileNameFactories/Md5Factory/GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.FileNameFactories\.Md5Factory\.GetMarkdownFileName\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. +- **[NameAndMd5MixFactory](DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameAndMd5MixFactory')** `Class` [IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory') implementation using [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/Name.md 'DefaultDocumentation\.Models\.DocItem\.Name') and an md5 on the [FullName](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/FullName.md 'DefaultDocumentation\.Models\.DocItem\.FullName') as file name\. + - **[ConfigName](DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/ConfigName.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameAndMd5MixFactory\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/Name.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameAndMd5MixFactory\.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level\. + - **[GetMarkdownFileName\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/FileNameFactories/NameAndMd5MixFactory/GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameAndMd5MixFactory\.GetMarkdownFileName\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. +- **[NameFactory](DefaultDocumentation/Markdown/FileNameFactories/NameFactory/index.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameFactory')** `Class` [IFileNameFactory](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IFileNameFactory/index.md 'DefaultDocumentation\.Api\.IFileNameFactory') implementation using [Name](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/Name.md 'DefaultDocumentation\.Models\.DocItem\.Name') as file name\. + - **[ConfigName](DefaultDocumentation/Markdown/FileNameFactories/NameFactory/ConfigName.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameFactory\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/FileNameFactories/NameFactory/Name.md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameFactory\.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level\. + - **[GetMarkdownFileName\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/FileNameFactories/NameFactory/GetMarkdownFileName(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.FileNameFactories\.NameFactory\.GetMarkdownFileName\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the file name to use for the given [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + + + +## DefaultDocumentation\.Markdown\.Models Namespace +- **[ConstructorOverloadsDocItem](DefaultDocumentation/Markdown/Models/ConstructorOverloadsDocItem/index.md 'DefaultDocumentation\.Markdown\.Models\.ConstructorOverloadsDocItem')** `Class` Represents the different overload of the constructors of a given [TypeDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem')\. + - **[ConstructorOverloadsDocItem\(TypeDocItem\)](DefaultDocumentation/Markdown/Models/ConstructorOverloadsDocItem/ConstructorOverloadsDocItem(TypeDocItem).md 'DefaultDocumentation\.Markdown\.Models\.ConstructorOverloadsDocItem\.ConstructorOverloadsDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem\)')** `Constructor` Initialize a new instance of the [ConstructorOverloadsDocItem](DefaultDocumentation/Markdown/Models/ConstructorOverloadsDocItem/index.md 'DefaultDocumentation\.Markdown\.Models\.ConstructorOverloadsDocItem') type\. +- **[MethodOverloadsDocItem](DefaultDocumentation/Markdown/Models/MethodOverloadsDocItem/index.md 'DefaultDocumentation\.Markdown\.Models\.MethodOverloadsDocItem')** `Class` Represents the different overload of a method of a given [TypeDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem')\. + - **[MethodOverloadsDocItem\(TypeDocItem, string\)](DefaultDocumentation/Markdown/Models/MethodOverloadsDocItem/MethodOverloadsDocItem(TypeDocItem,string).md 'DefaultDocumentation\.Markdown\.Models\.MethodOverloadsDocItem\.MethodOverloadsDocItem\(DefaultDocumentation\.Models\.Types\.TypeDocItem, string\)')** `Constructor` Initialize a new instance of the [MethodOverloadsDocItem](DefaultDocumentation/Markdown/Models/MethodOverloadsDocItem/index.md 'DefaultDocumentation\.Markdown\.Models\.MethodOverloadsDocItem') type\. -## DefaultDocumentation.Markdown.Sections Namespace -- **[ChildrenSection<T>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection')** `Class` Base [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write children of a given type of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[ChildrenSection(string, string)](ChildrenSection_T_.ChildrenSection(string,string).md 'DefaultDocumentation.Markdown.Sections.ChildrenSection.ChildrenSection(string, string)')** `Constructor` Base constructor of the [ChildrenSection<T>](ChildrenSection_T_.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection') type. - - **[Name](ChildrenSection_T_.Name.md 'DefaultDocumentation.Markdown.Sections.ChildrenSection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[GetChildren(IGeneralContext, DocItem)](ChildrenSection_T_.GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.Sections.ChildrenSection.GetChildren(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)')** `Method` Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') to write. - - **[Write(IWriter)](ChildrenSection_T_.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.ChildrenSection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[ClassesSection](ClassesSection.md 'DefaultDocumentation.Markdown.Sections.ClassesSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [ClassDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ClassDocItem.md 'DefaultDocumentation.Models.Types.ClassDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[ClassesSection()](ClassesSection.ClassesSection().md 'DefaultDocumentation.Markdown.Sections.ClassesSection.ClassesSection()')** `Constructor` Initialize a new instance of the [ClassesSection](ClassesSection.md 'DefaultDocumentation.Markdown.Sections.ClassesSection') type. - - **[ConfigName](ClassesSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.ClassesSection.ConfigName')** `Field` The name of this implementation used at the configuration level. -- **[ConstructorsSection](ConstructorsSection.md 'DefaultDocumentation.Markdown.Sections.ConstructorsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [ConstructorDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ConstructorDocItem.md 'DefaultDocumentation.Models.Members.ConstructorDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[ConstructorsSection()](ConstructorsSection.ConstructorsSection().md 'DefaultDocumentation.Markdown.Sections.ConstructorsSection.ConstructorsSection()')** `Constructor` Initialize a new instance of the [ConstructorsSection](ConstructorsSection.md 'DefaultDocumentation.Markdown.Sections.ConstructorsSection') type. - - **[ConfigName](ConstructorsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.ConstructorsSection.ConfigName')** `Field` The name of this implementation used at the configuration level. -- **[DefaultSection](DefaultSection.md 'DefaultDocumentation.Markdown.Sections.DefaultSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation regrouping the following implementation in this order: - - 1. [TitleSection](TitleSection.md 'DefaultDocumentation.Markdown.Sections.TitleSection') - 2. [SummarySection](SummarySection.md 'DefaultDocumentation.Markdown.Sections.SummarySection') - 3. [DefinitionSection](DefinitionSection.md 'DefaultDocumentation.Markdown.Sections.DefinitionSection') - 4. [TypeParametersSection](TypeParametersSection.md 'DefaultDocumentation.Markdown.Sections.TypeParametersSection') - 5. [ParametersSection](ParametersSection.md 'DefaultDocumentation.Markdown.Sections.ParametersSection') - 6. [EnumFieldsSection](EnumFieldsSection.md 'DefaultDocumentation.Markdown.Sections.EnumFieldsSection') - 7. [InheritanceSection](InheritanceSection.md 'DefaultDocumentation.Markdown.Sections.InheritanceSection') - 8. [DerivedSection](DerivedSection.md 'DefaultDocumentation.Markdown.Sections.DerivedSection') - 9. [ImplementSection](ImplementSection.md 'DefaultDocumentation.Markdown.Sections.ImplementSection') - 10. [EventTypeSection](EventTypeSection.md 'DefaultDocumentation.Markdown.Sections.EventTypeSection') - 11. [FieldValueSection](FieldValueSection.md 'DefaultDocumentation.Markdown.Sections.FieldValueSection') - 12. [ValueSection](ValueSection.md 'DefaultDocumentation.Markdown.Sections.ValueSection') - 13. [ReturnsSection](ReturnsSection.md 'DefaultDocumentation.Markdown.Sections.ReturnsSection') - 14. [ExceptionSection](ExceptionSection.md 'DefaultDocumentation.Markdown.Sections.ExceptionSection') - 15. [ExampleSection](ExampleSection.md 'DefaultDocumentation.Markdown.Sections.ExampleSection') - 16. [RemarksSection](RemarksSection.md 'DefaultDocumentation.Markdown.Sections.RemarksSection') - 17. [SeeAlsoSection](SeeAlsoSection.md 'DefaultDocumentation.Markdown.Sections.SeeAlsoSection') - 18. [NamespacesSection](NamespacesSection.md 'DefaultDocumentation.Markdown.Sections.NamespacesSection') - 19. [ClassesSection](ClassesSection.md 'DefaultDocumentation.Markdown.Sections.ClassesSection') - 20. [StructsSection](StructsSection.md 'DefaultDocumentation.Markdown.Sections.StructsSection') - 21. [InterfacesSection](InterfacesSection.md 'DefaultDocumentation.Markdown.Sections.InterfacesSection') - 22. [EnumsSection](EnumsSection.md 'DefaultDocumentation.Markdown.Sections.EnumsSection') - 23. [DelegatesSection](DelegatesSection.md 'DefaultDocumentation.Markdown.Sections.DelegatesSection') - 24. [ConstructorsSection](ConstructorsSection.md 'DefaultDocumentation.Markdown.Sections.ConstructorsSection') - 25. [FieldsSection](FieldsSection.md 'DefaultDocumentation.Markdown.Sections.FieldsSection') - 26. [PropertiesSection](PropertiesSection.md 'DefaultDocumentation.Markdown.Sections.PropertiesSection') - 27. [MethodsSection](MethodsSection.md 'DefaultDocumentation.Markdown.Sections.MethodsSection') - 28. [EventsSection](EventsSection.md 'DefaultDocumentation.Markdown.Sections.EventsSection') - 29. [OperatorsSection](OperatorsSection.md 'DefaultDocumentation.Markdown.Sections.OperatorsSection') - 30. [ExplicitInterfaceImplementationsSection](ExplicitInterfaceImplementationsSection.md 'DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection') - - **[DefaultSection()](DefaultSection.DefaultSection().md 'DefaultDocumentation.Markdown.Sections.DefaultSection.DefaultSection()')** `Constructor` Initialize a new instance of the [DefaultSection](DefaultSection.md 'DefaultDocumentation.Markdown.Sections.DefaultSection') type. - - **[ConfigName](DefaultSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.DefaultSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](DefaultSection.Name.md 'DefaultDocumentation.Markdown.Sections.DefaultSection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](DefaultSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.DefaultSection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[DefinitionSection](DefinitionSection.md 'DefaultDocumentation.Markdown.Sections.DefinitionSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the definition of [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[ConfigName](DefinitionSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.DefinitionSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](DefinitionSection.Name.md 'DefaultDocumentation.Markdown.Sections.DefinitionSection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](DefinitionSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.DefinitionSection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[DelegatesSection](DelegatesSection.md 'DefaultDocumentation.Markdown.Sections.DelegatesSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [DelegateDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DelegateDocItem.md 'DefaultDocumentation.Models.Types.DelegateDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[DelegatesSection()](DelegatesSection.DelegatesSection().md 'DefaultDocumentation.Markdown.Sections.DelegatesSection.DelegatesSection()')** `Constructor` Initialize a new instance of the [DelegatesSection](DelegatesSection.md 'DefaultDocumentation.Markdown.Sections.DelegatesSection') type. - - **[ConfigName](DelegatesSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.DelegatesSection.ConfigName')** `Field` The name of this implementation used at the configuration level. -- **[DerivedSection](DerivedSection.md 'DefaultDocumentation.Markdown.Sections.DerivedSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the derived type of [TypeDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem'). - - **[ConfigName](DerivedSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.DerivedSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](DerivedSection.Name.md 'DefaultDocumentation.Markdown.Sections.DerivedSection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](DerivedSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.DerivedSection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[EnumFieldsSection](EnumFieldsSection.md 'DefaultDocumentation.Markdown.Sections.EnumFieldsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [EnumFieldDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/EnumFieldDocItem.md 'DefaultDocumentation.Models.Members.EnumFieldDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[EnumFieldsSection()](EnumFieldsSection.EnumFieldsSection().md 'DefaultDocumentation.Markdown.Sections.EnumFieldsSection.EnumFieldsSection()')** `Constructor` Initialize a new instance of the [EnumFieldsSection](EnumFieldsSection.md 'DefaultDocumentation.Markdown.Sections.EnumFieldsSection') type. - - **[ConfigName](EnumFieldsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.EnumFieldsSection.ConfigName')** `Field` The name of this implementation used at the configuration level. -- **[EnumsSection](EnumsSection.md 'DefaultDocumentation.Markdown.Sections.EnumsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [EnumDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/EnumDocItem.md 'DefaultDocumentation.Models.Types.EnumDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[EnumsSection()](EnumsSection.EnumsSection().md 'DefaultDocumentation.Markdown.Sections.EnumsSection.EnumsSection()')** `Constructor` Initialize a new instance of the [EnumsSection](EnumsSection.md 'DefaultDocumentation.Markdown.Sections.EnumsSection') type. - - **[ConfigName](EnumsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.EnumsSection.ConfigName')** `Field` The name of this implementation used at the configuration level. -- **[EventsSection](EventsSection.md 'DefaultDocumentation.Markdown.Sections.EventsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [EventDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/EventDocItem.md 'DefaultDocumentation.Models.Members.EventDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[EventsSection()](EventsSection.EventsSection().md 'DefaultDocumentation.Markdown.Sections.EventsSection.EventsSection()')** `Constructor` Initialize a new instance of the [EventsSection](EventsSection.md 'DefaultDocumentation.Markdown.Sections.EventsSection') type. - - **[ConfigName](EventsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.EventsSection.ConfigName')** `Field` The name of this implementation used at the configuration level. -- **[EventTypeSection](EventTypeSection.md 'DefaultDocumentation.Markdown.Sections.EventTypeSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the event type of [EventDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/EventDocItem.md 'DefaultDocumentation.Models.Members.EventDocItem'). - - **[ConfigName](EventTypeSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.EventTypeSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](EventTypeSection.Name.md 'DefaultDocumentation.Markdown.Sections.EventTypeSection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](EventTypeSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.EventTypeSection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[ExampleSection](ExampleSection.md 'DefaultDocumentation.Markdown.Sections.ExampleSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the `example` top level element. - - **[ConfigName](ExampleSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.ExampleSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](ExampleSection.Name.md 'DefaultDocumentation.Markdown.Sections.ExampleSection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](ExampleSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.ExampleSection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[ExceptionSection](ExceptionSection.md 'DefaultDocumentation.Markdown.Sections.ExceptionSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the `exception` top level elements. - - **[ConfigName](ExceptionSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.ExceptionSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](ExceptionSection.Name.md 'DefaultDocumentation.Markdown.Sections.ExceptionSection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](ExceptionSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.ExceptionSection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[ExplicitInterfaceImplementationsSection](ExplicitInterfaceImplementationsSection.md 'DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [ExplicitInterfaceImplementationDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ExplicitInterfaceImplementationDocItem.md 'DefaultDocumentation.Models.Members.ExplicitInterfaceImplementationDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[ExplicitInterfaceImplementationsSection()](ExplicitInterfaceImplementationsSection.ExplicitInterfaceImplementationsSection().md 'DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection.ExplicitInterfaceImplementationsSection()')** `Constructor` Initialize a new instance of the [ExplicitInterfaceImplementationsSection](ExplicitInterfaceImplementationsSection.md 'DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection') type. - - **[ConfigName](ExplicitInterfaceImplementationsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.ExplicitInterfaceImplementationsSection.ConfigName')** `Field` The name of this implementation used at the configuration level. -- **[FieldsSection](FieldsSection.md 'DefaultDocumentation.Markdown.Sections.FieldsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [FieldDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/FieldDocItem.md 'DefaultDocumentation.Models.Members.FieldDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[FieldsSection()](FieldsSection.FieldsSection().md 'DefaultDocumentation.Markdown.Sections.FieldsSection.FieldsSection()')** `Constructor` Initialize a new instance of the [FieldsSection](FieldsSection.md 'DefaultDocumentation.Markdown.Sections.FieldsSection') type. - - **[ConfigName](FieldsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.FieldsSection.ConfigName')** `Field` The name of this implementation used at the configuration level. -- **[FieldValueSection](FieldValueSection.md 'DefaultDocumentation.Markdown.Sections.FieldValueSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the field type of [FieldDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/FieldDocItem.md 'DefaultDocumentation.Models.Members.FieldDocItem'). - - **[ConfigName](FieldValueSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.FieldValueSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](FieldValueSection.Name.md 'DefaultDocumentation.Markdown.Sections.FieldValueSection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](FieldValueSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.FieldValueSection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[FooterSection](FooterSection.md 'DefaultDocumentation.Markdown.Sections.FooterSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write a link to [DefaultDocumentation](https://github.com/Doraku/DefaultDocumentation 'https://github.com/Doraku/DefaultDocumentation'). - - **[ConfigName](FooterSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.FooterSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](FooterSection.Name.md 'DefaultDocumentation.Markdown.Sections.FooterSection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](FooterSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.FooterSection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[HeaderSection](HeaderSection.md 'DefaultDocumentation.Markdown.Sections.HeaderSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write a link to the top level documentation page. - - **[ConfigName](HeaderSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.HeaderSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](HeaderSection.Name.md 'DefaultDocumentation.Markdown.Sections.HeaderSection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](HeaderSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.HeaderSection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[ImplementSection](ImplementSection.md 'DefaultDocumentation.Markdown.Sections.ImplementSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the types/members implemented by the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[ConfigName](ImplementSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.ImplementSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](ImplementSection.Name.md 'DefaultDocumentation.Markdown.Sections.ImplementSection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](ImplementSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.ImplementSection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[InheritanceSection](InheritanceSection.md 'DefaultDocumentation.Markdown.Sections.InheritanceSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the types inherited by the [TypeDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/TypeDocItem.md 'DefaultDocumentation.Models.Types.TypeDocItem'). - - **[ConfigName](InheritanceSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.InheritanceSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](InheritanceSection.Name.md 'DefaultDocumentation.Markdown.Sections.InheritanceSection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](InheritanceSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.InheritanceSection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[InterfacesSection](InterfacesSection.md 'DefaultDocumentation.Markdown.Sections.InterfacesSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [InterfaceDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/InterfaceDocItem.md 'DefaultDocumentation.Models.Types.InterfaceDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[InterfacesSection()](InterfacesSection.InterfacesSection().md 'DefaultDocumentation.Markdown.Sections.InterfacesSection.InterfacesSection()')** `Constructor` Initialize a new instance of the [InterfacesSection](InterfacesSection.md 'DefaultDocumentation.Markdown.Sections.InterfacesSection') type. - - **[ConfigName](InterfacesSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.InterfacesSection.ConfigName')** `Field` The name of this implementation used at the configuration level. -- **[MethodsSection](MethodsSection.md 'DefaultDocumentation.Markdown.Sections.MethodsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [MethodDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/MethodDocItem.md 'DefaultDocumentation.Models.Members.MethodDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[MethodsSection()](MethodsSection.MethodsSection().md 'DefaultDocumentation.Markdown.Sections.MethodsSection.MethodsSection()')** `Constructor` Initialize a new instance of the [MethodsSection](MethodsSection.md 'DefaultDocumentation.Markdown.Sections.MethodsSection') type. - - **[ConfigName](MethodsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.MethodsSection.ConfigName')** `Field` The name of this implementation used at the configuration level. -- **[NamespacesSection](NamespacesSection.md 'DefaultDocumentation.Markdown.Sections.NamespacesSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [NamespaceDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/NamespaceDocItem.md 'DefaultDocumentation.Models.NamespaceDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[NamespacesSection()](NamespacesSection.NamespacesSection().md 'DefaultDocumentation.Markdown.Sections.NamespacesSection.NamespacesSection()')** `Constructor` Initialize a new instance of the [NamespacesSection](NamespacesSection.md 'DefaultDocumentation.Markdown.Sections.NamespacesSection') type. - - **[ConfigName](NamespacesSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.NamespacesSection.ConfigName')** `Field` The name of this implementation used at the configuration level. -- **[OperatorsSection](OperatorsSection.md 'DefaultDocumentation.Markdown.Sections.OperatorsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [OperatorDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/OperatorDocItem.md 'DefaultDocumentation.Models.Members.OperatorDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[OperatorsSection()](OperatorsSection.OperatorsSection().md 'DefaultDocumentation.Markdown.Sections.OperatorsSection.OperatorsSection()')** `Constructor` Initialize a new instance of the [OperatorsSection](OperatorsSection.md 'DefaultDocumentation.Markdown.Sections.OperatorsSection') type. - - **[ConfigName](OperatorsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.OperatorsSection.ConfigName')** `Field` The name of this implementation used at the configuration level. -- **[ParametersSection](ParametersSection.md 'DefaultDocumentation.Markdown.Sections.ParametersSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [ParameterDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ParameterDocItem.md 'DefaultDocumentation.Models.Parameters.ParameterDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[ParametersSection()](ParametersSection.ParametersSection().md 'DefaultDocumentation.Markdown.Sections.ParametersSection.ParametersSection()')** `Constructor` Initialize a new instance of the [ParametersSection](ParametersSection.md 'DefaultDocumentation.Markdown.Sections.ParametersSection') type. - - **[ConfigName](ParametersSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.ParametersSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[GetChildren(IGeneralContext, DocItem)](ParametersSection.GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.Sections.ParametersSection.GetChildren(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)')** `Method` Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') to write. -- **[PropertiesSection](PropertiesSection.md 'DefaultDocumentation.Markdown.Sections.PropertiesSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [PropertyDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/PropertyDocItem.md 'DefaultDocumentation.Models.Members.PropertyDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[PropertiesSection()](PropertiesSection.PropertiesSection().md 'DefaultDocumentation.Markdown.Sections.PropertiesSection.PropertiesSection()')** `Constructor` Initialize a new instance of the [PropertiesSection](PropertiesSection.md 'DefaultDocumentation.Markdown.Sections.PropertiesSection') type. - - **[ConfigName](PropertiesSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.PropertiesSection.ConfigName')** `Field` The name of this implementation used at the configuration level. -- **[RemarksSection](RemarksSection.md 'DefaultDocumentation.Markdown.Sections.RemarksSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the `remarks` top level element. - - **[ConfigName](RemarksSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.RemarksSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](RemarksSection.Name.md 'DefaultDocumentation.Markdown.Sections.RemarksSection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](RemarksSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.RemarksSection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[ReturnsSection](ReturnsSection.md 'DefaultDocumentation.Markdown.Sections.ReturnsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the `returns` top level element. - - **[ConfigName](ReturnsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.ReturnsSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](ReturnsSection.Name.md 'DefaultDocumentation.Markdown.Sections.ReturnsSection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](ReturnsSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.ReturnsSection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[SeeAlsoSection](SeeAlsoSection.md 'DefaultDocumentation.Markdown.Sections.SeeAlsoSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the `seealso` top level elements. - - **[ConfigName](SeeAlsoSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.SeeAlsoSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](SeeAlsoSection.Name.md 'DefaultDocumentation.Markdown.Sections.SeeAlsoSection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](SeeAlsoSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.SeeAlsoSection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[StructsSection](StructsSection.md 'DefaultDocumentation.Markdown.Sections.StructsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [StructDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/StructDocItem.md 'DefaultDocumentation.Models.Types.StructDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[StructsSection()](StructsSection.StructsSection().md 'DefaultDocumentation.Markdown.Sections.StructsSection.StructsSection()')** `Constructor` Initialize a new instance of the [StructsSection](StructsSection.md 'DefaultDocumentation.Markdown.Sections.StructsSection') type. - - **[ConfigName](StructsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.StructsSection.ConfigName')** `Field` The name of this implementation used at the configuration level. -- **[SummarySection](SummarySection.md 'DefaultDocumentation.Markdown.Sections.SummarySection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the `summary` top level element. - - **[ConfigName](SummarySection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.SummarySection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](SummarySection.Name.md 'DefaultDocumentation.Markdown.Sections.SummarySection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](SummarySection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.SummarySection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[TableOfContentsSection](TableOfContentsSection.md 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write a table of content of all children of the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[ConfigName](TableOfContentsSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](TableOfContentsSection.Name.md 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](TableOfContentsSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[TitleSection](TitleSection.md 'DefaultDocumentation.Markdown.Sections.TitleSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write a title of the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[ConfigName](TitleSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.TitleSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](TitleSection.Name.md 'DefaultDocumentation.Markdown.Sections.TitleSection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](TitleSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.TitleSection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[TypeParametersSection](TypeParametersSection.md 'DefaultDocumentation.Markdown.Sections.TypeParametersSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write [TypeParameterDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/TypeParameterDocItem.md 'DefaultDocumentation.Models.Parameters.TypeParameterDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[TypeParametersSection()](TypeParametersSection.TypeParametersSection().md 'DefaultDocumentation.Markdown.Sections.TypeParametersSection.TypeParametersSection()')** `Constructor` Initialize a new instance of the [TypeParametersSection](TypeParametersSection.md 'DefaultDocumentation.Markdown.Sections.TypeParametersSection') type. - - **[ConfigName](TypeParametersSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.TypeParametersSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[GetChildren(IGeneralContext, DocItem)](TypeParametersSection.GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation.Markdown.Sections.TypeParametersSection.GetChildren(DefaultDocumentation.IGeneralContext, DefaultDocumentation.Models.DocItem)')** `Method` Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') to write. -- **[ValueSection](ValueSection.md 'DefaultDocumentation.Markdown.Sections.ValueSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/ISection.md 'DefaultDocumentation.Api.ISection') implementation to write the `value` top level element. - - **[ConfigName](ValueSection.ConfigName.md 'DefaultDocumentation.Markdown.Sections.ValueSection.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](ValueSection.Name.md 'DefaultDocumentation.Markdown.Sections.ValueSection.Name')** `Property` Gets the name of the section, used to identify it at the configuration level. - - **[Write(IWriter)](ValueSection.Write(IWriter).md 'DefaultDocumentation.Markdown.Sections.ValueSection.Write(DefaultDocumentation.Api.IWriter)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter'). -- **[TableOfContentsSection.Modes](TableOfContentsSection.Modes.md 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes')** `Enum` The different options to customize the table of contents. - - **[Grouped](TableOfContentsSection.Modes.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.Grouped 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.Grouped')** `Field` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') will appear in their kind section. - - **[IncludeKind](TableOfContentsSection.Modes.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeKind 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeKind')** `Field` The kind of each [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') will appear explicitely. - - **[IncludeNewLine](TableOfContentsSection.Modes.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeNewLine 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeNewLine')** `Field` There should be a new line when displaying the summary of the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[IncludeSummary](TableOfContentsSection.Modes.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummary 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummary')** `Field` The summary of each [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') will be displayed. - - **[IncludeSummaryWithNewLine](TableOfContentsSection.Modes.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummaryWithNewLine 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummaryWithNewLine')** `Field` Same as [IncludeSummary](TableOfContentsSection.Modes.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummary 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummary') and [IncludeNewLine](TableOfContentsSection.Modes.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeNewLine 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeNewLine') - - **[None](TableOfContentsSection.Modes.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.None 'DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.None')** `Field` Default generation. +## DefaultDocumentation\.Markdown\.Sections Namespace +- **[ChildrenSection<T>](DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\')** `Class` Base [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write children of a given type of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[ChildrenSection\(string, string\)](DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/ChildrenSection(string,string).md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\\.ChildrenSection\(string, string\)')** `Constructor` Base constructor of the [ChildrenSection<T>](DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/index.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\') type\. + - **[Name](DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/Name.md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[GetChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\\.GetChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. + - **[ShouldWriteTitle\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/ShouldWriteTitle(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\\.ShouldWriteTitle\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the title should be writen or not\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/ChildrenSection_T_/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.ChildrenSection\\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[ClassesSection](DefaultDocumentation/Markdown/Sections/ClassesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ClassesSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [ClassDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/ClassDocItem/index.md 'DefaultDocumentation\.Models\.Types\.ClassDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[ClassesSection\(\)](DefaultDocumentation/Markdown/Sections/ClassesSection/ClassesSection().md 'DefaultDocumentation\.Markdown\.Sections\.ClassesSection\.ClassesSection\(\)')** `Constructor` Initialize a new instance of the [ClassesSection](DefaultDocumentation/Markdown/Sections/ClassesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ClassesSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/ClassesSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ClassesSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/ClassesSection/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ClassesSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. +- **[ConstructorOverloadsSection](DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorOverloadsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [ConstructorOverloadsSection](DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorOverloadsSection') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[ConstructorOverloadsSection\(\)](DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/ConstructorOverloadsSection().md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorOverloadsSection\.ConstructorOverloadsSection\(\)')** `Constructor` Initialize a new instance of the [ConstructorsSection](DefaultDocumentation/Markdown/Sections/ConstructorsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorOverloadsSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[GetChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorOverloadsSection\.GetChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/ConstructorOverloadsSection/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorOverloadsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. +- **[ConstructorsSection](DefaultDocumentation/Markdown/Sections/ConstructorsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [ConstructorDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/ConstructorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ConstructorDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[ConstructorsSection\(\)](DefaultDocumentation/Markdown/Sections/ConstructorsSection/ConstructorsSection().md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection\.ConstructorsSection\(\)')** `Constructor` Initialize a new instance of the [ConstructorsSection](DefaultDocumentation/Markdown/Sections/ConstructorsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/ConstructorsSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[GetChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/ConstructorsSection/GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection\.GetChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/ConstructorsSection/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. + - **[ShouldWriteTitle\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/ConstructorsSection/ShouldWriteTitle(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection\.ShouldWriteTitle\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the title should be writen or not\. +- **[DefaultSection](DefaultDocumentation/Markdown/Sections/DefaultSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.DefaultSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation regrouping the following implementation in this order: \.\.\. + - **[DefaultSection\(\)](DefaultDocumentation/Markdown/Sections/DefaultSection/DefaultSection().md 'DefaultDocumentation\.Markdown\.Sections\.DefaultSection\.DefaultSection\(\)')** `Constructor` Initialize a new instance of the [DefaultSection](DefaultDocumentation/Markdown/Sections/DefaultSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.DefaultSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/DefaultSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.DefaultSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Sections/DefaultSection/Name.md 'DefaultDocumentation\.Markdown\.Sections\.DefaultSection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/DefaultSection/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.DefaultSection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[DefinitionSection](DefaultDocumentation/Markdown/Sections/DefinitionSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.DefinitionSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the definition of [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/DefinitionSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.DefinitionSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Sections/DefinitionSection/Name.md 'DefaultDocumentation\.Markdown\.Sections\.DefinitionSection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/DefinitionSection/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.DefinitionSection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[DelegatesSection](DefaultDocumentation/Markdown/Sections/DelegatesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.DelegatesSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [DelegateDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/DelegateDocItem/index.md 'DefaultDocumentation\.Models\.Types\.DelegateDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[DelegatesSection\(\)](DefaultDocumentation/Markdown/Sections/DelegatesSection/DelegatesSection().md 'DefaultDocumentation\.Markdown\.Sections\.DelegatesSection\.DelegatesSection\(\)')** `Constructor` Initialize a new instance of the [DelegatesSection](DefaultDocumentation/Markdown/Sections/DelegatesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.DelegatesSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/DelegatesSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.DelegatesSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/DelegatesSection/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.DelegatesSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. +- **[DerivedSection](DefaultDocumentation/Markdown/Sections/DerivedSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.DerivedSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the derived type of [TypeDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem')\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/DerivedSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.DerivedSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Sections/DerivedSection/Name.md 'DefaultDocumentation\.Markdown\.Sections\.DerivedSection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/DerivedSection/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.DerivedSection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[EnumFieldsSection](DefaultDocumentation/Markdown/Sections/EnumFieldsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumFieldsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [EnumFieldDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/EnumFieldDocItem/index.md 'DefaultDocumentation\.Models\.Members\.EnumFieldDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[EnumFieldsSection\(\)](DefaultDocumentation/Markdown/Sections/EnumFieldsSection/EnumFieldsSection().md 'DefaultDocumentation\.Markdown\.Sections\.EnumFieldsSection\.EnumFieldsSection\(\)')** `Constructor` Initialize a new instance of the [EnumFieldsSection](DefaultDocumentation/Markdown/Sections/EnumFieldsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumFieldsSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/EnumFieldsSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.EnumFieldsSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[GetChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/EnumFieldsSection/GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.EnumFieldsSection\.GetChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/EnumFieldsSection/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.EnumFieldsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. +- **[EnumsSection](DefaultDocumentation/Markdown/Sections/EnumsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [EnumDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/EnumDocItem/index.md 'DefaultDocumentation\.Models\.Types\.EnumDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[EnumsSection\(\)](DefaultDocumentation/Markdown/Sections/EnumsSection/EnumsSection().md 'DefaultDocumentation\.Markdown\.Sections\.EnumsSection\.EnumsSection\(\)')** `Constructor` Initialize a new instance of the [EnumsSection](DefaultDocumentation/Markdown/Sections/EnumsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.EnumsSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/EnumsSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.EnumsSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/EnumsSection/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.EnumsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. +- **[EventsSection](DefaultDocumentation/Markdown/Sections/EventsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.EventsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [EventDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/EventDocItem/index.md 'DefaultDocumentation\.Models\.Members\.EventDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[EventsSection\(\)](DefaultDocumentation/Markdown/Sections/EventsSection/EventsSection().md 'DefaultDocumentation\.Markdown\.Sections\.EventsSection\.EventsSection\(\)')** `Constructor` Initialize a new instance of the [EventsSection](DefaultDocumentation/Markdown/Sections/EventsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.EventsSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/EventsSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.EventsSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/EventsSection/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.EventsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. +- **[EventTypeSection](DefaultDocumentation/Markdown/Sections/EventTypeSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.EventTypeSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the event type of [EventDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/EventDocItem/index.md 'DefaultDocumentation\.Models\.Members\.EventDocItem')\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/EventTypeSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.EventTypeSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Sections/EventTypeSection/Name.md 'DefaultDocumentation\.Markdown\.Sections\.EventTypeSection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/EventTypeSection/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.EventTypeSection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[ExampleSection](DefaultDocumentation/Markdown/Sections/ExampleSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ExampleSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the `example` top level element\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/ExampleSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ExampleSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Sections/ExampleSection/Name.md 'DefaultDocumentation\.Markdown\.Sections\.ExampleSection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/ExampleSection/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.ExampleSection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[ExceptionSection](DefaultDocumentation/Markdown/Sections/ExceptionSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ExceptionSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the `exception` top level elements\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/ExceptionSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ExceptionSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Sections/ExceptionSection/Name.md 'DefaultDocumentation\.Markdown\.Sections\.ExceptionSection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/ExceptionSection/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.ExceptionSection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[ExplicitInterfaceImplementationsSection](DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ExplicitInterfaceImplementationsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [ExplicitInterfaceImplementationDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/ExplicitInterfaceImplementationDocItem/index.md 'DefaultDocumentation\.Models\.Members\.ExplicitInterfaceImplementationDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[ExplicitInterfaceImplementationsSection\(\)](DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/ExplicitInterfaceImplementationsSection().md 'DefaultDocumentation\.Markdown\.Sections\.ExplicitInterfaceImplementationsSection\.ExplicitInterfaceImplementationsSection\(\)')** `Constructor` Initialize a new instance of the [ExplicitInterfaceImplementationsSection](DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ExplicitInterfaceImplementationsSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ExplicitInterfaceImplementationsSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/ExplicitInterfaceImplementationsSection/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ExplicitInterfaceImplementationsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. +- **[FieldsSection](DefaultDocumentation/Markdown/Sections/FieldsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.FieldsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [FieldDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/FieldDocItem/index.md 'DefaultDocumentation\.Models\.Members\.FieldDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[FieldsSection\(\)](DefaultDocumentation/Markdown/Sections/FieldsSection/FieldsSection().md 'DefaultDocumentation\.Markdown\.Sections\.FieldsSection\.FieldsSection\(\)')** `Constructor` Initialize a new instance of the [FieldsSection](DefaultDocumentation/Markdown/Sections/FieldsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.FieldsSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/FieldsSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.FieldsSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/FieldsSection/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.FieldsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. +- **[FieldValueSection](DefaultDocumentation/Markdown/Sections/FieldValueSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.FieldValueSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the field type of [FieldDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/FieldDocItem/index.md 'DefaultDocumentation\.Models\.Members\.FieldDocItem')\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/FieldValueSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.FieldValueSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Sections/FieldValueSection/Name.md 'DefaultDocumentation\.Markdown\.Sections\.FieldValueSection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/FieldValueSection/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.FieldValueSection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[FooterSection](DefaultDocumentation/Markdown/Sections/FooterSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.FooterSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write a link to [DefaultDocumentation](https://github.com/Doraku/DefaultDocumentation 'https://github\.com/Doraku/DefaultDocumentation')\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/FooterSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.FooterSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Sections/FooterSection/Name.md 'DefaultDocumentation\.Markdown\.Sections\.FooterSection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/FooterSection/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.FooterSection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[HeaderSection](DefaultDocumentation/Markdown/Sections/HeaderSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.HeaderSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write a link to the top level documentation page\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/HeaderSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.HeaderSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Sections/HeaderSection/Name.md 'DefaultDocumentation\.Markdown\.Sections\.HeaderSection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/HeaderSection/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.HeaderSection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[ImplementSection](DefaultDocumentation/Markdown/Sections/ImplementSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ImplementSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the types/members implemented by the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/ImplementSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ImplementSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Sections/ImplementSection/Name.md 'DefaultDocumentation\.Markdown\.Sections\.ImplementSection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/ImplementSection/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.ImplementSection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[InheritanceSection](DefaultDocumentation/Markdown/Sections/InheritanceSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.InheritanceSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the types inherited by the [TypeDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/TypeDocItem/index.md 'DefaultDocumentation\.Models\.Types\.TypeDocItem')\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/InheritanceSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.InheritanceSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Sections/InheritanceSection/Name.md 'DefaultDocumentation\.Markdown\.Sections\.InheritanceSection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/InheritanceSection/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.InheritanceSection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[InterfacesSection](DefaultDocumentation/Markdown/Sections/InterfacesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.InterfacesSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [InterfaceDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/InterfaceDocItem/index.md 'DefaultDocumentation\.Models\.Types\.InterfaceDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[InterfacesSection\(\)](DefaultDocumentation/Markdown/Sections/InterfacesSection/InterfacesSection().md 'DefaultDocumentation\.Markdown\.Sections\.InterfacesSection\.InterfacesSection\(\)')** `Constructor` Initialize a new instance of the [InterfacesSection](DefaultDocumentation/Markdown/Sections/InterfacesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.InterfacesSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/InterfacesSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.InterfacesSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/InterfacesSection/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.InterfacesSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. +- **[MethodOverloadsSection](DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodOverloadsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [MethodOverloadsSection](DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodOverloadsSection') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[MethodOverloadsSection\(\)](DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/MethodOverloadsSection().md 'DefaultDocumentation\.Markdown\.Sections\.MethodOverloadsSection\.MethodOverloadsSection\(\)')** `Constructor` Initialize a new instance of the [ConstructorsSection](DefaultDocumentation/Markdown/Sections/ConstructorsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ConstructorsSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.MethodOverloadsSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[GetChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.MethodOverloadsSection\.GetChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/MethodOverloadsSection/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.MethodOverloadsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. +- **[MethodsSection](DefaultDocumentation/Markdown/Sections/MethodsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [MethodDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/MethodDocItem/index.md 'DefaultDocumentation\.Models\.Members\.MethodDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[MethodsSection\(\)](DefaultDocumentation/Markdown/Sections/MethodsSection/MethodsSection().md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection\.MethodsSection\(\)')** `Constructor` Initialize a new instance of the [MethodsSection](DefaultDocumentation/Markdown/Sections/MethodsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/MethodsSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[GetChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/MethodsSection/GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection\.GetChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/MethodsSection/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. + - **[ShouldWriteTitle\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/MethodsSection/ShouldWriteTitle(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.MethodsSection\.ShouldWriteTitle\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the title should be writen or not\. +- **[NamespacesSection](DefaultDocumentation/Markdown/Sections/NamespacesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.NamespacesSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [NamespaceDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/NamespaceDocItem/index.md 'DefaultDocumentation\.Models\.NamespaceDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[NamespacesSection\(\)](DefaultDocumentation/Markdown/Sections/NamespacesSection/NamespacesSection().md 'DefaultDocumentation\.Markdown\.Sections\.NamespacesSection\.NamespacesSection\(\)')** `Constructor` Initialize a new instance of the [NamespacesSection](DefaultDocumentation/Markdown/Sections/NamespacesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.NamespacesSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/NamespacesSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.NamespacesSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/NamespacesSection/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.NamespacesSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. +- **[OperatorsSection](DefaultDocumentation/Markdown/Sections/OperatorsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.OperatorsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [OperatorDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/OperatorDocItem/index.md 'DefaultDocumentation\.Models\.Members\.OperatorDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[OperatorsSection\(\)](DefaultDocumentation/Markdown/Sections/OperatorsSection/OperatorsSection().md 'DefaultDocumentation\.Markdown\.Sections\.OperatorsSection\.OperatorsSection\(\)')** `Constructor` Initialize a new instance of the [OperatorsSection](DefaultDocumentation/Markdown/Sections/OperatorsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.OperatorsSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/OperatorsSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.OperatorsSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/OperatorsSection/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.OperatorsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. +- **[ParametersSection](DefaultDocumentation/Markdown/Sections/ParametersSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ParametersSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [ParameterDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Parameters/ParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.ParameterDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[ParametersSection\(\)](DefaultDocumentation/Markdown/Sections/ParametersSection/ParametersSection().md 'DefaultDocumentation\.Markdown\.Sections\.ParametersSection\.ParametersSection\(\)')** `Constructor` Initialize a new instance of the [ParametersSection](DefaultDocumentation/Markdown/Sections/ParametersSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ParametersSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/ParametersSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ParametersSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[GetChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/ParametersSection/GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ParametersSection\.GetChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/ParametersSection/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.ParametersSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. +- **[PropertiesSection](DefaultDocumentation/Markdown/Sections/PropertiesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.PropertiesSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [PropertyDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Members/PropertyDocItem/index.md 'DefaultDocumentation\.Models\.Members\.PropertyDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[PropertiesSection\(\)](DefaultDocumentation/Markdown/Sections/PropertiesSection/PropertiesSection().md 'DefaultDocumentation\.Markdown\.Sections\.PropertiesSection\.PropertiesSection\(\)')** `Constructor` Initialize a new instance of the [PropertiesSection](DefaultDocumentation/Markdown/Sections/PropertiesSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.PropertiesSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/PropertiesSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.PropertiesSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/PropertiesSection/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.PropertiesSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. +- **[RemarksSection](DefaultDocumentation/Markdown/Sections/RemarksSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.RemarksSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the `remarks` top level element\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/RemarksSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.RemarksSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Sections/RemarksSection/Name.md 'DefaultDocumentation\.Markdown\.Sections\.RemarksSection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/RemarksSection/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.RemarksSection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[ReturnsSection](DefaultDocumentation/Markdown/Sections/ReturnsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ReturnsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the `returns` top level element\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/ReturnsSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ReturnsSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Sections/ReturnsSection/Name.md 'DefaultDocumentation\.Markdown\.Sections\.ReturnsSection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/ReturnsSection/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.ReturnsSection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[SeeAlsoSection](DefaultDocumentation/Markdown/Sections/SeeAlsoSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.SeeAlsoSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the `seealso` top level elements\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/SeeAlsoSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.SeeAlsoSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Sections/SeeAlsoSection/Name.md 'DefaultDocumentation\.Markdown\.Sections\.SeeAlsoSection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/SeeAlsoSection/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.SeeAlsoSection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[StructsSection](DefaultDocumentation/Markdown/Sections/StructsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.StructsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [StructDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Types/StructDocItem/index.md 'DefaultDocumentation\.Models\.Types\.StructDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[StructsSection\(\)](DefaultDocumentation/Markdown/Sections/StructsSection/StructsSection().md 'DefaultDocumentation\.Markdown\.Sections\.StructsSection\.StructsSection\(\)')** `Constructor` Initialize a new instance of the [StructsSection](DefaultDocumentation/Markdown/Sections/StructsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.StructsSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/StructsSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.StructsSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/StructsSection/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.StructsSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. +- **[SummarySection](DefaultDocumentation/Markdown/Sections/SummarySection/index.md 'DefaultDocumentation\.Markdown\.Sections\.SummarySection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the `summary` top level element\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/SummarySection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.SummarySection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Sections/SummarySection/Name.md 'DefaultDocumentation\.Markdown\.Sections\.SummarySection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/SummarySection/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.SummarySection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[TableOfContentsSection](DefaultDocumentation/Markdown/Sections/TableOfContentsSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write a table of content of all children of the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/TableOfContentsSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Name.md 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[TitleSection](DefaultDocumentation/Markdown/Sections/TitleSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.TitleSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write a title of the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/TitleSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.TitleSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Sections/TitleSection/Name.md 'DefaultDocumentation\.Markdown\.Sections\.TitleSection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/TitleSection/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.TitleSection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[TypeParametersSection](DefaultDocumentation/Markdown/Sections/TypeParametersSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.TypeParametersSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write [TypeParameterDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/Parameters/TypeParameterDocItem/index.md 'DefaultDocumentation\.Models\.Parameters\.TypeParameterDocItem') children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[TypeParametersSection\(\)](DefaultDocumentation/Markdown/Sections/TypeParametersSection/TypeParametersSection().md 'DefaultDocumentation\.Markdown\.Sections\.TypeParametersSection\.TypeParametersSection\(\)')** `Constructor` Initialize a new instance of the [TypeParametersSection](DefaultDocumentation/Markdown/Sections/TypeParametersSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.TypeParametersSection') type\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/TypeParametersSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.TypeParametersSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[GetChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/TypeParametersSection/GetChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.TypeParametersSection\.GetChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the children of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') to write\. + - **[ShouldInlineChildren\(IGeneralContext, DocItem\)](DefaultDocumentation/Markdown/Sections/TypeParametersSection/ShouldInlineChildren(IGeneralContext,DocItem).md 'DefaultDocumentation\.Markdown\.Sections\.TypeParametersSection\.ShouldInlineChildren\(DefaultDocumentation\.IGeneralContext, DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets if the children should be inlined or not\. +- **[ValueSection](DefaultDocumentation/Markdown/Sections/ValueSection/index.md 'DefaultDocumentation\.Markdown\.Sections\.ValueSection')** `Class` [ISection](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/ISection/index.md 'DefaultDocumentation\.Api\.ISection') implementation to write the `value` top level element\. + - **[ConfigName](DefaultDocumentation/Markdown/Sections/ValueSection/ConfigName.md 'DefaultDocumentation\.Markdown\.Sections\.ValueSection\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/Sections/ValueSection/Name.md 'DefaultDocumentation\.Markdown\.Sections\.ValueSection\.Name')** `Property` Gets the name of the section, used to identify it at the configuration level\. + - **[Write\(IWriter\)](DefaultDocumentation/Markdown/Sections/ValueSection/Write(IWriter).md 'DefaultDocumentation\.Markdown\.Sections\.ValueSection\.Write\(DefaultDocumentation\.Api\.IWriter\)')** `Method` Writes the section to a given [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter')\. +- **[TableOfContentsSection\.Modes](DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection\.Modes')** `Enum` The different options to customize the table of contents\. + - **[Grouped](DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.Grouped 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection\.Modes\.Grouped')** `Field` [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') will appear in their kind section\. + - **[IncludeKind](DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeKind 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection\.Modes\.IncludeKind')** `Field` The kind of each [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') will appear explicitely\. + - **[IncludeNewLine](DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeNewLine 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection\.Modes\.IncludeNewLine')** `Field` There should be a new line when displaying the summary of the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[IncludeSummary](DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummary 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection\.Modes\.IncludeSummary')** `Field` The summary of each [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') will be displayed\. + - **[IncludeSummaryWithNewLine](DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummaryWithNewLine 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection\.Modes\.IncludeSummaryWithNewLine')** `Field` Same as [IncludeSummary](DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeSummary 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection\.Modes\.IncludeSummary') and [IncludeNewLine](DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.IncludeNewLine 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection\.Modes\.IncludeNewLine') + - **[None](DefaultDocumentation/Markdown/Sections/TableOfContentsSection/Modes/index.md#DefaultDocumentation.Markdown.Sections.TableOfContentsSection.Modes.None 'DefaultDocumentation\.Markdown\.Sections\.TableOfContentsSection\.Modes\.None')** `Field` Default generation\. -## DefaultDocumentation.Markdown.UrlFactories Namespace -- **[DocItemFactory](DocItemFactory.md 'DefaultDocumentation.Markdown.UrlFactories.DocItemFactory')** `Class` Handles id for known [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'). - - **[ConfigName](DocItemFactory.ConfigName.md 'DefaultDocumentation.Markdown.UrlFactories.DocItemFactory.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](DocItemFactory.Name.md 'DefaultDocumentation.Markdown.UrlFactories.DocItemFactory.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level. - - **[GetUrl(IGeneralContext, string)](DocItemFactory.GetUrl(IGeneralContext,string).md 'DefaultDocumentation.Markdown.UrlFactories.DocItemFactory.GetUrl(DefaultDocumentation.IGeneralContext, string)')** `Method` Gets the url of the given id. Returns null of the instance does not know how to handle the provided id. -- **[DotnetApiFactory](DotnetApiFactory.md 'DefaultDocumentation.Markdown.UrlFactories.DotnetApiFactory')** `Class` Transforms any id as a dotnet api url. - - **[ConfigName](DotnetApiFactory.ConfigName.md 'DefaultDocumentation.Markdown.UrlFactories.DotnetApiFactory.ConfigName')** `Field` The name of this implementation used at the configuration level. - - **[Name](DotnetApiFactory.Name.md 'DefaultDocumentation.Markdown.UrlFactories.DotnetApiFactory.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level. - - **[GetUrl(IGeneralContext, string)](DotnetApiFactory.GetUrl(IGeneralContext,string).md 'DefaultDocumentation.Markdown.UrlFactories.DotnetApiFactory.GetUrl(DefaultDocumentation.IGeneralContext, string)')** `Method` Gets the url of the given id. Returns null of the instance does not know how to handle the provided id. +## DefaultDocumentation\.Markdown\.UrlFactories Namespace +- **[DocItemFactory](DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/index.md 'DefaultDocumentation\.Markdown\.UrlFactories\.DocItemFactory')** `Class` Handles id for known [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem')\. + - **[ConfigName](DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/ConfigName.md 'DefaultDocumentation\.Markdown\.UrlFactories\.DocItemFactory\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/Name.md 'DefaultDocumentation\.Markdown\.UrlFactories\.DocItemFactory\.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level\. + - **[GetUrl\(IPageContext, string\)](DefaultDocumentation/Markdown/UrlFactories/DocItemFactory/GetUrl(IPageContext,string).md 'DefaultDocumentation\.Markdown\.UrlFactories\.DocItemFactory\.GetUrl\(DefaultDocumentation\.IPageContext, string\)')** `Method` Gets the url of the given id\. Returns null of the instance does not know how to handle the provided id\. +- **[DotnetApiFactory](DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/index.md 'DefaultDocumentation\.Markdown\.UrlFactories\.DotnetApiFactory')** `Class` Transforms any id as a dotnet api url\. + - **[ConfigName](DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/ConfigName.md 'DefaultDocumentation\.Markdown\.UrlFactories\.DotnetApiFactory\.ConfigName')** `Field` The name of this implementation used at the configuration level\. + - **[Name](DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/Name.md 'DefaultDocumentation\.Markdown\.UrlFactories\.DotnetApiFactory\.Name')** `Property` Gets the name of the factory, used to identify it at the configuration level\. + - **[GetUrl\(IPageContext, string\)](DefaultDocumentation/Markdown/UrlFactories/DotnetApiFactory/GetUrl(IPageContext,string).md 'DefaultDocumentation\.Markdown\.UrlFactories\.DotnetApiFactory\.GetUrl\(DefaultDocumentation\.IPageContext, string\)')** `Method` Gets the url of the given id\. Returns null of the instance does not know how to handle the provided id\. -## DefaultDocumentation.Markdown.Writers Namespace -- **[MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter')** `Class` Decorator of the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') type to handle the [Markdown.IgnoreLineBreak](https://github.com/Doraku/DefaultDocumentation#ignorelinebreak 'https://github.com/Doraku/DefaultDocumentation#ignorelinebreak') setting. - It also uses a [OverrideWriter](OverrideWriter.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter') internally to further decorate the instance. - - **[MarkdownWriter(IWriter)](MarkdownWriter.MarkdownWriter(IWriter).md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter.MarkdownWriter(DefaultDocumentation.Api.IWriter)')** `Constructor` Initializes a new instance of the [MarkdownWriter](MarkdownWriter.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter') type. - - **[Context](MarkdownWriter.Context.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter.Context')** `Property` Gets the [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - - **[DocItem](MarkdownWriter.DocItem.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter.DocItem')** `Property` Gets the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which the documentation is being generated. - - **[Length](MarkdownWriter.Length.md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter.Length')** `Property` Gets or sets the length of the documentation text currently produced. - - **[this[string]](MarkdownWriter.this[string].md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter.this[string]')** `Property` Gets or sets extra data for the current [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') documentation generation. - - **[Append(string)](MarkdownWriter.Append(string).md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter.Append(string)')** `Method` Appends a string at the end of the documentation text. - - **[AppendLine()](MarkdownWriter.AppendLine().md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter.AppendLine()')** `Method` Appends a [System.Environment.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System.Environment.NewLine') or a `` at the end of the documentation text depending of the current setting. - - **[EndsWith(string)](MarkdownWriter.EndsWith(string).md 'DefaultDocumentation.Markdown.Writers.MarkdownWriter.EndsWith(string)')** `Method` Returns whether the documentation text ends with the given string. -- **[OverrideWriter](OverrideWriter.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter')** `Class` Decorator of the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') type to override its data without changing its actual values. - - **[OverrideWriter(IWriter)](OverrideWriter.OverrideWriter(IWriter).md 'DefaultDocumentation.Markdown.Writers.OverrideWriter.OverrideWriter(DefaultDocumentation.Api.IWriter)')** `Constructor` Initializes a new instance of the [OverrideWriter](OverrideWriter.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter') type. - - **[Context](OverrideWriter.Context.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter.Context')** `Property` Gets the [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - - **[DocItem](OverrideWriter.DocItem.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter.DocItem')** `Property` Gets the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which the documentation is being generated. - - **[Length](OverrideWriter.Length.md 'DefaultDocumentation.Markdown.Writers.OverrideWriter.Length')** `Property` Gets or sets the length of the documentation text currently produced. - - **[this[string]](OverrideWriter.this[string].md 'DefaultDocumentation.Markdown.Writers.OverrideWriter.this[string]')** `Property` Gets or sets extra data for the current [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') documentation generation. - - **[Append(string)](OverrideWriter.Append(string).md 'DefaultDocumentation.Markdown.Writers.OverrideWriter.Append(string)')** `Method` Appends a string at the end of the documentation text. - - **[AppendLine()](OverrideWriter.AppendLine().md 'DefaultDocumentation.Markdown.Writers.OverrideWriter.AppendLine()')** `Method` Appends a [System.Environment.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System.Environment.NewLine') at the end of the documentation text. - - **[EndsWith(string)](OverrideWriter.EndsWith(string).md 'DefaultDocumentation.Markdown.Writers.OverrideWriter.EndsWith(string)')** `Method` Returns whether the documentation text ends with the given string. -- **[PrefixedWriter](PrefixedWriter.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter')** `Class` Decorator of the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IWriter.md 'DefaultDocumentation.Api.IWriter') type to prefix every new line with a specific [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String'). - - **[PrefixedWriter(IWriter, string)](PrefixedWriter.PrefixedWriter(IWriter,string).md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter.PrefixedWriter(DefaultDocumentation.Api.IWriter, string)')** `Constructor` Initializes a new instance of the [PrefixedWriter](PrefixedWriter.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter') type. - - **[Context](PrefixedWriter.Context.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter.Context')** `Property` Gets the [IGeneralContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/IGeneralContext.md 'DefaultDocumentation.IGeneralContext') of the current documentation generation process. - - **[DocItem](PrefixedWriter.DocItem.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter.DocItem')** `Property` Gets the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') for which the documentation is being generated. - - **[Length](PrefixedWriter.Length.md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter.Length')** `Property` Gets or sets the length of the documentation text currently produced. - - **[this[string]](PrefixedWriter.this[string].md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter.this[string]')** `Property` Gets or sets extra data for the current [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') documentation generation. - - **[Append(string)](PrefixedWriter.Append(string).md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter.Append(string)')** `Method` Appends a string at the end of the documentation text. - - **[AppendLine()](PrefixedWriter.AppendLine().md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter.AppendLine()')** `Method` Appends a [System.Environment.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System.Environment.NewLine') at the end of the documentation text. - - **[EndsWith(string)](PrefixedWriter.EndsWith(string).md 'DefaultDocumentation.Markdown.Writers.PrefixedWriter.EndsWith(string)')** `Method` Returns whether the documentation text ends with the given string. +## DefaultDocumentation\.Markdown\.Writers Namespace +- **[MarkdownWriter](DefaultDocumentation/Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter')** `Class` Decorator of the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') type to handle the [Markdown\.HandleLineBreak](https://github.com/Doraku/DefaultDocumentation#HandleLineBreak 'https://github\.com/Doraku/DefaultDocumentation\#HandleLineBreak') setting\. It also uses a [OverrideWriter](DefaultDocumentation/Markdown/Writers/OverrideWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter') internally to further decorate the instance\. + - **[MarkdownWriter\(IWriter\)](DefaultDocumentation/Markdown/Writers/MarkdownWriter/MarkdownWriter(IWriter).md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter\.MarkdownWriter\(DefaultDocumentation\.Api\.IWriter\)')** `Constructor` Initializes a new instance of the [MarkdownWriter](DefaultDocumentation/Markdown/Writers/MarkdownWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter') type\. + - **[Context](DefaultDocumentation/Markdown/Writers/MarkdownWriter/Context.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter\.Context')** `Property` Gets the [IPageContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext') of the current documentation generation process\. + - **[Length](DefaultDocumentation/Markdown/Writers/MarkdownWriter/Length.md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter\.Length')** `Property` Gets or sets the length of the documentation text currently produced\. + - **[Append\(string\)](DefaultDocumentation/Markdown/Writers/MarkdownWriter/Append(string).md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter\.Append\(string\)')** `Method` Appends a string at the end of the documentation text\. + - **[AppendLine\(\)](DefaultDocumentation/Markdown/Writers/MarkdownWriter/AppendLine().md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter\.AppendLine\(\)')** `Method` Appends a [System\.Environment\.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System\.Environment\.NewLine') or a `` at the end of the documentation text depending of the current setting\. + - **[EndsWith\(string\)](DefaultDocumentation/Markdown/Writers/MarkdownWriter/EndsWith(string).md 'DefaultDocumentation\.Markdown\.Writers\.MarkdownWriter\.EndsWith\(string\)')** `Method` Returns whether the documentation text ends with the given string\. +- **[OverrideWriter](DefaultDocumentation/Markdown/Writers/OverrideWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter')** `Class` Decorator of the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') type to override its data without changing its actual values\. + - **[OverrideWriter\(IWriter\)](DefaultDocumentation/Markdown/Writers/OverrideWriter/OverrideWriter(IWriter).md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter\.OverrideWriter\(DefaultDocumentation\.Api\.IWriter\)')** `Constructor` Initializes a new instance of the [OverrideWriter](DefaultDocumentation/Markdown/Writers/OverrideWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter') type\. + - **[Context](DefaultDocumentation/Markdown/Writers/OverrideWriter/Context.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter\.Context')** `Property` Gets the [IPageContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext') of the current documentation generation process\. + - **[Length](DefaultDocumentation/Markdown/Writers/OverrideWriter/Length.md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter\.Length')** `Property` Gets or sets the length of the documentation text currently produced\. + - **[Append\(string\)](DefaultDocumentation/Markdown/Writers/OverrideWriter/Append(string).md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter\.Append\(string\)')** `Method` Appends a string at the end of the documentation text\. + - **[AppendLine\(\)](DefaultDocumentation/Markdown/Writers/OverrideWriter/AppendLine().md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter\.AppendLine\(\)')** `Method` Appends a [System\.Environment\.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System\.Environment\.NewLine') at the end of the documentation text\. + - **[EndsWith\(string\)](DefaultDocumentation/Markdown/Writers/OverrideWriter/EndsWith(string).md 'DefaultDocumentation\.Markdown\.Writers\.OverrideWriter\.EndsWith\(string\)')** `Method` Returns whether the documentation text ends with the given string\. +- **[PrefixedWriter](DefaultDocumentation/Markdown/Writers/PrefixedWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter')** `Class` Decorator of the [IWriter](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Api/IWriter/index.md 'DefaultDocumentation\.Api\.IWriter') type to prefix every new line with a specific [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')\. + - **[PrefixedWriter\(IWriter, string\)](DefaultDocumentation/Markdown/Writers/PrefixedWriter/PrefixedWriter(IWriter,string).md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter\.PrefixedWriter\(DefaultDocumentation\.Api\.IWriter, string\)')** `Constructor` Initializes a new instance of the [PrefixedWriter](DefaultDocumentation/Markdown/Writers/PrefixedWriter/index.md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter') type\. + - **[Context](DefaultDocumentation/Markdown/Writers/PrefixedWriter/Context.md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter\.Context')** `Property` Gets the [IPageContext](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/IPageContext/index.md 'DefaultDocumentation\.IPageContext') of the current documentation generation process\. + - **[Length](DefaultDocumentation/Markdown/Writers/PrefixedWriter/Length.md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter\.Length')** `Property` Gets or sets the length of the documentation text currently produced\. + - **[Append\(string\)](DefaultDocumentation/Markdown/Writers/PrefixedWriter/Append(string).md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter\.Append\(string\)')** `Method` Appends a string at the end of the documentation text\. + - **[AppendLine\(\)](DefaultDocumentation/Markdown/Writers/PrefixedWriter/AppendLine().md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter\.AppendLine\(\)')** `Method` Appends a [System\.Environment\.NewLine](https://docs.microsoft.com/en-us/dotnet/api/System.Environment.NewLine 'System\.Environment\.NewLine') at the end of the documentation text\. + - **[EndsWith\(string\)](DefaultDocumentation/Markdown/Writers/PrefixedWriter/EndsWith(string).md 'DefaultDocumentation\.Markdown\.Writers\.PrefixedWriter\.EndsWith\(string\)')** `Method` Returns whether the documentation text ends with the given string\. -## DefaultDocumentation.Models Namespace -- **[DocItemExtension](DocItemExtension.md 'DefaultDocumentation.Models.DocItemExtension')** `Class` Provides extension methods on the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem') type. - - **[GetLongName(this DocItem)](DocItemExtension.GetLongName(thisDocItem).md 'DefaultDocumentation.Models.DocItemExtension.GetLongName(this DefaultDocumentation.Models.DocItem)')** `Method` Gets the long name of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DocItem.md 'DefaultDocumentation.Models.DocItem'), being its full name without its namespace. - This method should not be called on [AssemblyDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/AssemblyDocItem.md 'DefaultDocumentation.Models.AssemblyDocItem') or [NamespaceDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/NamespaceDocItem.md 'DefaultDocumentation.Models.NamespaceDocItem') types. \ No newline at end of file +## DefaultDocumentation\.Models Namespace +- **[DocItemExtensions](DefaultDocumentation/Models/DocItemExtensions/index.md 'DefaultDocumentation\.Models\.DocItemExtensions')** `Class` Provides extension methods on the [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem') type\. + - **[GetLongName\(this DocItem\)](DefaultDocumentation/Models/DocItemExtensions/GetLongName(thisDocItem).md 'DefaultDocumentation\.Models\.DocItemExtensions\.GetLongName\(this DefaultDocumentation\.Models\.DocItem\)')** `Method` Gets the long name of a [DocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/DocItem/index.md 'DefaultDocumentation\.Models\.DocItem'), being its full name without its namespace\. This method should not be called on [AssemblyDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/AssemblyDocItem/index.md 'DefaultDocumentation\.Models\.AssemblyDocItem') or [NamespaceDocItem](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/DefaultDocumentation/Models/NamespaceDocItem/index.md 'DefaultDocumentation\.Models\.NamespaceDocItem') types\. + +--- +Generated by [DefaultDocumentation](https://github.com/Doraku/DefaultDocumentation 'https://github\.com/Doraku/DefaultDocumentation') \ No newline at end of file diff --git a/source/DefaultDocumentation.Api/DefaultDocumentation.json b/source/DefaultDocumentation.Api/DefaultDocumentation.json index 527caee0..28be4267 100644 --- a/source/DefaultDocumentation.Api/DefaultDocumentation.json +++ b/source/DefaultDocumentation.Api/DefaultDocumentation.json @@ -3,7 +3,7 @@ "OutputDirectoryPath": "..\\..\\documentation\\api", "GeneratedAccessModifiers": "Public,Protected,ProtectedInternal", "GeneratedPages": "Assembly,Types,Members", - "FileNameFactory": "Name", + "FileNameFactory": "DirectoryName", "ExternLinksFilePaths": [ "..\\..\\documentation\\ICSharpCode.Decompiler.txt" ], diff --git a/source/DefaultDocumentation.Common/Internal/DocItemGenerators/DocItemReader.cs b/source/DefaultDocumentation.Common/Internal/DocItemGenerators/DocItemReader.cs index b73fc6b6..a155deda 100644 --- a/source/DefaultDocumentation.Common/Internal/DocItemGenerators/DocItemReader.cs +++ b/source/DefaultDocumentation.Common/Internal/DocItemGenerators/DocItemReader.cs @@ -133,9 +133,10 @@ private bool TryGetDocumentation(IEntity? entity, [NotNullWhen(true)] out XEleme public void Execute() { AssemblyDocItem assemblyDocItem = new( - _context.Settings.AssemblyPageName ?? "index", - _decompiler.TypeSystem.MainModule.AssemblyName, - GetDocumentation($"T:{_decompiler.TypeSystem.MainModule.AssemblyName}.AssemblyDoc")); + _context.Settings.AssemblyPageName ?? "index", + _decompiler.TypeSystem.MainModule.AssemblyName, + GetDocumentation($"T:{_decompiler.TypeSystem.MainModule.AssemblyName}.AssemblyDoc")); + _context.Add(assemblyDocItem); foreach (ITypeDefinition type in _decompiler.TypeSystem.MainModule.TypeDefinitions.Where(type => type.Name is not "NamespaceDoc" and not "AssemblyDoc")) diff --git a/source/DefaultDocumentation.Markdown/DefaultDocumentation.json b/source/DefaultDocumentation.Markdown/DefaultDocumentation.json index 79575e7e..e168939c 100644 --- a/source/DefaultDocumentation.Markdown/DefaultDocumentation.json +++ b/source/DefaultDocumentation.Markdown/DefaultDocumentation.json @@ -3,7 +3,7 @@ "OutputDirectoryPath": "..\\..\\documentation\\markdown", "GeneratedAccessModifiers": "Public,Protected,ProtectedInternal", "GeneratedPages": "Assembly,Types,Members", - "FileNameFactory": "Name", + "FileNameFactory": "DirectoryName", "ExternLinksFilePaths": [ "..\\..\\documentation\\ICSharpCode.Decompiler.txt", "..\\..\\documentation\\DefaultDocumentation.Api.txt" diff --git a/source/DefaultDocumentation.Markdown/FileNameFactories/BaseMarkdownFileNameFactory.cs b/source/DefaultDocumentation.Markdown/FileNameFactories/BaseMarkdownFileNameFactory.cs index eb11336c..7bcc7d3d 100644 --- a/source/DefaultDocumentation.Markdown/FileNameFactories/BaseMarkdownFileNameFactory.cs +++ b/source/DefaultDocumentation.Markdown/FileNameFactories/BaseMarkdownFileNameFactory.cs @@ -69,5 +69,11 @@ public void Clean(IGeneralContext context) } /// - public string GetFileName(IGeneralContext context, DocItem item) => PathCleaner.Clean(item is AssemblyDocItem ? item.FullName : GetMarkdownFileName(context, item), context.GetInvalidCharReplacement()) + ".md"; + public string GetFileName(IGeneralContext context, DocItem item) + { + context.ThrowIfNull(); + item.ThrowIfNull(); + + return PathCleaner.Clean(item is AssemblyDocItem ? item.FullName : GetMarkdownFileName(context, item), context.GetInvalidCharReplacement()) + ".md"; + } } diff --git a/source/DefaultDocumentation.Markdown/FileNameFactories/DirectoryNameFactory.cs b/source/DefaultDocumentation.Markdown/FileNameFactories/DirectoryNameFactory.cs new file mode 100644 index 00000000..3d5226ed --- /dev/null +++ b/source/DefaultDocumentation.Markdown/FileNameFactories/DirectoryNameFactory.cs @@ -0,0 +1,124 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Threading; +using DefaultDocumentation.Api; +using DefaultDocumentation.Markdown.Internal; +using DefaultDocumentation.Models; +using DefaultDocumentation.Models.Types; + +namespace DefaultDocumentation.Markdown.FileNameFactories; + +/// +/// implementation using as file name in a directory hierarchy. +/// +public sealed class DirectoryNameFactory : IFileNameFactory +{ + /// + /// The name of this implementation used at the configuration level. + /// + public const string ConfigName = "DirectoryName"; + + /// + public string Name => ConfigName; + + /// + [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1851:Possible multiple enumerations of 'IEnumerable' collection", Justification = "exepected")] + public void Clean(IGeneralContext context) + { + context.ThrowIfNull(); + + context.Settings.Logger.Debug($"Cleaning output folder \"{context.Settings.OutputDirectory}\""); + + if (context.Settings.OutputDirectory.Exists) + { + IEnumerable files = context.Settings.OutputDirectory.EnumerateFiles("*.md", SearchOption.AllDirectories).Where(file => !string.Equals(file.Name, "readme.md", StringComparison.OrdinalIgnoreCase)); + + int i; + + foreach (FileInfo file in files) + { + i = 3; +start: + try + { + file.Delete(); + } + catch + { + if (--i > 0) + { + Thread.Sleep(100); + goto start; + } + + throw; + } + } + + i = 3; + while (files.Any() && i-- > 0) + { + Thread.Sleep(1000); + } + } + } + + /// + public string GetFileName(IGeneralContext context, DocItem item) + { + context.ThrowIfNull(); + item.ThrowIfNull(); + + static IEnumerable GetParentsNames(DocItem item) + { + foreach (DocItem parent in item.GetParents().Skip(1)) + { + if (parent is NamespaceDocItem) + { + foreach (string @namespace in parent.Name.Split('.')) + { + yield return @namespace; + } + } + else + { + yield return parent.Name; + } + } + } + + static IEnumerable GetNames(DocItem item) + { + if (item is AssemblyDocItem) + { + yield return item.FullName; + } + else if (item is NamespaceDocItem) + { + foreach (string @namespace in item.Name.Split('.')) + { + yield return @namespace; + } + + yield return "index"; + } + else if (item is TypeDocItem) + { + yield return item.Name; + yield return "index"; + } + else + { + yield return item.Name; + } + } + + return PathCleaner.Clean( + string.Join( + "/", + GetParentsNames(item).Concat(GetNames(item))), + context.GetInvalidCharReplacement()) + ".md"; + } +} diff --git a/source/DefaultDocumentation.Markdown/FileNameFactories/FullNameFactory.cs b/source/DefaultDocumentation.Markdown/FileNameFactories/FullNameFactory.cs index f92815e6..6934150a 100644 --- a/source/DefaultDocumentation.Markdown/FileNameFactories/FullNameFactory.cs +++ b/source/DefaultDocumentation.Markdown/FileNameFactories/FullNameFactory.cs @@ -1,4 +1,5 @@ -using DefaultDocumentation.Models; +using System; +using DefaultDocumentation.Models; namespace DefaultDocumentation.Markdown.FileNameFactories; @@ -16,5 +17,11 @@ public sealed class FullNameFactory : BaseMarkdownFileNameFactory public override string Name => ConfigName; /// - protected override string GetMarkdownFileName(IGeneralContext context, DocItem item) => item.FullName; + protected override string GetMarkdownFileName(IGeneralContext context, DocItem item) + { + context.ThrowIfNull(); + item.ThrowIfNull(); + + return item.FullName; + } } diff --git a/source/DefaultDocumentation.Markdown/FileNameFactories/Md5Factory.cs b/source/DefaultDocumentation.Markdown/FileNameFactories/Md5Factory.cs index 3c943046..02625f12 100644 --- a/source/DefaultDocumentation.Markdown/FileNameFactories/Md5Factory.cs +++ b/source/DefaultDocumentation.Markdown/FileNameFactories/Md5Factory.cs @@ -21,7 +21,12 @@ public sealed class Md5Factory : BaseMarkdownFileNameFactory /// protected override string GetMarkdownFileName(IGeneralContext context, DocItem item) - => GetMd5HashBase36(item.FullName); + { + context.ThrowIfNull(); + item.ThrowIfNull(); + + return GetMd5HashBase36(item.FullName); + } [System.Diagnostics.CodeAnalysis.SuppressMessage("Security", "CA5351:Do Not Use Broken Cryptographic Algorithms", Justification = "not used for security")] internal static string GetMd5HashBase36(string text) diff --git a/source/DefaultDocumentation.Markdown/FileNameFactories/NameAndMd5MixFactory.cs b/source/DefaultDocumentation.Markdown/FileNameFactories/NameAndMd5MixFactory.cs index bda7c8ac..dbdb3ed2 100644 --- a/source/DefaultDocumentation.Markdown/FileNameFactories/NameAndMd5MixFactory.cs +++ b/source/DefaultDocumentation.Markdown/FileNameFactories/NameAndMd5MixFactory.cs @@ -1,4 +1,5 @@ -using System.Linq; +using System; +using System.Linq; using DefaultDocumentation.Models; namespace DefaultDocumentation.Markdown.FileNameFactories; @@ -19,6 +20,9 @@ public sealed class NameAndMd5MixFactory : BaseMarkdownFileNameFactory /// protected override string GetMarkdownFileName(IGeneralContext context, DocItem item) { + context.ThrowIfNull(); + item.ThrowIfNull(); + return item is EntityDocItem entity && item is IParameterizedDocItem parameterized && parameterized.Parameters.Any() ? $"{item.Parent!.GetLongName()}.{entity.Entity.Name}.{Md5Factory.GetMd5HashBase36(item.FullName)}" : item.GetLongName(); diff --git a/source/DefaultDocumentation.Markdown/FileNameFactories/NameFactory.cs b/source/DefaultDocumentation.Markdown/FileNameFactories/NameFactory.cs index c2aa6fb9..a9e94ffa 100644 --- a/source/DefaultDocumentation.Markdown/FileNameFactories/NameFactory.cs +++ b/source/DefaultDocumentation.Markdown/FileNameFactories/NameFactory.cs @@ -1,4 +1,5 @@ -using DefaultDocumentation.Models; +using System; +using DefaultDocumentation.Models; namespace DefaultDocumentation.Markdown.FileNameFactories; @@ -16,5 +17,11 @@ public sealed class NameFactory : BaseMarkdownFileNameFactory public override string Name => ConfigName; /// - protected override string GetMarkdownFileName(IGeneralContext context, DocItem item) => item.GetLongName(); + protected override string GetMarkdownFileName(IGeneralContext context, DocItem item) + { + context.ThrowIfNull(); + item.ThrowIfNull(); + + return item.GetLongName(); + } } diff --git a/source/DefaultDocumentation.Markdown/UrlFactories/DocItemFactory.cs b/source/DefaultDocumentation.Markdown/UrlFactories/DocItemFactory.cs index 1565d94c..939b9c54 100644 --- a/source/DefaultDocumentation.Markdown/UrlFactories/DocItemFactory.cs +++ b/source/DefaultDocumentation.Markdown/UrlFactories/DocItemFactory.cs @@ -69,6 +69,22 @@ public sealed class DocItemFactory : IUrlFactory { url = context.Settings.LinksBaseUrl!.Trim('/') + '/' + url; } + else if (pagedItem != context.DocItem) + { + string[] currentPageParts = context.GetFileName(context.DocItem).Split('/'); + if (currentPageParts.Length > 1) + { + string[] urlParts = url.Split('/'); + + int startPart = urlParts.Zip(currentPageParts, (first, second) => first.Equals(second, StringComparison.Ordinal)).TakeWhile(equal => equal).Count(); + + url = string.Join( + "/", + Enumerable + .Repeat("..", currentPageParts.Length - startPart - 1) + .Concat(urlParts.Skip(startPart))); + } + } if (context.GetRemoveFileExtensionFromUrl() && Path.HasExtension(url)) { diff --git a/source/Sample/DefaultDocumentation.PluginExample/DefaultDocumentation.PluginExample.csproj b/source/Sample/DefaultDocumentation.PluginExample/DefaultDocumentation.PluginExample.csproj index 2a7caea2..8e4df1cc 100644 --- a/source/Sample/DefaultDocumentation.PluginExample/DefaultDocumentation.PluginExample.csproj +++ b/source/Sample/DefaultDocumentation.PluginExample/DefaultDocumentation.PluginExample.csproj @@ -20,7 +20,7 @@ - + diff --git a/source/Sample/DefaultDocumentation.PluginExample/FolderFileNameFactory.cs b/source/Sample/DefaultDocumentation.PluginExample/FolderFileNameFactory.cs deleted file mode 100644 index abff5874..00000000 --- a/source/Sample/DefaultDocumentation.PluginExample/FolderFileNameFactory.cs +++ /dev/null @@ -1,99 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using System.Linq; -using System.Threading; -using DefaultDocumentation.Api; -using DefaultDocumentation.Models; - -namespace DefaultDocumentation.PluginExample; - -public sealed class FolderFileNameFactory : IFileNameFactory -{ - #region Markdown members not yet available in nuget - - private const string _invalidCharReplacementKey = "Markdown.InvalidCharReplacement"; - - private static string? GetInvalidCharReplacement(IGeneralContext context) - { - context.ThrowIfNull(); - - return context.GetSetting(_invalidCharReplacementKey); - } - - private static class PathCleaner - { - private static readonly string[] _toTrimChars = new[] { '=', ' ' }.Select(@char => $"{@char}").ToArray(); - private static readonly string[] _invalidChars = new[] { '\"', '<', '>', ':', '*', '?' }.Concat(Path.GetInvalidPathChars()).Select(@char => $"{@char}").ToArray(); - - public static string Clean(string value, string? invalidCharReplacement) - { - foreach (string toTrimChar in _toTrimChars) - { - value = value.Replace(toTrimChar, string.Empty); - } - - invalidCharReplacement = string.IsNullOrEmpty(invalidCharReplacement) ? "_" : invalidCharReplacement; - - foreach (string invalidChar in _invalidChars) - { - value = value.Replace(invalidChar, invalidCharReplacement); - } - - return value.Trim('/'); - } - } - - #endregion - - public string Name => "Folder"; - - [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1851:Possible multiple enumerations of 'IEnumerable' collection", Justification = "expected")] - public void Clean(IGeneralContext context) - { - context.ThrowIfNull(); - - context.Settings.Logger.Debug($"Cleaning output folder \"{context.Settings.OutputDirectory}\""); - - if (context.Settings.OutputDirectory.Exists) - { - IEnumerable files = context.Settings.OutputDirectory.EnumerateFiles("*.md", SearchOption.AllDirectories).Where(file => !string.Equals(file.Name, "readme.md", StringComparison.OrdinalIgnoreCase)); - - int i; - - foreach (FileInfo file in files) - { - i = 3; -start: - try - { - file.Delete(); - } - catch - { - if (--i > 0) - { - Thread.Sleep(100); - goto start; - } - - throw; - } - } - - i = 3; - while (files.Any() && i-- > 0) - { - Thread.Sleep(1000); - } - } - } - - public string GetFileName(IGeneralContext context, DocItem item) - { - context.ThrowIfNull(); - item.ThrowIfNull(); - - return PathCleaner.Clean(item is AssemblyDocItem ? item.FullName : string.Join("/", item.GetParents().Skip(1).Select(parent => parent.Name).Concat(Enumerable.Repeat(item.Name, 1))), GetInvalidCharReplacement(context)) + ".md"; - } -}