Class GenerateCSharpDocumentationExtensions

Extension method class that supports c# model generation for IDocumentation hosted models

Inheritance

object

GenerateCSharpDocumentationExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: CodeFactory.WinVs.Models.CSharp

Assembly: CodeFactory.WinVs.dll

Syntax

public static class GenerateCSharpDocumentationExtensions

Methods

GenerateCSharpDocumentationLine(string)

Takes documentation and returns a XML comment based documentation for C# code.

Declaration

public static string GenerateCSharpDocumentationLine(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.

GenerateCSharpXmlDocumentation(IDocumentation, int)

Generates XML documentation that supports C# source code.

Declaration

public static string GenerateCSharpXmlDocumentation(this IDocumentation source, int indentLevel = 0)

Parameters

Type	Name	Description
IDocumentation	source	The C# model that supports the IDocumentation interface.
int	indentLevel	Optional parameter that sets the level of indents to assign before each XML documentation line, default value is 0.

Returns

Type	Description
string

GenerateCSharpXmlDocumentationEnumerator(IDocumentation)

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

Declaration

public static IEnumerable<string> GenerateCSharpXmlDocumentationEnumerator(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.