Added return description to the generated ysls file

Author: McJones

Editor/Analysis/Action.cs

@@ -226,6 +226,7 @@ public Action(string name, ActionType type, IMethodSymbol methodSymbol)
         /// </summary>
         public List<Parameter> Parameters = new List<Parameter>();
 
+        public string? ReturnDescription;
         public string? YarnReturnTypeString => this.MethodSymbol.ReturnType.GetYarnTypeString();
 
         public string ToJSON()
@@ -307,7 +308,14 @@ public string ToJSON()
 
             if (this.Type == ActionType.Function)
             {
-                result["ReturnType"] = this.YarnReturnTypeString;
+                var retvrn = new Dictionary<string, string>();
+                retvrn["Type"] = this.YarnReturnTypeString ?? "error";
+
+                if (!string.IsNullOrWhiteSpace(this.ReturnDescription))
+                {
+                    retvrn["Description"] = this.ReturnDescription;
+                }
+                result["Return"] = retvrn;
             }
 
             return Yarn.Unity.Editor.Json.Serialize(result);

Editor/Analysis/Analyser.cs

@@ -565,7 +565,16 @@ private static IEnumerable<Action> GetRuntimeDefinedActions(CompilationUnitSynta
 
                 var declaringSyntax = targetSymbol.DeclaringSyntaxReferences.FirstOrDefault()?.GetSyntax();
 
-                TryGetDocumentation(targetSymbol, logger, out XElement? documentationXML, out string? summary);
+                string? ReturnDescription = null;
+                if (TryGetDocumentation(targetSymbol, logger, out XElement? documentationXML, out string? summary))
+                {
+                    var returnNode = documentationXML?.Element("returns");
+                    if (returnNode != null)
+                    {
+                        ReturnDescription = string.Join("", returnNode.DescendantNodes().OfType<XText>().Select(n => n.ToString())).Trim();
+                        logger?.WriteLine($"\tFound a return: {ReturnDescription}");
+                    }
+                }
 
                 yield return new Action(name, methodCall.Type, targetSymbol)
                 {
@@ -577,6 +586,7 @@ private static IEnumerable<Action> GetRuntimeDefinedActions(CompilationUnitSynta
                     Parameters = GetParams(targetSymbol, documentationXML, logger),
                     SourceFileName = root.SyntaxTree.FilePath,
                     DeclarationType = DeclarationType.DirectRegistration,
+                    ReturnDescription = ReturnDescription,
                 };
             }
         }
@@ -647,6 +657,7 @@ private static bool TryGetDocumentation(IMethodSymbol targetSymbol, ILogger? log
 
             // 3. This is not doc XML and just happens to be a comment above a command/function
             summary = documentationComments;
+            documentationXML = null;
             logger?.WriteLine("Unable to determine XML, returning the comment as is");
             return true;
         }
@@ -741,7 +752,16 @@ private static IEnumerable<Action> GetAttributeActions(CompilationUnitSyntax roo
                     continue;
                 }
 
-                TryGetDocumentation(methodSymbol, logger, out XElement? documentationXML, out string? summary);
+                string? ReturnDescription = null;
+                if (TryGetDocumentation(methodSymbol, logger, out XElement? documentationXML, out string? summary))
+                {
+                    var returnNode = documentationXML?.Element("returns");
+                    if (returnNode != null)
+                    {
+                        ReturnDescription = string.Join("", returnNode.DescendantNodes().OfType<XText>().Select(n => n.ToString())).Trim();
+                        logger.WriteLine($"\tFound a return: {ReturnDescription}");
+                    }
+                }
 
                 var containerName = container?.ToDisplayString(SymbolDisplayFormat.FullyQualifiedFormat) ?? "<unknown>";
 
@@ -761,6 +781,7 @@ private static IEnumerable<Action> GetAttributeActions(CompilationUnitSyntax roo
                     Description = summary,
                     SourceFileName = root.SyntaxTree.FilePath,
                     DeclarationType = DeclarationType.Attribute,
+                    ReturnDescription = ReturnDescription,
                 };
             }
         }