index.md

DefaultDocumentation.Markdown

DefaultDocumentation.Markdown Assembly

Namespaces

DefaultDocumentation Namespace

• IGeneralContextExtensions Class Provides extension methods on the IGeneralContext type.
  • GetChildren<T>(this IGeneralContext, DocItem) Method Gets the children of a specific DocItem type of a DocItem instance.
  • GetInvalidCharReplacement(this IGeneralContext) Method Gets the Markdown.InvalidCharReplacement setting.
  • GetNestedTypeVisibilities(this IGeneralContext, Type) Method Gets the Markdown.NestedTypeVisibilities setting.
  • GetRemoveFileExtensionFromUrl(this IGeneralContext) Method Gets the Markdown.RemoveFileExtensionFromUrl setting.
  • GetUseFullUrl(this IGeneralContext) Method Gets the Markdown.UseFullUrl setting.

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.
  • AppendAsMarkdown(this IWriter, XElement) Method Appends a System.Xml.Linq.XElement decorating the IWriter with a MarkdownWriter.
  • AppendAsRaw(this IWriter) Method Append a string without sanitizing it for markdown regardless of the current GetRenderAsRaw(this IWriter) value.
  • AppendLink(this IWriter, DocItem, INamedElement) Method Append an link to an ICSharpCode.Decompiler.TypeSystem.INamedElement in the markdown format.
  • AppendLink(this IWriter, DocItem, string) Method Append an link to a DocItem in the markdown format.
  • AppendLink(this IWriter, string, string) Method Append an link to an id using UrlFactories to resolve the url in the markdown format.
  • AppendUrl(this IWriter, string, string, string) Method Append an url in the markdown format.
  • EnsureLineStart(this IWriter) Method Ensures that the given IWriter ends with a line break and call AppendLine() if it's not the case.
  • EnsureLineStartAndAppendLine(this IWriter) Method Calls EnsureLineStart(this IWriter) and AppendLine().
  • GetCurrentItem(this IWriter) Method Gets the current item that is being processed by this IWriter. It can be different from the DocItem when inlining child documentation in its parent page.
  • GetDisplayAsSingleLine(this IWriter) Method Gets whether all futur data appended to the given IWriter should stay on the same line (usefull for table). This setting is used by the MarkdownWriter type.
  • 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 type.
  • 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 type.
  • GetUrlFormat(this IWriter) Method Gets the format that will be used to display urls.
  • SetCurrentItem(this IWriter, DocItem) Method Sets the current item that is being processed by this IWriter. It can be different from the DocItem when inlining child documentation in its parent page.
  • SetDisplayAsSingleLine(this IWriter, Nullable<bool>) Method Sets whether all futur data appended to the given IWriter should stay on the same line (usefull for table). This setting is used by the MarkdownWriter type.
  • SetHandleLineBreak(this IWriter, Nullable<bool>) Method Sets whether line break in the xml documentation should be handled in the generated markdown. This setting is used by the MarkdownWriter type.
  • SetRenderAsRaw(this IWriter, Nullable<bool>) Method Sets whether the writer should append the next strings as is without sanitizing it. This setting is used by the MarkdownWriter type.
  • SetUrlFormat(this IWriter, string) Method Sets the format that will be used to display url.
  • ToOverrideWriter(this IWriter) Method Decorates the given IWriter with a OverrideWriter to override its setting in a given scope.
  • ToPrefixedWriter(this IWriter, string) Method Decorates the given IWriter with a PrefixedWriter to prefix every new line with the given prefix.

DefaultDocumentation.Markdown Namespace

• NestedTypeVisibilities Enum Specifies where nested types should be displayed in the generated documentation.
  • DeclaringType Field Generates nested types in declaring type page.
  • Default Field Same as Namespace.
  • Namespace Field Generates nested types in namespace page.

DefaultDocumentation.Markdown.DocItemGenerators Namespace

• ExcludeGenerator Class Implementation of the IDocItemGenerator to remove DocItem from the documentation generation based on Markdown.Exclude.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• OverloadsGenerator Class Implementation of the IDocItemGenerator to add ConstructorOverloadsDocItem and MethodOverloadsDocItem to the documentation generated.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.

DefaultDocumentation.Markdown.Elements Namespace

• BrElement Class Handles br xml element.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• CElement Class Handles c xml element.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• CodeElement Class Handles code xml element.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• ListElement Class Handles list xml element.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• NoteElement Class Handles note xml element.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• ParaElement Class Handles para xml element.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• ParamRefElement Class Handles paramref xml element.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• SeeElement Class Handles see xml element.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• TypeParamRefElement Class Handles typeparamref xml element.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.

DefaultDocumentation.Markdown.FileNameFactories Namespace

• BaseMarkdownFileNameFactory Class Base implementation of the IFileNameFactory to generate file with a .md extension. It will also replace invalid char that may be present with the Markdown.InvalidCharReplacement setting.
  • 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.
  • GetMarkdownFileName(IGeneralContext, DocItem) Method Gets the file name to use for the given DocItem.
• DirectoryNameFactory Class IFileNameFactory implementation using Name as file name in a directory hierarchy.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• FullNameFactory Class IFileNameFactory implementation using FullName as file name.
  • ConfigName Field The name of this implementation used at the configuration level.
  • Name Property Gets the name of the factory, used to identify it at the configuration level.
  • GetMarkdownFileName(IGeneralContext, DocItem) Method Gets the file name to use for the given DocItem.
• Md5Factory Class IFileNameFactory implementation using an md5 on the FullName as file name.
  • ConfigName Field The name of this implementation used at the configuration level.
  • Name Property Gets the name of the factory, used to identify it at the configuration level.
  • GetMarkdownFileName(IGeneralContext, DocItem) Method Gets the file name to use for the given DocItem.
• NameAndMd5MixFactory Class IFileNameFactory implementation using Name and an md5 on the FullName as file name.
  • ConfigName Field The name of this implementation used at the configuration level.
  • Name Property Gets the name of the factory, used to identify it at the configuration level.
  • GetMarkdownFileName(IGeneralContext, DocItem) Method Gets the file name to use for the given DocItem.
• NameFactory Class IFileNameFactory implementation using Name as file name.
  • ConfigName Field The name of this implementation used at the configuration level.
  • Name Property Gets the name of the factory, used to identify it at the configuration level.
  • GetMarkdownFileName(IGeneralContext, DocItem) Method Gets the file name to use for the given DocItem.

DefaultDocumentation.Markdown.Models Namespace

• ConstructorOverloadsDocItem Class Represents the different overload of the constructors of a given TypeDocItem.
  • ConstructorOverloadsDocItem(TypeDocItem) Constructor Initialize a new instance of the ConstructorOverloadsDocItem type.
• MethodOverloadsDocItem Class Represents the different overload of a method of a given TypeDocItem.
  • MethodOverloadsDocItem(TypeDocItem, string) Constructor Initialize a new instance of the MethodOverloadsDocItem type.

DefaultDocumentation.Markdown.Sections Namespace

• ChildrenSection<T> Class Base ISection implementation to write children of a given type of a DocItem.
  • ChildrenSection(string, string) Constructor Base constructor of the ChildrenSection<T> type.
  • Name Property Gets the name of the section, used to identify it at the configuration level.
  • GetChildren(IGeneralContext, DocItem) Method Gets the children of a DocItem to write.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
  • ShouldWriteTitle(IGeneralContext, DocItem) Method Gets if the title should be writen or not.
  • Write(IWriter) Method Writes the section to a given IWriter.
• ClassesSection Class ISection implementation to write ClassDocItem children of a DocItem.
  • ClassesSection() Constructor Initialize a new instance of the ClassesSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
• ConstructorOverloadsSection Class ISection implementation to write ConstructorOverloadsSection children of a DocItem.
  • ConstructorOverloadsSection() Constructor Initialize a new instance of the ConstructorsSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • GetChildren(IGeneralContext, DocItem) Method Gets the children of a DocItem to write.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
• ConstructorsSection Class ISection implementation to write ConstructorDocItem children of a DocItem.
  • ConstructorsSection() Constructor Initialize a new instance of the ConstructorsSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • GetChildren(IGeneralContext, DocItem) Method Gets the children of a DocItem to write.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
  • ShouldWriteTitle(IGeneralContext, DocItem) Method Gets if the title should be writen or not.
• DefaultSection Class ISection implementation regrouping the following implementation in this order: ...
  • DefaultSection() Constructor Initialize a new instance of the DefaultSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• DefinitionSection Class ISection implementation to write the definition of DocItem.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• DelegatesSection Class ISection implementation to write DelegateDocItem children of a DocItem.
  • DelegatesSection() Constructor Initialize a new instance of the DelegatesSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
• DerivedSection Class ISection implementation to write the derived type of TypeDocItem.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• EnumFieldsSection Class ISection implementation to write EnumFieldDocItem children of a DocItem.
  • EnumFieldsSection() Constructor Initialize a new instance of the EnumFieldsSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • GetChildren(IGeneralContext, DocItem) Method Gets the children of a DocItem to write.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
• EnumsSection Class ISection implementation to write EnumDocItem children of a DocItem.
  • EnumsSection() Constructor Initialize a new instance of the EnumsSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
• EventsSection Class ISection implementation to write EventDocItem children of a DocItem.
  • EventsSection() Constructor Initialize a new instance of the EventsSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
• EventTypeSection Class ISection implementation to write the event type of EventDocItem.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• ExampleSection Class ISection implementation to write the example top level element.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• ExceptionSection Class ISection implementation to write the exception top level elements.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• ExplicitInterfaceImplementationsSection Class ISection implementation to write ExplicitInterfaceImplementationDocItem children of a DocItem.
  • ExplicitInterfaceImplementationsSection() Constructor Initialize a new instance of the ExplicitInterfaceImplementationsSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
• FieldsSection Class ISection implementation to write FieldDocItem children of a DocItem.
  • FieldsSection() Constructor Initialize a new instance of the FieldsSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
• FieldValueSection Class ISection implementation to write the field type of FieldDocItem.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• FooterSection Class ISection implementation to write a link to DefaultDocumentation.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• HeaderSection Class ISection implementation to write a link to the top level documentation page.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• ImplementSection Class ISection implementation to write the types/members implemented by the DocItem.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• InheritanceSection Class ISection implementation to write the types inherited by the TypeDocItem.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• InterfacesSection Class ISection implementation to write InterfaceDocItem children of a DocItem.
  • InterfacesSection() Constructor Initialize a new instance of the InterfacesSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
• MethodOverloadsSection Class ISection implementation to write MethodOverloadsSection children of a DocItem.
  • MethodOverloadsSection() Constructor Initialize a new instance of the ConstructorsSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • GetChildren(IGeneralContext, DocItem) Method Gets the children of a DocItem to write.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
• MethodsSection Class ISection implementation to write MethodDocItem children of a DocItem.
  • MethodsSection() Constructor Initialize a new instance of the MethodsSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • GetChildren(IGeneralContext, DocItem) Method Gets the children of a DocItem to write.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
  • ShouldWriteTitle(IGeneralContext, DocItem) Method Gets if the title should be writen or not.
• NamespacesSection Class ISection implementation to write NamespaceDocItem children of a DocItem.
  • NamespacesSection() Constructor Initialize a new instance of the NamespacesSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
• OperatorsSection Class ISection implementation to write OperatorDocItem children of a DocItem.
  • OperatorsSection() Constructor Initialize a new instance of the OperatorsSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
• ParametersSection Class ISection implementation to write ParameterDocItem children of a DocItem.
  • ParametersSection() Constructor Initialize a new instance of the ParametersSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • GetChildren(IGeneralContext, DocItem) Method Gets the children of a DocItem to write.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
• PropertiesSection Class ISection implementation to write PropertyDocItem children of a DocItem.
  • PropertiesSection() Constructor Initialize a new instance of the PropertiesSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
• RemarksSection Class ISection implementation to write the remarks top level element.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• ReturnsSection Class ISection implementation to write the returns top level element.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• SeeAlsoSection Class ISection implementation to write the seealso top level elements.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• StructsSection Class ISection implementation to write StructDocItem children of a DocItem.
  • StructsSection() Constructor Initialize a new instance of the StructsSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
• SummarySection Class ISection implementation to write the summary top level element.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• TableOfContentsSection Class ISection implementation to write a table of content of all children of the DocItem.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• TitleSection Class ISection implementation to write a title of the DocItem.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• TypeParametersSection Class ISection implementation to write TypeParameterDocItem children of a DocItem.
  • TypeParametersSection() Constructor Initialize a new instance of the TypeParametersSection type.
  • ConfigName Field The name of this implementation used at the configuration level.
  • GetChildren(IGeneralContext, DocItem) Method Gets the children of a DocItem to write.
  • ShouldInlineChildren(IGeneralContext, DocItem) Method Gets if the children should be inlined or not.
• ValueSection Class ISection implementation to write the value top level element.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• TableOfContentsSection.Modes Enum The different options to customize the table of contents.
  • Grouped Field DocItem will appear in their kind section.
  • IncludeKind Field The kind of each DocItem will appear explicitely.
  • IncludeNewLine Field There should be a new line when displaying the summary of the DocItem.
  • IncludeSummary Field The summary of each DocItem will be displayed.
  • IncludeSummaryWithNewLine Field Same as IncludeSummary and IncludeNewLine
  • None Field Default generation.

DefaultDocumentation.Markdown.UrlFactories Namespace

• DocItemFactory Class Handles id for known DocItem.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.
• DotnetApiFactory Class Transforms any id as a dotnet api url.
  • ConfigName Field The name of this implementation used at the configuration level.
  • 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.

DefaultDocumentation.Markdown.Writers Namespace

• MarkdownWriter Class Decorator of the IWriter type to handle the Markdown.HandleLineBreak setting. It also uses a OverrideWriter internally to further decorate the instance.
  • MarkdownWriter(IWriter) Constructor Initializes a new instance of the MarkdownWriter type.
  • 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 or a `` at the end of the documentation text depending of the current setting.
  • EndsWith(string) Method Returns whether the documentation text ends with the given string.
• OverrideWriter Class Decorator of the IWriter type to override its data without changing its actual values.
  • OverrideWriter(IWriter) Constructor Initializes a new instance of the OverrideWriter type.
  • 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.
• PrefixedWriter Class Decorator of the IWriter type to prefix every new line with a specific System.String.
  • PrefixedWriter(IWriter, string) Constructor Initializes a new instance of the PrefixedWriter type.
  • 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

• DocItemExtensions Class Provides extension methods on the DocItem type.
  • GetLongName(this DocItem) Method Gets the long name of a DocItem, being its full name without its namespace. This method should not be called on AssemblyDocItem or NamespaceDocItem types.

---

Generated by DefaultDocumentation