Skip to content

Commit df2105a

Browse files
Merge branch 'main' into type-import-base-flag
2 parents 9927227 + 58976f1 commit df2105a

25 files changed

Lines changed: 139 additions & 54 deletions

File tree

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
changeKind: internal
3+
packages:
4+
- "@typespec/events"
5+
---
6+
7+
Add missing documentation on public declarations and members
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
changeKind: internal
3+
packages:
4+
- "@typespec/graphql"
5+
---
6+
7+
Add missing documentation on public declarations and members
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
changeKind: internal
3+
packages:
4+
- "@typespec/http-client"
5+
---
6+
7+
Add missing documentation on public declarations and members
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
changeKind: internal
3+
packages:
4+
- "@typespec/protobuf"
5+
---
6+
7+
Add missing documentation on public declarations and members

packages/events/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ decorator.
3232

3333
##### Parameters
3434

35-
| Name | Type | Description |
36-
| ----------- | ---------------- | ----------- |
37-
| contentType | `valueof string` | |
35+
| Name | Type | Description |
36+
| ----------- | ---------------- | ----------------------------------------------- |
37+
| contentType | `valueof string` | The content type of the event or event payload. |
3838

3939
##### Examples
4040

packages/events/generated-defs/TypeSpec.Events.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ export type EventsDecorator = (
4545
* { done: false, @data @contentType("text/plain") value: string,}
4646
* }
4747
* ```
48+
* @param contentType The content type of the event or event payload.
4849
*/
4950
export type ContentTypeDecorator = (
5051
context: DecoratorContext,

packages/events/lib/decorators.tsp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ extern dec events(target: Union);
4141
* { done: false, @data @contentType("text/plain") value: string,}
4242
* }
4343
* ```
44+
*
45+
* @param contentType The content type of the event or event payload.
4446
*/
4547
extern dec contentType(target: UnionVariant | ModelProperty, contentType: valueof string);
4648

packages/graphql/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,9 @@ and all of the interfaces' properties must be present and compatible.
107107

108108
##### Parameters
109109

110-
| Name | Type | Description |
111-
| ---------- | --------- | ----------- |
112-
| interfaces | `Model[]` | |
110+
| Name | Type | Description |
111+
| ---------- | --------- | --------------------------------------------------------------------------- |
112+
| interfaces | `Model[]` | The models to compose into the target, each emitted as a GraphQL interface. |
113113

114114
##### Examples
115115

@@ -199,9 +199,9 @@ The operations become fields on the GraphQL type with their parameters as argume
199199

200200
##### Parameters
201201

202-
| Name | Type | Description |
203-
| ---------- | -------------------------- | ----------- |
204-
| operations | `Operation \| Interface[]` | |
202+
| Name | Type | Description |
203+
| ---------- | -------------------------- | ---------------------------------------------------------------------------- |
204+
| operations | `Operation \| Interface[]` | The operations, or interfaces of operations, to add to the target as fields. |
205205

206206
##### Examples
207207

@@ -252,9 +252,9 @@ All types and operations within the namespace will be emitted to a single GraphQ
252252

253253
##### Parameters
254254

255-
| Name | Type | Description |
256-
| ------- | ----------------------------------------- | ----------- |
257-
| options | [valueof `SchemaOptions`](#schemaoptions) | |
255+
| Name | Type | Description |
256+
| ------- | ----------------------------------------- | ----------------------------------------- |
257+
| options | [valueof `SchemaOptions`](#schemaoptions) | Options for the schema, such as its name. |
258258

259259
##### Examples
260260

packages/graphql/generated-defs/TypeSpec.GraphQL.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ export type GraphqlInterfaceDecorator = (
6666
* name: string;
6767
* }
6868
* ```
69+
* @param interfaces The models to compose into the target, each emitted as a GraphQL interface.
6970
*/
7071
export type ComposeDecorator = (
7172
context: DecoratorContext,
@@ -87,6 +88,7 @@ export type ComposeDecorator = (
8788
* }
8889
* // Emits: type Person { name: String!; followers(query: String!): [Person!]! }
8990
* ```
91+
* @param operations The operations, or interfaces of operations, to add to the target as fields.
9092
*/
9193
export type OperationFieldsDecorator = (
9294
context: DecoratorContext,
@@ -146,6 +148,7 @@ export type SubscriptionDecorator = (
146148
* }
147149
* // Emits: MyAPI.graphql
148150
* ```
151+
* @param options Options for the schema, such as its name.
149152
*/
150153
export type SchemaDecorator = (
151154
context: DecoratorContext,

packages/graphql/lib/interface.tsp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,5 +53,7 @@ extern dec graphqlInterface(
5353
* name: string;
5454
* }
5555
* ```
56+
*
57+
* @param interfaces The models to compose into the target, each emitted as a GraphQL interface.
5658
*/
5759
extern dec compose(target: Model, ...interfaces: Model[]);

0 commit comments

Comments
 (0)