Skip to content

Atc.CodeDocumentation.md

Latest commit

 

History

History
192 lines (163 loc) · 6.9 KB

Atc.CodeDocumentation.md

File metadata and controls

192 lines (163 loc) · 6.9 KB

Atc.CodeDocumentation


AtcCodeDocumentationAssemblyTypeInitializer

public static class AtcCodeDocumentationAssemblyTypeInitializer

Constants

Provides constant values used throughout the code documentation system.

public static class Constants

Static Fields

UndefinedDescription

string UndefinedDescription

Summary: The default text used when a description is not defined or cannot be found in the XML documentation.


DocumentationHelper

Provides public API methods for collecting and analyzing XML documentation comments from assemblies and types.

public static class DocumentationHelper

Static Methods

CollectExportedTypeWithCommentsFromType

TypeComments CollectExportedTypeWithCommentsFromType(Type type)

Summary: Collects XML documentation comments for a specific type from its assembly.

Parameters:
     type  -  The type to collect documentation for.

Returns: The type comments, or if the type was not found.

CollectExportedTypeWithCommentsFromType

TypeComments CollectExportedTypeWithCommentsFromType(Type type, FileInfo xmlDocPath)

Summary: Collects XML documentation comments for a specific type from its assembly.

Parameters:
     type  -  The type to collect documentation for.

Returns: The type comments, or if the type was not found.

CollectExportedTypesWithMissingCommentsFromAssembly

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

Summary: Collects all public types from an assembly that are missing XML documentation comments.

Parameters:
     assembly  -  The assembly to scan for types.
     excludeTypes  -  Optional list of types to exclude from the results.

Returns: An array of type comments for types missing documentation.

CollectExportedTypesWithMissingCommentsFromAssembly

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

Summary: Collects all public types from an assembly that are missing XML documentation comments.

Parameters:
     assembly  -  The assembly to scan for types.
     excludeTypes  -  Optional list of types to exclude from the results.

Returns: An array of type comments for types missing documentation.

CollectExportedTypesWithMissingCommentsFromAssemblyAndGenerateText

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

Summary: Collects all public types from an assembly that are missing XML documentation and generates a formatted text report.

Parameters:
     assembly  -  The assembly to scan for types.
     excludeTypes  -  Optional list of types to exclude from the results.
     useFullName  -  If , uses fully qualified type names in the output; otherwise uses simple names.

Returns: A string containing one type name per line for all types missing documentation.

CollectExportedTypesWithMissingCommentsFromAssemblyAndGenerateTextLines

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

Summary: Collects all public types from an assembly that are missing XML documentation and generates an array of type names.

Parameters:
     assembly  -  The assembly to scan for types.
     excludeTypes  -  Optional list of types to exclude from the results.
     useFullName  -  If , uses fully qualified type names in the output; otherwise uses simple names.

Returns: An array of type name strings, one per type missing documentation.


MemberType

Represents the different types of members that can be documented in XML documentation comments. Each value corresponds to the member type prefix used in XML documentation names.

public enum MemberType
Value Name Description Summary
0 None None Represents no member type.
69 Event Event Represents an event member (E: prefix in XML documentation).
70 Field Field Represents a field member (F: prefix in XML documentation).
77 Method Method Represents a method member (M: prefix in XML documentation).
80 Property Property Represents a property member (P: prefix in XML documentation).
84 Type Type Represents a type member such as a class, struct, interface, or enum (T: prefix in XML documentation).

TypeComments

Represents a type along with its associated XML documentation comments and member information.

public class TypeComments

Properties

BeautifyHtmlName

BeautifyHtmlName

Summary: Gets the HTML-formatted beautified name of the type.

CommentLookup

CommentLookup

Summary: Gets the lookup table mapping class names to their XML documentation comments.

FullName

FullName

Summary: Gets the fully qualified name of the type.

HasComments

HasComments

Summary: Gets a value indicating whether this type has XML documentation comments.

Name

Name

Summary: Gets the simple name of the type.

Namespace

Namespace

Summary: Gets the namespace of the type.

Type

Type

Summary: Gets the System.Type being documented.

Methods

GetXmlDocumentComments

XmlDocumentComment[] GetXmlDocumentComments()

Summary: Retrieves all XML documentation comments associated with this type.

Returns: An array of XML documentation comments, or if no comments exist.

ToString

string ToString()
Generated by MarkdownCodeDoc version 1.2