Skip to content

Commit 5b12988

Browse files
regen docs (Azure#49805)
1 parent c96ec09 commit 5b12988

File tree

5 files changed

+30
-16
lines changed

5 files changed

+30
-16
lines changed

eng/packages/http-client-csharp-mgmt/README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# @azure-typespec/http-client-csharp-mgmt
22

3+
TypeSpec library for emitting Azure management libraries for C#.
4+
35
## Install
46

57
```bash
@@ -59,12 +61,6 @@ Defines the strategy on how to handle unreferenced types. The default value is `
5961

6062
Set to `true` to overwrite the csproj if it already exists. The default value is `false`.
6163

62-
### `clear-output-folder`
63-
64-
**Type:** `boolean`
65-
66-
Indicates if you want to clear the output folder before generating. The default value is `true`.
67-
6864
### `save-inputs`
6965

7066
**Type:** `boolean`
@@ -135,4 +131,4 @@ The C# namespace to use for the generated code. This will override the TypeSpec
135131

136132
**Type:** `boolean`
137133

138-
Whether to put models under a separate 'Models' sub-namespace. This only applies if the 'namespace' option is set. The default value is 'true' when the 'namespace' option is set. Otherwise, each model will be in the corresponding namespace defined in the TypeSpec.
134+
Whether to put models under a separate 'Models' sub-namespace. This only applies if the 'namespace' option is set. The default value is 'false'.

eng/packages/http-client-csharp-mgmt/docs/emitter.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,6 @@ Defines the strategy on how to handle unreferenced types. The default value is `
5555

5656
Set to `true` to overwrite the csproj if it already exists. The default value is `false`.
5757

58-
### `clear-output-folder`
59-
60-
**Type:** `boolean`
61-
62-
Indicates if you want to clear the output folder before generating. The default value is `true`.
63-
6458
### `save-inputs`
6559

6660
**Type:** `boolean`
@@ -131,4 +125,4 @@ The C# namespace to use for the generated code. This will override the TypeSpec
131125

132126
**Type:** `boolean`
133127

134-
Whether to put models under a separate 'Models' sub-namespace. This only applies if the 'namespace' option is set. The default value is 'true' when the 'namespace' option is set. Otherwise, each model will be in the corresponding namespace defined in the TypeSpec.
128+
Whether to put models under a separate 'Models' sub-namespace. This only applies if the 'namespace' option is set. The default value is 'false'.

eng/packages/http-client-csharp-mgmt/docs/index.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ toc_max_heading_level: 3
77

88
import { Tabs, TabItem } from '@astrojs/starlight/components';
99

10+
TypeSpec library for emitting Azure management libraries for C#.
11+
1012
## Install
1113

1214
<Tabs>

eng/packages/http-client-csharp/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,13 @@ options:
3535
3636
## Emitter options
3737
38+
### `emitter-output-dir`
39+
40+
**Type:** `absolutePath`
41+
42+
Defines the emitter output directory. Defaults to `{output-dir}/@azure-typespec/http-client-csharp`
43+
See [Configuring output directory for more info](https://typespec.io/docs/handbook/configuration/configuration/#configuring-output-directory)
44+
3845
### `api-version`
3946

4047
**Type:** `string`
@@ -45,10 +52,14 @@ For TypeSpec files using the [`@versioned`](https://typespec.io/docs/libraries/v
4552

4653
**Type:** `boolean`
4754

55+
Set to `false` to skip generation of protocol methods. The default value is `true`.
56+
4857
### `generate-convenience-methods`
4958

5059
**Type:** `boolean`
5160

61+
Set to `false` to skip generation of convenience methods. The default value is `true`.
62+
5263
### `unreferenced-types-handling`
5364

5465
**Type:** `"removeOrInternalize" | "internalize" | "keepAll"`
@@ -83,7 +94,7 @@ Set to `true` to automatically attempt to attach to a debugger when executing th
8394

8495
**Type:** `"info" | "debug" | "verbose"`
8596

86-
Set the log level. The default value is `info`.
97+
Set the log level for which to collect traces. The default value is `info`.
8798

8899
### `disable-xml-docs`
89100

eng/packages/http-client-csharp/docs/emitter.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,13 @@ options:
2929
3030
## Emitter options
3131
32+
### `emitter-output-dir`
33+
34+
**Type:** `absolutePath`
35+
36+
Defines the emitter output directory. Defaults to `{output-dir}/@azure-typespec/http-client-csharp`
37+
See [Configuring output directory for more info](https://typespec.io/docs/handbook/configuration/configuration/#configuring-output-directory)
38+
3239
### `api-version`
3340

3441
**Type:** `string`
@@ -39,10 +46,14 @@ For TypeSpec files using the [`@versioned`](https://typespec.io/docs/libraries/v
3946

4047
**Type:** `boolean`
4148

49+
Set to `false` to skip generation of protocol methods. The default value is `true`.
50+
4251
### `generate-convenience-methods`
4352

4453
**Type:** `boolean`
4554

55+
Set to `false` to skip generation of convenience methods. The default value is `true`.
56+
4657
### `unreferenced-types-handling`
4758

4859
**Type:** `"removeOrInternalize" | "internalize" | "keepAll"`
@@ -77,7 +88,7 @@ Set to `true` to automatically attempt to attach to a debugger when executing th
7788

7889
**Type:** `"info" | "debug" | "verbose"`
7990

80-
Set the log level. The default value is `info`.
91+
Set the log level for which to collect traces. The default value is `info`.
8192

8293
### `disable-xml-docs`
8394

0 commit comments

Comments
 (0)