Add summary to FunctionLike.return (#109)

webcomponents · Sep 12, 2022 · a2e73f4 · a2e73f4
1 parent 2424005
commit a2e73f4
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -34,6 +34,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - Added a `"rest"` field to parameters. ([#83](https://github.com/webcomponents/custom-elements-manifest/pull/83))
 
+- Added an optional `summary` field to Function and Method return types. ([#109](https://github.com/webcomponents/custom-elements-manifest/pull/109))
+
 <!-- ### Removed -->
 
 ### Fixed

diff --git a/schema.d.ts b/schema.d.ts
@@ -697,6 +697,15 @@ export interface FunctionLike {
 
   return?: {
     type?: Type;
+
+    /**
+     * A markdown summary suitable for display in a listing.
+     */
+    summary?: string;
+
+    /**
+     * A markdown description.
+     */
     description?: string;
   };
 }

diff --git a/schema.json b/schema.json
@@ -190,6 +190,11 @@
                 "return": {
                     "properties": {
                         "description": {
+                            "description": "A markdown description.",
+                            "type": "string"
+                        },
+                        "summary": {
+                            "description": "A markdown summary suitable for display in a listing.",
                             "type": "string"
                         },
                         "type": {
@@ -511,6 +516,11 @@
                 "return": {
                     "properties": {
                         "description": {
+                            "description": "A markdown description.",
+                            "type": "string"
+                        },
+                        "summary": {
+                            "description": "A markdown summary suitable for display in a listing.",
                             "type": "string"
                         },
                         "type": {
@@ -633,6 +643,11 @@
                 "return": {
                     "properties": {
                         "description": {
+                            "description": "A markdown description.",
+                            "type": "string"
+                        },
+                        "summary": {
+                            "description": "A markdown summary suitable for display in a listing.",
                             "type": "string"
                         },
                         "type": {
@@ -812,6 +827,11 @@
                 "return": {
                     "properties": {
                         "description": {
+                            "description": "A markdown description.",
+                            "type": "string"
+                        },
+                        "summary": {
+                            "description": "A markdown summary suitable for display in a listing.",
                             "type": "string"
                         },
                         "type": {