From 43acc832077d1a40c7f8931968719f41bf1eac3e Mon Sep 17 00:00:00 2001 From: "Nuno \"Omega Leo\" Diogo" Date: Wed, 28 Jan 2026 13:41:06 +0000 Subject: [PATCH] Updated README --- .../OmegaLeo.HelperLib.Changelog.csproj | 8 +++-- .../Helpers/DocumentationHelper.cs | 2 +- .../OmegaLeo.HelperLib.Documentation.csproj | 8 +++++ OmegaLeo.HelperLib.Documentation/README.md | 30 +++++++++++++++++++ .../OmegaLeo.HelperLib.Game.csproj | 9 ++++++ OmegaLeo.HelperLib.Game/README | 1 - OmegaLeo.HelperLib.Game/README.md | 8 +++++ OmegaLeo.HelperLib/OmegaLeo.HelperLib.csproj | 8 +++-- OmegaLeo.HelperLib/README.md | 2 +- README.md | 2 +- 10 files changed, 70 insertions(+), 8 deletions(-) create mode 100644 OmegaLeo.HelperLib.Documentation/README.md delete mode 100755 OmegaLeo.HelperLib.Game/README create mode 100755 OmegaLeo.HelperLib.Game/README.md diff --git a/OmegaLeo.HelperLib.Changelog/OmegaLeo.HelperLib.Changelog.csproj b/OmegaLeo.HelperLib.Changelog/OmegaLeo.HelperLib.Changelog.csproj index e8cf401..ba11f6f 100755 --- a/OmegaLeo.HelperLib.Changelog/OmegaLeo.HelperLib.Changelog.csproj +++ b/OmegaLeo.HelperLib.Changelog/OmegaLeo.HelperLib.Changelog.csproj @@ -17,8 +17,12 @@ - - + + Always + + + Always + diff --git a/OmegaLeo.HelperLib.Documentation/Helpers/DocumentationHelper.cs b/OmegaLeo.HelperLib.Documentation/Helpers/DocumentationHelper.cs index bbec13a..3a34b13 100755 --- a/OmegaLeo.HelperLib.Documentation/Helpers/DocumentationHelper.cs +++ b/OmegaLeo.HelperLib.Documentation/Helpers/DocumentationHelper.cs @@ -11,7 +11,7 @@ using OmegaLeo.HelperLib.Documentation.Models; namespace OmegaLeo.HelperLib.Documentation.Helpers { - [Changelog("1.2.0", "Migrated DocumentationHelper library from NetFlow.DocumentationHelper.Library to it's own package in OmegaLeo.HelperLib")] + [Changelog("1.2.0", "Migrated DocumentationHelper library from NetFlow.DocumentationHelper.Library to it's own package in OmegaLeo.HelperLib", "January 26, 2026")] public static class DocumentationHelperTool { [Documentation("GenerateDocumentation (bool generateForPackageAssembly)", diff --git a/OmegaLeo.HelperLib.Documentation/OmegaLeo.HelperLib.Documentation.csproj b/OmegaLeo.HelperLib.Documentation/OmegaLeo.HelperLib.Documentation.csproj index 2380f8d..2fdee56 100755 --- a/OmegaLeo.HelperLib.Documentation/OmegaLeo.HelperLib.Documentation.csproj +++ b/OmegaLeo.HelperLib.Documentation/OmegaLeo.HelperLib.Documentation.csproj @@ -25,5 +25,13 @@ + + + Always + + + Always + + diff --git a/OmegaLeo.HelperLib.Documentation/README.md b/OmegaLeo.HelperLib.Documentation/README.md new file mode 100644 index 0000000..b44d287 --- /dev/null +++ b/OmegaLeo.HelperLib.Documentation/README.md @@ -0,0 +1,30 @@ +# Omega Leo's Helper Library - Documentation +Package to help with generating and managing documentation for your C# projects. + +## Features +- Attribute-based documentation: Use custom attributes to annotate your classes, methods, and properties with documentation comments. +- Documentation extraction tool: A tool to extract and format documentation into various formats (Markdown, HTML, etc.). +- Integration with build processes: Easily integrate documentation generation into your CI/CD pipelines. + +## Example attribute usage: +```cs +[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 +**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.*", + new [] + { + "generateForPackageAssembly - Generate documentation for the DocumentationHelper library as well?" + }, + @"```csharp +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 +```")] + public static IEnumerable GenerateDocumentation(bool generateForPackageAssembly = false) +``` \ No newline at end of file diff --git a/OmegaLeo.HelperLib.Game/OmegaLeo.HelperLib.Game.csproj b/OmegaLeo.HelperLib.Game/OmegaLeo.HelperLib.Game.csproj index 9218585..cec4f83 100755 --- a/OmegaLeo.HelperLib.Game/OmegaLeo.HelperLib.Game.csproj +++ b/OmegaLeo.HelperLib.Game/OmegaLeo.HelperLib.Game.csproj @@ -22,4 +22,13 @@ + + + Always + + + Always + + + diff --git a/OmegaLeo.HelperLib.Game/README b/OmegaLeo.HelperLib.Game/README deleted file mode 100755 index 9226c29..0000000 --- a/OmegaLeo.HelperLib.Game/README +++ /dev/null @@ -1 +0,0 @@ -# OmegaLeo's Helper Library - Game Logic diff --git a/OmegaLeo.HelperLib.Game/README.md b/OmegaLeo.HelperLib.Game/README.md new file mode 100755 index 0000000..b468c09 --- /dev/null +++ b/OmegaLeo.HelperLib.Game/README.md @@ -0,0 +1,8 @@ +# OmegaLeo's Helper Library - Game Logic +Lightweight utility library for C# projects and game development helpers. + +## Features +- Game development specific helpers and utilities +- Helpers for common game development tasks +- Easy to integrate into existing projects +- Open source under the AGPL v3 License \ No newline at end of file diff --git a/OmegaLeo.HelperLib/OmegaLeo.HelperLib.csproj b/OmegaLeo.HelperLib/OmegaLeo.HelperLib.csproj index 8a1d64b..8c64b27 100755 --- a/OmegaLeo.HelperLib/OmegaLeo.HelperLib.csproj +++ b/OmegaLeo.HelperLib/OmegaLeo.HelperLib.csproj @@ -18,8 +18,12 @@ - - + + Always + + + Always + diff --git a/OmegaLeo.HelperLib/README.md b/OmegaLeo.HelperLib/README.md index bf8b90d..017a0b5 100755 --- a/OmegaLeo.HelperLib/README.md +++ b/OmegaLeo.HelperLib/README.md @@ -1 +1 @@ -# Omega Leo's Helper Lib \ No newline at end of file +# Omega Leo's Helper Library \ No newline at end of file diff --git a/README.md b/README.md index d610dfc..b3d60d3 100755 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# HelperLib +# Omega Leo's Helper Library Lightweight utility library for C\# projects and game development helpers.