index.md

DefaultDocumentation.Api

DefaultDocumentation.Api Assembly

This is the full API documentation of DefaultDocumentation.

Namespaces

DefaultDocumentation Namespace

• IGeneralContextExtensions Class Provides extension methods on the IGeneralContext type.
  • GetContext(this IGeneralContext, DocItem) Method Gets the specific IContext for the given DocItem kind.
  • GetSetting<T>(this IGeneralContext, DocItem, Func<IContext,T>) Method Gets a data from the specific IContext of the provided DocItem if it exists, else from the IGeneralContext.
  • GetSetting<T>(this IGeneralContext, Type, Func<IContext,T>) Method Gets a data from the specific IContext of the provided System.Type if it exists, else from the IGeneralContext.
• IPageContextExtensions Class Provides extension methods on the IPageContext type.
  • GetUrl(this IPageContext, DocItem) Method Gets the url of the given DocItem in a specific page.
  • GetUrl(this IPageContext, string) Method Gets the url of the given id in a specific page.
• IContext Interface Exposes settings used to generate documentation for a given DocItem type.
  • FileNameFactory Property Gets the IFileNameFactory to use to generate a file for a documentation page.
  • Sections Property Gets the ISection to use to generate a documentation page.
  • GetSetting<T>(string) Method Gets a T setting with the given name.
• IDocItemsContext Interface Exposes properties and methods used to impact the DocItem that will be generated, used by IDocItemGenerator
  • Items Property Gets all the DocItem known by this documentation generation context.
  • ItemsWithOwnPage Property Gets all the DocItem that should generate their own documentation page.
  • Settings Property Gets the ISettings of this documentation generation context.
  • GetSetting<T>(string) Method Gets a T setting with the given name.
  • GetSetting<T>(Type, string) Method Gets a T setting with the given name for the given DocItemSystem.Type.
• IGeneralContext Interface Exposes settings used to generate documentation.
  • Elements Property Gets the IElement used to render specific System.Xml.Linq.XElement from the documentation.
  • Items Property Gets all the DocItem known by this documentation generation context.
  • ItemsWithOwnPage Property Gets all the DocItem that should generate their own documentation page.
  • Settings Property Gets the ISettings of this documentation generation context.
  • UrlFactories Property Gets the IUrlFactory used to create the documentation urls.
  • GetContext(Type) Method Gets the specific IContext for the given DocItemSystem.Type.
  • GetFileName(DocItem) Method Gets the file name for the given DocItem.
• IPageContext Interface Exposes settings used to generate documentation for a specific DocItem.
  • DocItem Property Gets the DocItem for which the documentation is being generated.
  • this[string] Property Gets or sets extra data for the current DocItem documentation generation.
• ISettings Interface Exposes all the settings of the documentation generation process.
  • AssemblyFile Property Gets the assembly file for which the documentation is being generated.
  • AssemblyPageName Property Gets the name of the assembly page name.
  • DocumentationFile Property Gets the xml documentation file of the AssemblyFile.
  • ExternLinksFiles Property Gets the links files of external items which are not part of the dotnet api.
  • GeneratedAccessModifiers Property Gets the GeneratedAccessModifiers flags stating which access modifiers should have their documentation generated.
  • GeneratedPages Property Gets the GeneratedPages flags stating which kind should have their own page and which should be inlined.
  • IncludeUndocumentedItems Property Gets wether item with no xml documentation should have their documentation generated or not.
  • LinksBaseUrl Property Gets the base url to prefix item url with when generating the links output file.
  • 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 Property Gets the Microsoft.Extensions.Logging.ILogger of the process.
  • OutputDirectory Property Gets the output directory where the documentation is being generated.
  • ProjectDirectory Property Gets the root project directory where the sources of the AssemblyFile are.
• GeneratedAccessModifiers Enum Specifies a combination of access modifiers.
  • Api Field Generates documentation for 'public', 'protected' and 'protected internal' access modifier.
  • Default Field Generates documentation for all access modifiers.
  • Internal Field Generates documentation for 'internal' access modifier.
  • Private Field Generates documentation for 'private' access modifier.
  • PrivateProtected Field Generates documentation for 'private protected' access modifier.
  • Protected Field Generates documentation for 'protected' access modifier.
  • ProtectedInternal Field Generates documentation for 'protected internal' access modifier.
  • Public Field Generates documentation for 'public' access modifier.
• GeneratedPages Enum Specifies a combination of page kinds.
  • Assembly Field Generates documentation page for the assembly.
  • Classes Field Generates documentation pages for the classes.
  • Constructors Field Generates documentation pages for the constructors.
  • Default Field Generates all documentation page kinds.
  • Delegates Field Generates documentation pages for the delegates.
  • Enums Field Generates documentation pages for the enums.
  • Events Field Generates documentation pages for the events.
  • ExplicitInterfaceImplementations Field Generates documentation pages for the explicit interface implementations.
  • Fields Field Generates documentation pages for the fields.
  • Interfaces Field Generates documentation pages for the interfaces.
  • Members Field Generates documentation pages for all member kinds (constructor, event, field, method, operator, property, explicit interface implementation).
  • Methods Field Generates documentation pages for the methods.
  • Namespaces Field Generates documentation pages for the namespaces.
  • Operators Field Generates documentation pages for the operators.
  • Properties Field Generates documentation pages for the properties.
  • Structs Field Generates documentation pages for the structs.
  • Types Field Generates documentation pages for all type kinds (class, delegate, enum, struct, interface).

DefaultDocumentation.Api Namespace

The DefaultDocumentation.Api namespace contains interfaces that can be used to add custom features to the documentation generation.

• IWriterExtensions Class Provides extension methods on the IWriter type.
  • Append(this IWriter, XElement) Method Appends an System.Xml.Linq.XElement to a IWriter by using the Elements of Context. If no IElement is found, the System.Xml.Linq.XElement is appended as text directly.
  • AppendFormat(this IWriter, string, object[]) Method Appends a formatted string to a IWriter.
  • AppendLine(this IWriter, string) Method Appends a line after writing the provided System.String.
  • TrimEnd(this IWriter, string[]) Method Trims from the end of a IWriter all the provided values.
• IDocItemGenerator Interface Exposes a method to generate the known DocItem of the documentation.
  • Name Property Gets the name of the generator, used to identify it at the configuration level.
  • Generate(IDocItemsContext) Method Modified the known DocItem of the IDocItemsContext.
• IElement Interface Exposes a method to handle a specific kind of System.Xml.Linq.XElement when writing documentation.
  • Name Property Gets the name of the System.Xml.Linq.XElement this type handle.
  • Write(IWriter, XElement) Method Writes to a IWriter the provided System.Xml.Linq.XElement.
• IFileNameFactory Interface Exposes methods related to the documentation files cleaning and creation.
  • Name Property Gets the name of the factory, used to identify it at the configuration level.
  • Clean(IGeneralContext) Method Cleans the OutputDirectory of the previously generated documentation files.
  • GetFileName(IGeneralContext, DocItem) Method Gets the documentation file name for the given DocItem.
• ISection Interface Exposes a method to write a specific section when writing documentation.
  • Name Property Gets the name of the section, used to identify it at the configuration level.
  • Write(IWriter) Method Writes the section to a given IWriter.
• IUrlFactory Interface Exposes methods related to the documentation files url creation.
  • Name Property Gets the name of the factory, used to identify it at the configuration level.
  • 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.
• IWriter Interface Exposes properties and methods use to generate a documentation file for a specific DocItem.
  • Context Property Gets the IPageContext of the current documentation generation process.
  • Length Property Gets or sets the length of the documentation text currently produced.
  • Append(string) Method Appends a string at the end of the documentation text.
  • AppendLine() Method Appends a System.Environment.NewLine at the end of the documentation text.
  • EndsWith(string) Method Returns whether the documentation text ends with the given string.

DefaultDocumentation.Models Namespace

• AssemblyDocItem Class Represents an assembly documentation.
  • AssemblyDocItem(string, string, XElement) Constructor Initialize a new instance of the AssemblyDocItem type.
• DocItem Class Represent a documentation item.
  • DocItem(DocItem, string, string, string, XElement) Constructor Initialize a new instance of the DocItem type.
  • Documentation Property Gets the xml documentation node of the current instance.
  • FullName Property Gets the full name of the current instance.
  • Id Property Gets the id of the current instance.
  • Name Property Gets the name of the current instance.
  • Parent Property Gets the DocItem parent of the current instance (for members it is their declaring type, for types it is their namespace, ...).
• DocItemExtensions Class Provides extension methods on the DocItem type.
  • GetParents(this DocItem) Method Returns all the parents of the given DocItem.
  • TryGetParameterDocItem(this DocItem, string, ParameterDocItem) Method Searchs recursively on the given DocItem parent a ParameterDocItem with the provided name.
  • TryGetTypeParameterDocItem(this DocItem, string, TypeParameterDocItem) Method Searchs recursively on the given DocItem parent a TypeParameterDocItem with the provided name.
• EntityDocItem Class Represent an IEntity documentation.
  • Entity Property Gets the IEntity of the current instance.
• ExternDocItem Class Represent an external documentation.
  • ExternDocItem(string, string, string) Constructor Initialize a new instance of the ExternDocItem type.
  • Url Property Gets the url of the current instance.
• NamespaceDocItem Class Represents a namespace documentation.
  • NamespaceDocItem(AssemblyDocItem, string, XElement) Constructor Initialize a new instance of the NamespaceDocItem type.
• IParameterizedDocItem Interface Exposes ParameterDocItem instances.
  • Parameters Property Gets the ParameterDocItem of this instance.
• ITypeParameterizedDocItem Interface Exposes TypeParameterDocItem instances.
  • TypeParameters Property Gets the TypeParameterDocItem of this instance.

DefaultDocumentation.Models.Members Namespace

• ConstructorDocItem Class Represents a constructor IMethod documentation.
  • ConstructorDocItem(TypeDocItem, IMethod, XElement) Constructor Initialize a new instance of the ConstructorDocItem type.
  • Method Property Gets the IMethod of the current instance.
  • Parameters Property Gets the ParameterDocItem of this instance.
• EnumFieldDocItem Class Represents an enum IField documentation.
  • EnumFieldDocItem(EnumDocItem, IField, XElement) Constructor Initialize a new instance of the EnumFieldDocItem type.
  • Field Property Gets the IField of the current instance.
• EventDocItem Class Represents an IEvent documentation.
  • EventDocItem(TypeDocItem, IEvent, XElement) Constructor Initialize a new instance of the EventDocItem type.
  • Event Property Gets the IEvent of the current instance.
• ExplicitInterfaceImplementationDocItem Class Represents an explicit interface implementation documentation.
  • ExplicitInterfaceImplementationDocItem(TypeDocItem, IEvent, XElement) Constructor Initialize a new instance of the ExplicitInterfaceImplementationDocItem type.
  • ExplicitInterfaceImplementationDocItem(TypeDocItem, IMethod, XElement) Constructor Initialize a new instance of the ExplicitInterfaceImplementationDocItem type.
  • ExplicitInterfaceImplementationDocItem(TypeDocItem, IProperty, XElement) Constructor Initialize a new instance of the ExplicitInterfaceImplementationDocItem type.
  • Member Property Gets the IMember of the current instance. It can either be an IEvent, IProperty or IMethod.
  • Parameters Property Gets the ParameterDocItem of this instance.
  • TypeParameters Property Gets the TypeParameterDocItem of this instance.
• FieldDocItem Class Represents an IField documentation.
  • FieldDocItem(TypeDocItem, IField, XElement) Constructor Initialize a new instance of the FieldDocItem type.
  • Field Property Gets the IField of the current instance.
• MethodDocItem Class Represents an IMethod documentation.
  • MethodDocItem(TypeDocItem, IMethod, XElement) Constructor Initialize a new instance of the MethodDocItem type.
  • Method Property Gets the IMethod of the current instance.
  • Parameters Property Gets the ParameterDocItem of this instance.
  • TypeParameters Property Gets the TypeParameterDocItem of this instance.
• OperatorDocItem Class Represents an operator IMethod documentation.
  • OperatorDocItem(TypeDocItem, IMethod, XElement) Constructor Initialize a new instance of the OperatorDocItem type.
  • Method Property Gets the IMethod of the current instance.
  • Parameters Property Gets the ParameterDocItem of this instance.
• PropertyDocItem Class Represents an IProperty documentation.
  • PropertyDocItem(TypeDocItem, IProperty, XElement) Constructor Initialize a new instance of the PropertyDocItem type.
  • Parameters Property Gets the ParameterDocItem of this instance.
  • Property Property Gets the IProperty of the current instance.

DefaultDocumentation.Models.Parameters Namespace

• ParameterDocItem Class Represents an IParameter documentation.
  • Parameter Property Gets the IParameter of the current instance.
• TypeParameterDocItem Class Represents an ITypeParameter documentation.
  • TypeParameter Property Gets the ITypeParameter of the current instance.

DefaultDocumentation.Models.Types Namespace

• ClassDocItem Class Represents a ITypeDefinition of the TypeKind.Class kind documentation.
  • ClassDocItem(DocItem, ITypeDefinition, XElement) Constructor Initialize a new instance of the ClassDocItem type.
• DelegateDocItem Class Represents a ITypeDefinition of the TypeKind.Delegate kind documentation.
  • DelegateDocItem(DocItem, ITypeDefinition, XElement) Constructor Initialize a new instance of the StructDocItem type.
  • InvokeMethod Property Gets the IMethod of the current instance.
  • Parameters Property Gets the ParameterDocItem of this instance.
• EnumDocItem Class Represents a ITypeDefinition of the TypeKind.Enum kind documentation.
  • EnumDocItem(DocItem, ITypeDefinition, XElement) Constructor Initialize a new instance of the StructDocItem type.
• InterfaceDocItem Class Represents a ITypeDefinition of the TypeKind.Interface kind documentation.
  • InterfaceDocItem(DocItem, ITypeDefinition, XElement) Constructor Initialize a new instance of the StructDocItem type.
• StructDocItem Class Represents a ITypeDefinition of the TypeKind.Struct kind documentation.
  • StructDocItem(DocItem, ITypeDefinition, XElement) Constructor Initialize a new instance of the StructDocItem type.
• TypeDocItem Class Represents a ITypeDefinition documentation.
  • Type Property Gets the ITypeDefinition of the current instance.
  • TypeParameters Property Gets the TypeParameterDocItem of this instance.

ICSharpCode.Decompiler.TypeSystem Namespace

• IEntityExtensions Class Provides extension methods on the IEntity type.
  • IsVisibleInDocumentation(this IEntity, ISettings) Method Returns wether an IEntity should be part of the documentation or not based on its accessibility.
• ISymbolExtensions Class Provides extension methods on the ICSharpCode.Decompiler.TypeSystem.ISymbol type.
  • ToString(this ISymbol, CSharpAmbience) Method Converts a ICSharpCode.Decompiler.TypeSystem.ISymbol into its string representation using the provided ICSharpCode.Decompiler.CSharp.OutputVisitor.CSharpAmbience.

---

Generated by DefaultDocumentation