@typespec/compiler 0.58.0-dev.8 → 0.58.0-dev.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -73,7 +73,7 @@ export type WithDefaultKeyVisibilityDecorator = (context: DecoratorContext, targ
|
|
|
73
73
|
export type SummaryDecorator = (context: DecoratorContext, target: Type, summary: string) => void;
|
|
74
74
|
/**
|
|
75
75
|
* Attach a documentation string to describe the successful return types of an operation.
|
|
76
|
-
* If an operation returns a union of success and errors it only
|
|
76
|
+
* If an operation returns a union of success and errors it only describes the success. See `@errorsDoc` for error documentation.
|
|
77
77
|
*
|
|
78
78
|
* @param doc Documentation string
|
|
79
79
|
* @example
|
|
@@ -85,12 +85,12 @@ export type SummaryDecorator = (context: DecoratorContext, target: Type, summary
|
|
|
85
85
|
export type ReturnsDocDecorator = (context: DecoratorContext, target: Operation, doc: string) => void;
|
|
86
86
|
/**
|
|
87
87
|
* Attach a documentation string to describe the error return types of an operation.
|
|
88
|
-
* If an operation returns a union of success and errors it only
|
|
88
|
+
* If an operation returns a union of success and errors it only describes the errors. See `@returnsDoc` for success documentation.
|
|
89
89
|
*
|
|
90
90
|
* @param doc Documentation string
|
|
91
91
|
* @example
|
|
92
92
|
* ```typespec
|
|
93
|
-
* @errorsDoc("
|
|
93
|
+
* @errorsDoc("Errors doc")
|
|
94
94
|
* op get(): Pet | NotFound;
|
|
95
95
|
* ```
|
|
96
96
|
*/
|
package/dist/manifest.js
CHANGED
package/lib/std/decorators.tsp
CHANGED
|
@@ -31,7 +31,7 @@ extern dec doc(target: unknown, doc: valueof string, formatArgs?: {});
|
|
|
31
31
|
|
|
32
32
|
/**
|
|
33
33
|
* Attach a documentation string to describe the successful return types of an operation.
|
|
34
|
-
* If an operation returns a union of success and errors it only
|
|
34
|
+
* If an operation returns a union of success and errors it only describes the success. See `@errorsDoc` for error documentation.
|
|
35
35
|
* @param doc Documentation string
|
|
36
36
|
*
|
|
37
37
|
* @example
|
|
@@ -44,12 +44,12 @@ extern dec returnsDoc(target: Operation, doc: valueof string);
|
|
|
44
44
|
|
|
45
45
|
/**
|
|
46
46
|
* Attach a documentation string to describe the error return types of an operation.
|
|
47
|
-
* If an operation returns a union of success and errors it only
|
|
47
|
+
* If an operation returns a union of success and errors it only describes the errors. See `@returnsDoc` for success documentation.
|
|
48
48
|
* @param doc Documentation string
|
|
49
49
|
*
|
|
50
50
|
* @example
|
|
51
51
|
* ```typespec
|
|
52
|
-
* @errorsDoc("
|
|
52
|
+
* @errorsDoc("Errors doc")
|
|
53
53
|
* op get(): Pet | NotFound;
|
|
54
54
|
* ```
|
|
55
55
|
*/
|