Documentation Library

Tools for generating documentation from code attributes


OmegaLeo.HelperLib.Documentation

DocumentationHelperTool

OmegaLeo.HelperLib.Documentation
Member Documentation
GenerateDocumentation (bool generateForPackageAssembly)

Generates a List of objects of type DocumentationStructure that contain the following fields:
AssemblyName: Name of the main Assembly, used to identify the root namespace
ClassName: Name of the class, used to identify the upper level object
Title: Title what we're generating documentation for
Description: Description of what we're generating documentation for, this can contain usage examples and can use the args array to pass names(e.g.: This method uses this methodology)
Args: Array of strings that describe the parameters of the method or class
MethodParameters: Reflected parameter signature list for documented methods (e.g. value: int, name: string)
ReturnType: Reflected return type for documented methods (e.g. bool, List<string>)
CodeExample: A code example of how to use the method or class

Note: If generateForPackageAssembly is set to true, this will generate documentation for the library as well.


Returns: IEnumerable<DocumentationStructure>
Parameters:
  • generateForPackageAssembly: bool
Attribute Args:
  • generateForPackageAssembly - Generate documentation for the DocumentationHelper library as well?
Example:
DocumentationHelperTool.GenerateDocumentation(true); // Generates documentation for all assemblies including the DocumentationHelper.Library package assembly
DocumentationHelperTool.GenerateDocumentation(false); // Generates documentation for all assemblies excluding the DocumentationHelper.Library package assembly

Changelog

Version 1.3.0

April 14, 2026

OmegaLeo.HelperLib.Documentation.Helpers

  • DocumentationHelperTool:
    • GenerateDocumentation now includes method parameters and return type in the generated documentation

Version 1.2.0

January 26, 2026

OmegaLeo.HelperLib.Documentation.Helpers

  • DocumentationHelperTool:
    • Migrated DocumentationHelper library from NetFlow.DocumentationHelper.Library to it's own package in OmegaLeo.HelperLib