File tree Expand file tree Collapse file tree 3 files changed +31
-0
lines changed Expand file tree Collapse file tree 3 files changed +31
-0
lines changed Original file line number Diff line number Diff line change @@ -34,6 +34,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
34
34
35
35
- Added a ` "rest" ` field to parameters. ([ #83 ] ( https://github.com/webcomponents/custom-elements-manifest/pull/83 ) )
36
36
37
+ - Added an optional ` summary ` field to Function and Method return types. ([ #109 ] ( https://github.com/webcomponents/custom-elements-manifest/pull/109 ) )
38
+
37
39
<!-- ### Removed -->
38
40
39
41
### Fixed
Original file line number Diff line number Diff line change @@ -697,6 +697,15 @@ export interface FunctionLike {
697
697
698
698
return ?: {
699
699
type ?: Type ;
700
+
701
+ /**
702
+ * A markdown summary suitable for display in a listing.
703
+ */
704
+ summary ?: string ;
705
+
706
+ /**
707
+ * A markdown description.
708
+ */
700
709
description ?: string ;
701
710
} ;
702
711
}
Original file line number Diff line number Diff line change 190
190
"return" : {
191
191
"properties" : {
192
192
"description" : {
193
+ "description" : " A markdown description." ,
194
+ "type" : " string"
195
+ },
196
+ "summary" : {
197
+ "description" : " A markdown summary suitable for display in a listing." ,
193
198
"type" : " string"
194
199
},
195
200
"type" : {
511
516
"return" : {
512
517
"properties" : {
513
518
"description" : {
519
+ "description" : " A markdown description." ,
520
+ "type" : " string"
521
+ },
522
+ "summary" : {
523
+ "description" : " A markdown summary suitable for display in a listing." ,
514
524
"type" : " string"
515
525
},
516
526
"type" : {
633
643
"return" : {
634
644
"properties" : {
635
645
"description" : {
646
+ "description" : " A markdown description." ,
647
+ "type" : " string"
648
+ },
649
+ "summary" : {
650
+ "description" : " A markdown summary suitable for display in a listing." ,
636
651
"type" : " string"
637
652
},
638
653
"type" : {
812
827
"return" : {
813
828
"properties" : {
814
829
"description" : {
830
+ "description" : " A markdown description." ,
831
+ "type" : " string"
832
+ },
833
+ "summary" : {
834
+ "description" : " A markdown summary suitable for display in a listing." ,
815
835
"type" : " string"
816
836
},
817
837
"type" : {
You can’t perform that action at this time.
0 commit comments