Skip to content

Atc.CodeDocumentation.md

Latest commit

 

History

History
162 lines (133 loc) · 4.06 KB

Atc.CodeDocumentation.md

File metadata and controls

162 lines (133 loc) · 4.06 KB

Atc.CodeDocumentation


AtcCodeDocumentationAssemblyTypeInitializer

public static class AtcCodeDocumentationAssemblyTypeInitializer

Constants

public static class Constants

Static Fields

UndefinedDescription

string UndefinedDescription

DocumentationHelper

DocumentationHelper.

public static class DocumentationHelper

Static Methods

CollectExportedTypeWithCommentsFromType

TypeComments CollectExportedTypeWithCommentsFromType(Type type)

Summary: Collects the type of the exported type with comments from.

Parameters:
     type  -  The type.

CollectExportedTypesWithMissingCommentsFromAssembly

TypeComments[] CollectExportedTypesWithMissingCommentsFromAssembly(Assembly assembly, List<Type> excludeTypes = null)

Summary: Collects the exported types with missing comments from assembly.

Parameters:
     assembly  -  The assembly.
     excludeTypes  -  The exclude types.

CollectExportedTypesWithMissingCommentsFromAssemblyAndGenerateText

string CollectExportedTypesWithMissingCommentsFromAssemblyAndGenerateText(Assembly assembly, List<Type> excludeTypes = null, bool useFullName = False)

Summary: Collects the exported types with missing comments from assembly and generate text.

Parameters:
     assembly  -  The assembly.
     excludeTypes  -  The exclude types.
     useFullName  -  if set to [use full name].

CollectExportedTypesWithMissingCommentsFromAssemblyAndGenerateTextLines

string[] CollectExportedTypesWithMissingCommentsFromAssemblyAndGenerateTextLines(Assembly assembly, List<Type> excludeTypes = null, bool useFullName = False)

Summary: Collects the exported types with missing comments from assembly and generate text lines.

Parameters:
     assembly  -  The assembly.
     excludeTypes  -  The exclude types.
     useFullName  -  if set to [use full name].


MemberType

MemberType.

public enum MemberType
Value Name Description Summary
0 None None The none.
69 Event Event The event.
70 Field Field The field.
77 Method Method The method.
80 Property Property The property.
84 Type Type The type.

TypeComments

TypeComments.

public class TypeComments

Properties

BeautifyHtmlName

BeautifyHtmlName

Summary: Gets the name of the beautify HTML.

CommentLookup

CommentLookup

Summary: Gets the comment lookup.

FullName

FullName

Summary: Gets the full name.

HasComments

HasComments

Summary: Gets a value indicating whether this instance has comments.

Name

Name

Summary: Gets the name.

Namespace

Namespace

Summary: Gets the namespace.

Type

Type

Summary: Gets the type.

Methods

GetXmlDocumentComments

XmlDocumentComment[] GetXmlDocumentComments()

Summary: Gets the XML document comments.

ToString

string ToString()

Summary: Converts to string.

Returns: A string that represents this instance.

Generated by MarkdownCodeDoc version 1.2