Class DocumentationExtensions

Extensions class that manage extensions that support CodeFactory models that implement the IDocumentation interface.

Inheritance

object

DocumentationExtensions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: CodeFactory.Formatting.CSharp

Assembly: CodeFactory.Formatting.CSharp.dll

Syntax

public static class DocumentationExtensions

Methods

CSharpFormatDocumentationLine(string)

Extension method that takes documentation and returns a XML comment based documentation for C# code.

Declaration

public static string CSharpFormatDocumentationLine(this string source)

Parameters

Type	Name	Description
string	source	documentation string to be evaluated.

Returns

Type	Description
string	the comment formatted c# documentation or null if the string is not for documentation.

CSharpFormatXmlDocumentationEnumerator(IDocumentation)

An Iterator that returns fully formatted XML documentation for the C# programming language.

Declaration

public static IEnumerable<string> CSharpFormatXmlDocumentationEnumerator(this IDocumentation documentation)

Parameters

Type	Name	Description
IDocumentation	documentation	The source code model that has documentation.

Returns

Type	Description
IEnumerable<string>	The enumerator that loads the formatted XML documentation for the CSharp Language.