@alloy-js/csharp 0.23.0-dev.5 → 0.23.0-dev.7

package/docs/api/components/AttributeList.md

@@ -0,0 +1,34 @@
+# AttributeList
+
+Render each attributes in a new line.
+
+* jsx
+
+  ```tsx
+  import { AttributeList } from "@alloy-js/csharp";
+
+
+  <AttributeList attributes={AttributesProp} endline>
+    {children}
+  </AttributeList>
+  ```
+
+* stc
+
+  ```ts
+  import { AttributeList } from "@alloy-js/csharp/stc";
+
+
+  AttributeList({
+    attributes: AttributesProp,
+    endline: boolean,
+  }).children(children)
+  ```
+
+## Props
+
+|            |                                                        |                                                                                |
+| ---------- | ------------------------------------------------------ | ------------------------------------------------------------------------------ |
+| attributes | optional [AttributesProp](../../types/attributesprop/) |                                                                                |
+| children   | optional [Children](../../../core/types/children/)\[]  |                                                                                |
+| endline    | optional boolean                                       | If the attribute list should finish with a hard line if there is any attribute |

package/docs/api/components/ClassDeclaration.md

@@ -0,0 +1,104 @@
+# ClassDeclaration
+
+CSharp class declaration.
+
+* jsx
+
+  ```tsx
+  import { ClassDeclaration } from "@alloy-js/csharp";
+
+
+  <ClassDeclaration
+    abstract
+    attributes={AttributesProp}
+    baseType={Children}
+    doc={Children}
+    file
+    interfaceTypes={Children[]}
+    internal
+    name={string | Namekey}
+    partial
+    primaryConstructor={ParameterProps[]}
+    private
+    protected
+    public
+    refkey={Refkey}
+    sealed
+    static
+    typeParameters={(string | TypeParameterProps)[]}
+   />
+  ```
+
+* stc
+
+  ```ts
+  import { ClassDeclaration } from "@alloy-js/csharp/stc";
+
+
+  ClassDeclaration({
+    abstract: boolean,
+    attributes: AttributesProp,
+    baseType: Children,
+    doc: Children,
+    file: boolean,
+    interfaceTypes: Children[],
+    internal: boolean,
+    name: string | Namekey,
+    partial: boolean,
+    primaryConstructor: ParameterProps[],
+    private: boolean,
+    protected: boolean,
+    public: boolean,
+    refkey: Refkey,
+    sealed: boolean,
+    static: boolean,
+    typeParameters: (string | TypeParameterProps)[],
+  }).children(children)
+  ```
+
+## Props
+
+|                    |                                                                               |                                        |
+| ------------------ | ----------------------------------------------------------------------------- | -------------------------------------- |
+| abstract           | optional boolean                                                              |                                        |
+| attributes         | optional [AttributesProp](../../types/attributesprop/)                        | Define attributes to attach            |
+| baseType           | optional [Children](../../../core/types/children/)                            | Base class that this class extends     |
+| doc                | optional [Children](../../../core/types/children/)                            | Doc comment                            |
+| file               | optional boolean                                                              |                                        |
+| interfaceTypes     | optional [Children](../../../core/types/children/)\[]                         | Interfaces this class implements       |
+| internal           | optional boolean                                                              |                                        |
+| name               | string \| [Namekey](../../../core/types/namekey/)                             |                                        |
+| partial            | optional boolean                                                              |                                        |
+| primaryConstructor | optional [ParameterProps](../parameter/)\[]                                   | Set the primary constructor parameters |
+| private            | optional boolean                                                              |                                        |
+| protected          | optional boolean                                                              |                                        |
+| public             | optional boolean                                                              |                                        |
+| refkey             | optional [Refkey](../../../core/types/refkey/)                                |                                        |
+| sealed             | optional boolean                                                              |                                        |
+| static             | optional boolean                                                              |                                        |
+| typeParameters     | optional (string \| [TypeParameterProps](../../types/typeparameterprops/))\[] | Type parameters for the class          |
+
+## Example
+
+```tsx
+<ClassDeclaration public name="MyClass">
+  <ClassMember public name="MyField" type="int" />
+  <ClassConstructor>
+    <Parameter name="value" type="int" />
+    this.MyField = value;
+  </ClassConstructor>
+</ClassDeclaration>
+```
+
+This will produce:
+
+```csharp
+public class MyClass
+{
+  public int MyField;
+  public MyClass(int value)
+  {
+    this.MyField = value;
+  }
+}
+```

package/docs/api/components/Constructor.md

@@ -0,0 +1,55 @@
+# Constructor
+
+Properties for [Constructor](../constructor/) component.
+
+* jsx
+
+  ```tsx
+  import { Constructor } from "@alloy-js/csharp";
+
+
+  <Constructor
+    doc={Children}
+    file
+    internal
+    parameters={ParameterProps[]}
+    private
+    protected
+    public
+    refkey={Refkey}
+  >
+    {children}
+  </Constructor>
+  ```
+
+* stc
+
+  ```ts
+  import { Constructor } from "@alloy-js/csharp/stc";
+
+
+  Constructor({
+    doc: Children,
+    file: boolean,
+    internal: boolean,
+    parameters: ParameterProps[],
+    private: boolean,
+    protected: boolean,
+    public: boolean,
+    refkey: Refkey,
+  }).children(children)
+  ```
+
+## Props
+
+|            |                                                    |                        |
+| ---------- | -------------------------------------------------- | ---------------------- |
+| children   | optional [Children](../../../core/types/children/) | Constructor body       |
+| doc        | optional [Children](../../../core/types/children/) | Doc comment            |
+| file       | optional boolean                                   |                        |
+| internal   | optional boolean                                   |                        |
+| parameters | optional [ParameterProps](../parameter/)\[]        | Constructor parameters |
+| private    | optional boolean                                   |                        |
+| protected  | optional boolean                                   |                        |
+| public     | optional boolean                                   |                        |
+| refkey     | optional [Refkey](../../../core/types/refkey/)     | Refkey                 |

package/docs/api/components/CsprojFile.md

@@ -0,0 +1,34 @@
+# CsprojFile
+
+Create a .csproj file
+
+* jsx
+
+  ```tsx
+  import { CsprojFile } from "@alloy-js/csharp";
+
+
+  <CsprojFile path={`${string}.csproj`} sdk={CSharpProjectSdk}>
+    {children}
+  </CsprojFile>
+  ```
+
+* stc
+
+  ```ts
+  import { CsprojFile } from "@alloy-js/csharp/stc";
+
+
+  CsprojFile({
+    path: `${string}.csproj`,
+    sdk: CSharpProjectSdk,
+  }).children(children)
+  ```
+
+## Props
+
+|          |                                                            |                                                                                  |
+| -------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| children | optional [Children](../../../core/types/children/)         | Content inside                                                                   |
+| path     | `$&#123;string&#125;.csproj`                               |                                                                                  |
+| sdk      | optional [CSharpProjectSdk](../../types/csharpprojectsdk/) | Project SDK <https://learn.microsoft.com/en-us/dotnet/core/project-sdk/overview> |

package/docs/api/components/Declaration.md

@@ -0,0 +1,32 @@
+# Declaration
+
+* jsx
+
+  ```tsx
+  import { Declaration } from "@alloy-js/csharp";
+
+
+  <Declaration name="string" refkey={core.Refkey | core.Refkey[]}>
+    {children}
+  </Declaration>
+  ```
+
+* stc
+
+  ```ts
+  import { Declaration } from "@alloy-js/csharp/stc";
+
+
+  Declaration({
+    name: string,
+    refkey: core.Refkey | core.Refkey[],
+  }).children(children)
+  ```
+
+## Props
+
+|          |                                                                                            |   |
+| -------- | ------------------------------------------------------------------------------------------ | - |
+| children | optional [Children](../../../core/types/children/)                                         |   |
+| name     | string                                                                                     |   |
+| refkey   | optional [Refkey](../../../core/types/refkey/) \| [Refkey](../../../core/types/refkey/)\[] |   |

package/docs/api/components/DocC.md

@@ -0,0 +1,27 @@
+# DocC
+
+* jsx
+
+  ```tsx
+  import { DocC } from "@alloy-js/csharp";
+
+
+  <DocC >
+    {children}
+  </DocC>
+  ```
+
+* stc
+
+  ```ts
+  import { DocC } from "@alloy-js/csharp/stc";
+
+
+  DocC({  }).children(children)
+  ```
+
+## Props
+
+|          |                                           |   |
+| -------- | ----------------------------------------- | - |
+| children | [Children](../../../core/types/children/) |   |

package/docs/api/components/DocCode.md

@@ -0,0 +1,27 @@
+# DocCode
+
+* jsx
+
+  ```tsx
+  import { DocCode } from "@alloy-js/csharp";
+
+
+  <DocCode >
+    {children}
+  </DocCode>
+  ```
+
+* stc
+
+  ```ts
+  import { DocCode } from "@alloy-js/csharp/stc";
+
+
+  DocCode({  }).children(children)
+  ```
+
+## Props
+
+|          |                                           |   |
+| -------- | ----------------------------------------- | - |
+| children | [Children](../../../core/types/children/) |   |

package/docs/api/components/DocComment.md

@@ -0,0 +1,27 @@
+# DocComment
+
+* jsx
+
+  ```tsx
+  import { DocComment } from "@alloy-js/csharp";
+
+
+  <DocComment >
+    {children}
+  </DocComment>
+  ```
+
+* stc
+
+  ```ts
+  import { DocComment } from "@alloy-js/csharp/stc";
+
+
+  DocComment({  }).children(children)
+  ```
+
+## Props
+
+|          |                                           |   |
+| -------- | ----------------------------------------- | - |
+| children | [Children](../../../core/types/children/) |   |

package/docs/api/components/DocDescription.md

@@ -0,0 +1,27 @@
+# DocDescription
+
+* jsx
+
+  ```tsx
+  import { DocDescription } from "@alloy-js/csharp";
+
+
+  <DocDescription >
+    {children}
+  </DocDescription>
+  ```
+
+* stc
+
+  ```ts
+  import { DocDescription } from "@alloy-js/csharp/stc";
+
+
+  DocDescription({  }).children(children)
+  ```
+
+## Props
+
+|          |                                           |   |
+| -------- | ----------------------------------------- | - |
+| children | [Children](../../../core/types/children/) |   |

package/docs/api/components/DocExample.md

@@ -0,0 +1,27 @@
+# DocExample
+
+* jsx
+
+  ```tsx
+  import { DocExample } from "@alloy-js/csharp";
+
+
+  <DocExample >
+    {children}
+  </DocExample>
+  ```
+
+* stc
+
+  ```ts
+  import { DocExample } from "@alloy-js/csharp/stc";
+
+
+  DocExample({  }).children(children)
+  ```
+
+## Props
+
+|          |                                           |   |
+| -------- | ----------------------------------------- | - |
+| children | [Children](../../../core/types/children/) |   |

package/docs/api/components/DocException.md

@@ -0,0 +1,27 @@
+# DocException
+
+* jsx
+
+  ```tsx
+  import { DocException } from "@alloy-js/csharp";
+
+
+  <DocException >
+    {children}
+  </DocException>
+  ```
+
+* stc
+
+  ```ts
+  import { DocException } from "@alloy-js/csharp/stc";
+
+
+  DocException({  }).children(children)
+  ```
+
+## Props
+
+|          |                                           |   |
+| -------- | ----------------------------------------- | - |
+| children | [Children](../../../core/types/children/) |   |

package/docs/api/components/DocFromMarkdown.md

@@ -0,0 +1,27 @@
+# DocFromMarkdown
+
+Convert markdown to a Csharp doc comment
+
+* jsx
+
+  ```tsx
+  import { DocFromMarkdown } from "@alloy-js/csharp";
+
+
+  <DocFromMarkdown markdown="string" />
+  ```
+
+* stc
+
+  ```ts
+  import { DocFromMarkdown } from "@alloy-js/csharp/stc";
+
+
+  DocFromMarkdown({ markdown: string }).children(children)
+  ```
+
+## Props
+
+|          |        |   |
+| -------- | ------ | - |
+| markdown | string |   |

package/docs/api/components/DocInclude.md

@@ -0,0 +1,26 @@
+# DocInclude
+
+* jsx
+
+  ```tsx
+  import { DocInclude } from "@alloy-js/csharp";
+
+
+  <DocInclude file="string" path="string" />
+  ```
+
+* stc
+
+  ```ts
+  import { DocInclude } from "@alloy-js/csharp/stc";
+
+
+  DocInclude({ file: string, path: string }).children(children)
+  ```
+
+## Props
+
+|      |                 |                                                                                                                            |
+| ---- | --------------- | -------------------------------------------------------------------------------------------------------------------------- |
+| file | string          | is the file name of an external XML file. The file name is interpreted relative to the file that contains the include tag. |
+| path | optional string | is an XPath expression that selects some of the XML in the external XML file.                                              |

package/docs/api/components/DocList.md

@@ -0,0 +1,26 @@
+# DocList
+
+* jsx
+
+  ```tsx
+  import { DocList } from "@alloy-js/csharp";
+
+
+  <DocList items={Children[]} type={"bullet" | "number"} />
+  ```
+
+* stc
+
+  ```ts
+  import { DocList } from "@alloy-js/csharp/stc";
+
+
+  DocList({ items: Children[], type: "bullet" | "number" }).children(children)
+  ```
+
+## Props
+
+|       |                                              |   |
+| ----- | -------------------------------------------- | - |
+| items | [Children](../../../core/types/children/)\[] |   |
+| type  | optional “bullet” \| “number”                |   |

package/docs/api/components/DocPara.md

@@ -0,0 +1,27 @@
+# DocPara
+
+* jsx
+
+  ```tsx
+  import { DocPara } from "@alloy-js/csharp";
+
+
+  <DocPara >
+    {children}
+  </DocPara>
+  ```
+
+* stc
+
+  ```ts
+  import { DocPara } from "@alloy-js/csharp/stc";
+
+
+  DocPara({  }).children(children)
+  ```
+
+## Props
+
+|          |                                           |   |
+| -------- | ----------------------------------------- | - |
+| children | [Children](../../../core/types/children/) |   |

package/docs/api/components/DocParam.md

@@ -0,0 +1,28 @@
+# DocParam
+
+* jsx
+
+  ```tsx
+  import { DocParam } from "@alloy-js/csharp";
+
+
+  <DocParam name="string">
+    {children}
+  </DocParam>
+  ```
+
+* stc
+
+  ```ts
+  import { DocParam } from "@alloy-js/csharp/stc";
+
+
+  DocParam({ name: string }).children(children)
+  ```
+
+## Props
+
+|          |                                           |   |
+| -------- | ----------------------------------------- | - |
+| children | [Children](../../../core/types/children/) |   |
+| name     | string                                    |   |

package/docs/api/components/DocParamRef.md

@@ -0,0 +1,25 @@
+# DocParamRef
+
+* jsx
+
+  ```tsx
+  import { DocParamRef } from "@alloy-js/csharp";
+
+
+  <DocParamRef name="string" />
+  ```
+
+* stc
+
+  ```ts
+  import { DocParamRef } from "@alloy-js/csharp/stc";
+
+
+  DocParamRef({ name: string }).children(children)
+  ```
+
+## Props
+
+|      |        |   |
+| ---- | ------ | - |
+| name | string |   |

package/docs/api/components/DocPermission.md

@@ -0,0 +1,27 @@
+# DocPermission
+
+* jsx
+
+  ```tsx
+  import { DocPermission } from "@alloy-js/csharp";
+
+
+  <DocPermission >
+    {children}
+  </DocPermission>
+  ```
+
+* stc
+
+  ```ts
+  import { DocPermission } from "@alloy-js/csharp/stc";
+
+
+  DocPermission({  }).children(children)
+  ```
+
+## Props
+
+|          |                                           |   |
+| -------- | ----------------------------------------- | - |
+| children | [Children](../../../core/types/children/) |   |

package/docs/api/components/DocRemarks.md

@@ -0,0 +1,27 @@
+# DocRemarks
+
+* jsx
+
+  ```tsx
+  import { DocRemarks } from "@alloy-js/csharp";
+
+
+  <DocRemarks >
+    {children}
+  </DocRemarks>
+  ```
+
+* stc
+
+  ```ts
+  import { DocRemarks } from "@alloy-js/csharp/stc";
+
+
+  DocRemarks({  }).children(children)
+  ```
+
+## Props
+
+|          |                                           |   |
+| -------- | ----------------------------------------- | - |
+| children | [Children](../../../core/types/children/) |   |

package/docs/api/components/DocReturns.md

@@ -0,0 +1,27 @@
+# DocReturns
+
+* jsx
+
+  ```tsx
+  import { DocReturns } from "@alloy-js/csharp";
+
+
+  <DocReturns >
+    {children}
+  </DocReturns>
+  ```
+
+* stc
+
+  ```ts
+  import { DocReturns } from "@alloy-js/csharp/stc";
+
+
+  DocReturns({  }).children(children)
+  ```
+
+## Props
+
+|          |                                           |   |
+| -------- | ----------------------------------------- | - |
+| children | [Children](../../../core/types/children/) |   |