Update docs

luttje · Aug 23, 2022 · 546794a · 546794a
1 parent c9d7550
commit 546794a
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 12 deletions.
diff --git a/BuildMarkdownDocs/EnumMember.cs b/BuildMarkdownDocs/EnumMember.cs
@@ -12,7 +12,8 @@ namespace BuildMarkdownDocs
     internal class EnumMember : Member
     {
         public Type Type { get; set; }
-
+        public Dictionary<string, string> ValueSummaries;
+
         internal override string GetLinkMarkdown()
         {
             return $"* [`{Name}`]({Parent.Path}{Name}.md)";
@@ -37,8 +38,11 @@ internal override void FillTemplateReplacements(ref Dictionary<string, string> r
 
                 if (firstName == null)
                     firstName = name;
-
-                allEnumerations.AppendLine($"* `{name}`");
+
+                var summary = ValueSummaries != null && ValueSummaries.ContainsKey(name) 
+                    ? $": {ValueSummaries[name]}" : "";
+
+                allEnumerations.AppendLine($"* `{name}`{summary}");
             }
 
             if(firstName != null)

diff --git a/BuildMarkdownDocs/MarkdownDocs.cs b/BuildMarkdownDocs/MarkdownDocs.cs
@@ -73,12 +73,27 @@ internal static void Build(string xmlFile, string outputDirectory, string templa
                         if (!isTypeDescribed)
                         {
                             EnumMember enumMember;
+                            var valueSummaries = new Dictionary<string, string>();
+                            var fullXmlName = $"F:{parameter.Type.FullName}";
+
+                            foreach (var m in xmlMembers)
+                            {
+                                var name = m.Attribute("name").Value;
+
+                                if(name.StartsWith(fullXmlName))
+                                {
+                                    var summary = m.Element("summary").Value.TrimEachLine().Trim('\n');
+                                    valueSummaries.Add(name.Substring(fullXmlName.Length + 1), summary);
+                                }
+                            }
+
                             enumerations.Add(enumMember = new EnumMember()
                             {
                                 Parent = enumParent,
                                 Type = parameter.Type,
                                 Name = enumName,
-                                Summary = ""
+                                Summary = "",
+                                ValueSummaries = valueSummaries,
                             });
 
                             var outputEnumFile = Path.GetFullPath(outputDirectory + enumMember.Parent.Path + enumMember.Name.FirstCharToUpper() + ".md");

diff --git a/Docs/Api/Enumerations/AppCommand.md b/Docs/Api/Enumerations/AppCommand.md
@@ -7,5 +7,5 @@
 
 ## Possible Values
 
-* `Abort`
-* `ResetScriptEnvironment`
+* `Abort`: Aborts listening for triggers
+* `ResetScriptEnvironment`: Recreate the scripting environment (loses all variables, functions and other changes scripts made)
diff --git a/Docs/Api/Enumerations/PressState.md b/Docs/Api/Enumerations/PressState.md
@@ -7,5 +7,5 @@
 
 ## Possible Values
 
-* `Press`
-* `Release`
+* `Press`: The key/button is pressed down
+* `Release`: The key/button is released (after having been pressed down)
diff --git a/Key2Joy/LowLevelInput/PressState.cs b/Key2Joy/LowLevelInput/PressState.cs
@@ -18,12 +18,12 @@ public enum PressState
         LegacyPressAndRelease,
 
         /// <summary>
-        /// Pressed down
+        /// The key/button is pressed down
         /// </summary>
         Press,
 
         /// <summary>
-        /// Release (after pressed down)
+        /// The key/button is released (after having been pressed down)
         /// </summary>
         Release,
     }

diff --git a/Key2Joy/Properties/AssemblyInfo.cs b/Key2Joy/Properties/AssemblyInfo.cs
@@ -33,6 +33,6 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("0.4.3.0")]
-[assembly: AssemblyFileVersion("0.4.3.0")]
+[assembly: AssemblyVersion("0.5.0.0")]
+[assembly: AssemblyFileVersion("0.5.0.0")]
 [assembly: NeutralResourcesLanguage("en")]