Migrated Documentation library from NetFlow.DocumentationHelper.Library

2026-01-28 13:15:44 +00:00
parent ab700413fb
commit d20a80c44c
152 changed files with 714 additions and 94 deletions
@@ -0,0 +1,11 @@
+using System;
+using System.Collections.Generic;
+
+namespace OmegaLeo.HelperLib.Documentation.Models
+{
+    public class DocumentationAssembly
+    {
+        public string AssemblyName;
+        public IEnumerable<Type> Types;
+    }
+}
@@ -0,0 +1,49 @@
+using System;
+using System.Collections.Generic;
+using OmegaLeo.HelperLib.Shared.Attributes;
+
+namespace OmegaLeo.HelperLib.Documentation.Models
+{
+
+    public class DocumentationStructure
+    {
+        public string AssemblyName;
+        public string ClassName;
+        public List<DocumentationDescription> Descriptions;
+
+        public DocumentationStructure(string assemblyName, string className)
+        {
+            AssemblyName = assemblyName;
+            ClassName = className;
+            Descriptions = new List<DocumentationDescription>();
+        }
+
+        public void AddDescription(DocumentationDescription description)
+        {
+            Descriptions.Add(description);
+        }
+    }
+
+    public class DocumentationDescription
+    {
+        public string Title;
+        public string Description;
+        public string[] Parameters;
+        public string CodeExample = string.Empty;
+
+        [Documentation(nameof(DocumentationDescription), "Description of the current Documented object", new []
+        {
+            "title - Name of the object",
+            "description - Description of what the object does",
+            "parameters - The parameters for the object (in case of a method with parameters)",
+            "codeExample - Code example of how to use the object"
+        })]
+        public DocumentationDescription(string title, string description, string[] parameters = default, string codeExample = "")
+        {
+            Title = title;
+            Description = description;
+            Parameters = parameters ?? Array.Empty<string>();
+            CodeExample = codeExample;
+        }
+    }
+}