@alloy-js/csharp 0.18.0-dev.6 → 0.18.0-dev.8

package/dist/src/components/ClassDeclaration.d.ts

@@ -9,6 +9,8 @@ export interface ClassModifiers {
 }
 export interface ClassDeclarationProps extends Omit<core.DeclarationProps, "nameKind">, AccessModifiers, ClassModifiers {
     name: string;
+    /** Doc comment */
+    doc?: core.Children;
     refkey?: core.Refkey;
     typeParameters?: Record<string, core.Refkey>;
 }

package/dist/src/components/ClassDeclaration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ClassDeclaration.d.ts","sourceRoot":"","sources":["../../../src/components/ClassDeclaration.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gBAAgB,CAAC;AACvC,OAAO,EACL,eAAe,EAIhB,MAAM,iBAAiB,CAAC;AAKzB,OAAO,EAAE,cAAc,EAAc,MAAM,kBAAkB,CAAC;AAE9D,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;CAC3B;AAUD,MAAM,WAAW,qBACf,SAAQ,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC,EAC7C,eAAe,EACf,cAAc;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;CAC9C;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,iBAwD5D;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,UAAU,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACnC,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;IAC3B,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC;CAC1B;AAGD,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,iBAkC5D;AAGD,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC;IACpB,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;CACtB;AAGD,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,iBAyBlD"}
+{"version":3,"file":"ClassDeclaration.d.ts","sourceRoot":"","sources":["../../../src/components/ClassDeclaration.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gBAAgB,CAAC;AACvC,OAAO,EACL,eAAe,EAIhB,MAAM,iBAAiB,CAAC;AAKzB,OAAO,EAAE,cAAc,EAAc,MAAM,kBAAkB,CAAC;AAG9D,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;CAC3B;AAUD,MAAM,WAAW,qBACf,SAAQ,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC,EAC7C,eAAe,EACf,cAAc;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB;IAClB,GAAG,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC;IACpB,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;CAC9C;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,iBAyD5D;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,UAAU,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACnC,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;IAC3B,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC;CAC1B;AAGD,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,iBAkC5D;AAGD,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC;IACpB,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;CACtB;AAGD,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,iBAyBlD"}

package/dist/src/components/ClassDeclaration.js

@@ -6,6 +6,7 @@ import { CSharpOutputSymbol } from "../symbols/csharp-output-symbol.js";
 import { CSharpMemberScope, useCSharpScope } from "../symbols/scopes.js";
 import { Name } from "./Name.js";
 import { Parameters } from "./Parameters.js";
+import { DocWhen } from "./doc/comment.js";
 const getClassModifiers = makeModifiers(["abstract", "partial", "sealed", "static"]);
 
 // properties for creating a class
@@ -74,7 +75,11 @@ export function ClassDeclaration(props) {
   return _$createComponent(core.Declaration, {
     symbol: thisClassSymbol,
     get children() {
-      return [modifiers, "class ", _$createComponent(Name, {}), typeParams, _$memo(() => !props.children && ";"), _$memo(() => _$memo(() => !!props.children)() && _$createComponent(core.Block, {
+      return [_$createComponent(DocWhen, {
+        get doc() {
+          return props.doc;
+        }
+      }), modifiers, "class ", _$createComponent(Name, {}), typeParams, _$memo(() => !props.children && ";"), _$memo(() => _$memo(() => !!props.children)() && _$createComponent(core.Block, {
         newline: true,
         get children() {
           return _$createComponent(core.Scope, {

package/dist/src/components/ClassMethod.d.ts

@@ -1,7 +1,14 @@
 import { Children, Refkey } from "@alloy-js/core";
-import { AccessModifiers, MethodModifiers } from "../modifiers.js";
+import { AccessModifiers } from "../modifiers.js";
 import { ParameterProps } from "./Parameters.jsx";
-export interface ClassMethodProps extends AccessModifiers, MethodModifiers {
+/** Method modifiers. Can only be one. */
+export interface ClassMethodModifiers {
+    readonly abstract?: boolean;
+    readonly sealed?: boolean;
+    readonly static?: boolean;
+    readonly virtual?: boolean;
+}
+export interface ClassMethodProps extends AccessModifiers, ClassMethodModifiers {
     name: string;
     refkey?: Refkey;
     children?: Children;
@@ -11,6 +18,8 @@ export interface ClassMethodProps extends AccessModifiers, MethodModifiers {
      * If true, the method will be declared as an async method.
      */
     async?: boolean;
+    /** Doc comment */
+    doc?: Children;
 }
 export declare function ClassMethod(props: ClassMethodProps): Children;
 //# sourceMappingURL=ClassMethod.d.ts.map

package/dist/src/components/ClassMethod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ClassMethod.d.ts","sourceRoot":"","sources":["../../../src/components/ClassMethod.tsx"],"names":[],"mappings":"AAAA,OAAO,EAEL,QAAQ,EAGR,MAAM,EAEP,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,eAAe,EAKf,eAAe,EAChB,MAAM,iBAAiB,CAAC;AAIzB,OAAO,EAAE,cAAc,EAAc,MAAM,kBAAkB,CAAC;AAG9D,MAAM,WAAW,gBAAiB,SAAQ,eAAe,EAAE,eAAe;IACxE,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,UAAU,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACnC,OAAO,CAAC,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAGD,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,YAoClD"}
+{"version":3,"file":"ClassMethod.d.ts","sourceRoot":"","sources":["../../../src/components/ClassMethod.tsx"],"names":[],"mappings":"AAAA,OAAO,EAEL,QAAQ,EAGR,MAAM,EAEP,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,eAAe,EAKhB,MAAM,iBAAiB,CAAC;AAIzB,OAAO,EAAE,cAAc,EAAc,MAAM,kBAAkB,CAAC;AAG9D,yCAAyC;AACzC,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC5B;AAUD,MAAM,WAAW,gBACf,SAAQ,eAAe,EACrB,oBAAoB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,UAAU,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACnC,OAAO,CAAC,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,kBAAkB;IAClB,GAAG,CAAC,EAAE,QAAQ,CAAC;CAChB;AAGD,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,YAqClD"}

package/dist/src/components/ClassMethod.js

@@ -1,10 +1,15 @@
 import { createComponent as _$createComponent, memo as _$memo } from "@alloy-js/core/jsx-runtime";
 import { Block, MemberDeclaration, refkey, Scope } from "@alloy-js/core";
-import { computeModifiersPrefix, getAccessModifier, getAsyncModifier, getMethodModifier } from "../modifiers.js";
+import { computeModifiersPrefix, getAccessModifier, getAsyncModifier, makeModifiers } from "../modifiers.js";
 import { useCSharpNamePolicy } from "../name-policy.js";
 import { CSharpOutputSymbol } from "../symbols/csharp-output-symbol.js";
 import { CSharpMemberScope, useCSharpScope } from "../symbols/scopes.js";
 import { Parameters } from "./Parameters.js";
+import { DocWhen } from "./doc/comment.js";
+
+/** Method modifiers. Can only be one. */
+
+const getMethodModifier = makeModifiers(["abstract", "sealed", "static", "virtual"]);
 
 // properties for creating a method
 
@@ -38,7 +43,11 @@ export function ClassMethod(props) {
       return _$createComponent(Scope, {
         value: methodScope,
         get children() {
-          return [modifiers, returns, " ", name, "(", params, ")", _$memo(() => _$memo(() => !!props.abstract)() ? ";" : _$createComponent(Block, {
+          return [_$createComponent(DocWhen, {
+            get doc() {
+              return props.doc;
+            }
+          }), modifiers, returns, " ", name, "(", params, ")", _$memo(() => _$memo(() => !!props.abstract)() ? ";" : _$createComponent(Block, {
             newline: true,
             get children() {
               return props.children;

package/dist/src/components/doc/comment.d.ts

@@ -0,0 +1,69 @@
+import { Children } from "@alloy-js/core";
+export interface DocCommentProps {
+    children: Children;
+}
+export declare function DocComment(props: DocCommentProps): Children;
+export interface DocWhenProps {
+    doc: Children | undefined;
+}
+/** Conditionally render the given doc in a <DocComment /> component and tail with a line */
+export declare function DocWhen(props: DocWhenProps): Children;
+export interface DocCommentTagProps {
+    children: Children;
+}
+export declare function makeDocCommentTag(name: string): (props: DocCommentProps) => Children;
+export declare function makeInlineDocCommentTag(name: string): (props: DocCommentProps) => string;
+export declare const DocSummary: (props: DocCommentProps) => Children;
+export declare const DocCode: (props: DocCommentProps) => Children;
+export declare const DocC: (props: DocCommentProps) => Children;
+export declare const DocExample: (props: DocCommentProps) => Children;
+export declare const DocException: (props: DocCommentProps) => Children;
+export interface DocIncludeProps {
+    /**  is the file name of an external XML file. The file name is interpreted relative to the file that contains the include tag. */
+    file: string;
+    /** is an XPath expression that selects some of the XML in the external XML file. */
+    path?: string;
+}
+export declare const DocInclude: (props: DocIncludeProps) => string;
+export interface DocParamProps {
+    name: string;
+    children: Children;
+}
+export declare const DocParam: (props: DocParamProps) => Children;
+export interface DocTypeParamProps {
+    name: string;
+    children: Children;
+}
+export declare const DocTypeParam: (props: DocTypeParamProps) => Children;
+export declare const DocReturns: (props: DocCommentProps) => Children;
+export declare const DocRemarks: (props: DocCommentProps) => Children;
+export declare const DocValue: (props: DocCommentProps) => Children;
+export declare const DocPermission: (props: DocCommentProps) => Children;
+export declare const DocResponse: (props: DocCommentProps) => Children;
+export declare const DocCompletionList: (props: DocCommentProps) => Children;
+export declare const DocList: (props: DocCommentProps) => Children;
+export declare const DocItem: (props: DocCommentProps) => Children;
+export declare const DocTerm: (props: DocCommentProps) => Children;
+export declare const DocDescription: (props: DocCommentProps) => Children;
+export declare const DocPara: (props: DocCommentProps) => Children;
+export interface DocSeeProps {
+    cref: string;
+    langword?: string;
+    children?: Children;
+}
+export declare const DocSee: (props: DocSeeProps) => string;
+export interface DocSeeAlsoProps {
+    cref: string;
+    langword?: string;
+    children?: Children;
+}
+export declare const DocSeeAlso: (props: DocSeeAlsoProps) => string;
+export interface DocParamRefProps {
+    name: string;
+}
+export declare const DocParamRef: (props: DocParamRefProps) => string;
+export interface DocTypeParamRefProps {
+    name: string;
+}
+export declare const DocTypeParamRef: (props: DocTypeParamRefProps) => string;
+//# sourceMappingURL=comment.d.ts.map

package/dist/src/components/doc/comment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"comment.d.ts","sourceRoot":"","sources":["../../../../src/components/doc/comment.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAA2B,MAAM,gBAAgB,CAAC;AAEnE,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,eAAe,YAShD;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,QAAQ,GAAG,SAAS,CAAC;CAC3B;AAED,4FAA4F;AAC5F,wBAAgB,OAAO,CAAC,KAAK,EAAE,YAAY,YAO1C;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,IACd,OAAO,eAAe,cAUrD;AACD,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,IACpB,OAAO,eAAe,YAGrD;AAED,eAAO,MAAM,UAAU,UAjBgB,eAAe,aAiBA,CAAC;AACvD,eAAO,MAAM,OAAO,UAlBmB,eAAe,aAkBN,CAAC;AACjD,eAAO,MAAM,IAAI,UAnBsB,eAAe,aAmBZ,CAAC;AAC3C,eAAO,MAAM,UAAU,UApBgB,eAAe,aAoBA,CAAC;AACvD,eAAO,MAAM,YAAY,UArBc,eAAe,aAqBI,CAAC;AAE3D,MAAM,WAAW,eAAe;IAC9B,kIAAkI;IAClI,IAAI,EAAE,MAAM,CAAC;IACb,oFAAoF;IACpF,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AACD,eAAO,MAAM,UAAU,GAAI,OAAO,eAAe,WAEhD,CAAC;AAEF,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,QAAQ,CAAC;CACpB;AACD,eAAO,MAAM,QAAQ,GAAI,OAAO,aAAa,aACgB,CAAC;AAE9D,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,QAAQ,CAAC;CACpB;AACD,eAAO,MAAM,YAAY,GAAI,OAAO,iBAAiB,aACgB,CAAC;AAEtE,eAAO,MAAM,UAAU,UA/CgB,eAAe,aA+CA,CAAC;AACvD,eAAO,MAAM,UAAU,UAhDgB,eAAe,aAgDA,CAAC;AACvD,eAAO,MAAM,QAAQ,UAjDkB,eAAe,aAiDJ,CAAC;AACnD,eAAO,MAAM,aAAa,UAlDa,eAAe,aAkDM,CAAC;AAC7D,eAAO,MAAM,WAAW,UAnDe,eAAe,aAmDE,CAAC;AACzD,eAAO,MAAM,iBAAiB,UApDS,eAAe,aAoDc,CAAC;AACrE,eAAO,MAAM,OAAO,UArDmB,eAAe,aAqDN,CAAC;AACjD,eAAO,MAAM,OAAO,UAtDmB,eAAe,aAsDN,CAAC;AACjD,eAAO,MAAM,OAAO,UAvDmB,eAAe,aAuDN,CAAC;AACjD,eAAO,MAAM,cAAc,UAxDY,eAAe,aAwDQ,CAAC;AAC/D,eAAO,MAAM,OAAO,UAzDmB,eAAe,aAyDN,CAAC;AAEjD,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AACD,eAAO,MAAM,MAAM,GAAI,OAAO,WAAW,WACkG,CAAC;AAE5I,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AACD,eAAO,MAAM,UAAU,GAAI,OAAO,eAAe,WACkG,CAAC;AAEpJ,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;CACd;AACD,eAAO,MAAM,WAAW,GAAI,OAAO,gBAAgB,WACd,CAAC;AAEtC,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;CACd;AACD,eAAO,MAAM,eAAe,GAAI,OAAO,oBAAoB,WAClB,CAAC"}

package/dist/src/components/doc/comment.js

@@ -0,0 +1,71 @@
+import { createComponent as _$createComponent, createIntrinsic as _$createIntrinsic, memo as _$memo } from "@alloy-js/core/jsx-runtime";
+import { code, List, Prose, Show } from "@alloy-js/core";
+export function DocComment(props) {
+  return ["/// ", _$createIntrinsic("align", {
+    string: "/// ",
+    get children() {
+      return _$createComponent(List, {
+        get children() {
+          return props.children;
+        }
+      });
+    }
+  })];
+}
+/** Conditionally render the given doc in a <DocComment /> component and tail with a line */
+export function DocWhen(props) {
+  return _$createComponent(Show, {
+    get when() {
+      return Boolean(props.doc);
+    },
+    get children() {
+      return [_$createComponent(DocComment, {
+        get children() {
+          return props.doc;
+        }
+      }), _$createIntrinsic("hbr", {})];
+    }
+  });
+}
+export function makeDocCommentTag(name) {
+  return function DocCommentTag(props) {
+    return _$createComponent(Prose, {
+      get children() {
+        return code`
+        <${name}>
+        ${props.children}
+        </${name}>`;
+      }
+    });
+  };
+}
+export function makeInlineDocCommentTag(name) {
+  return function DocCommentTag(props) {
+    return `<${name}>${props.children}</${name}>`;
+  };
+}
+export const DocSummary = makeDocCommentTag("summary");
+export const DocCode = makeDocCommentTag("code");
+export const DocC = makeDocCommentTag("c");
+export const DocExample = makeDocCommentTag("example");
+export const DocException = makeDocCommentTag("exception");
+export const DocInclude = props => {
+  return `<include file="${props.file}" path="${props.path}" />`;
+};
+export const DocParam = props => code`<param name="${props.name}">${props.children}</param>`;
+export const DocTypeParam = props => code`<typeparam name="${props.name}">${props.children}</typeparam>`;
+export const DocReturns = makeDocCommentTag("returns");
+export const DocRemarks = makeDocCommentTag("remarks");
+export const DocValue = makeDocCommentTag("value");
+export const DocPermission = makeDocCommentTag("permission");
+export const DocResponse = makeDocCommentTag("response");
+export const DocCompletionList = makeDocCommentTag("completionlist");
+export const DocList = makeDocCommentTag("list");
+export const DocItem = makeDocCommentTag("item");
+export const DocTerm = makeDocCommentTag("term");
+export const DocDescription = makeDocCommentTag("description");
+export const DocPara = makeDocCommentTag("para");
+export const DocSee = props => `<see cref="${props.cref}"${props.langword ? ` langword="${props.langword}"` : ""}${props.children ? `>${props.children}</see>` : " />"}`;
+export const DocSeeAlso = props => `<seealso cref="${props.cref}"${props.langword ? ` langword="${props.langword}"` : ""}${props.children ? `>${props.children}</seealso>` : " />"}`;
+export const DocParamRef = props => `<paramref name="${props.name}" />`;
+export const DocTypeParamRef = props => `<typeparamref name="${props.name}" />`;

package/dist/src/components/doc/comment.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=comment.test.d.ts.map

package/dist/src/components/doc/comment.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"comment.test.d.ts","sourceRoot":"","sources":["../../../../src/components/doc/comment.test.tsx"],"names":[],"mappings":""}

package/dist/src/components/doc/comment.test.js

@@ -0,0 +1,338 @@
+import { createComponent as _$createComponent, memo as _$memo } from "@alloy-js/core/jsx-runtime";
+import { expect, it } from "vitest";
+import { DocC, DocCode, DocComment, DocCompletionList, DocDescription, DocExample, DocException, DocInclude, DocItem, DocList, DocPara, DocParam, DocParamRef, DocPermission, DocRemarks, DocResponse, DocReturns, DocSee, DocSeeAlso, DocSummary, DocTerm, DocTypeParam, DocTypeParamRef, DocValue } from "./comment.js";
+it("define summary", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocSummary, {
+        children: "This is a sample doc comment"
+      });
+    }
+  })).toRenderTo(`
+    /// <summary>
+    /// This is a sample doc comment
+    /// </summary>
+  `);
+});
+it("define code", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocCode, {
+        children: "code sample"
+      });
+    }
+  })).toRenderTo(`
+    /// <code>
+    /// code sample
+    /// </code>
+  `);
+});
+it("define c", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocC, {
+        children: "inline code"
+      });
+    }
+  })).toRenderTo(`
+    /// <c>
+    /// inline code
+    /// </c>
+  `);
+});
+it("define example", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocExample, {
+        children: "example usage"
+      });
+    }
+  })).toRenderTo(`
+    /// <example>
+    /// example usage
+    /// </example>
+  `);
+});
+it("define exception", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocException, {
+        children: "exception info"
+      });
+    }
+  })).toRenderTo(`
+    /// <exception>
+    /// exception info
+    /// </exception>
+  `);
+});
+it("define include", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return [_$memo(() => DocInclude({
+        file: "external.xml",
+        path: "/doc/summary"
+      }))];
+    }
+  })).toRenderTo(`
+    /// <include file="external.xml" path="/doc/summary" />
+  `);
+});
+it("define param", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocParam, {
+        name: "x",
+        children: "parameter x"
+      });
+    }
+  })).toRenderTo(`
+    /// <param name="x">parameter x</param>
+  `);
+});
+it("define typeparam", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocTypeParam, {
+        name: "T",
+        children: "type parameter T"
+      });
+    }
+  })).toRenderTo(`
+    /// <typeparam name="T">type parameter T</typeparam>
+  `);
+});
+it("define returns", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocReturns, {
+        children: "return value"
+      });
+    }
+  })).toRenderTo(`
+    /// <returns>
+    /// return value
+    /// </returns>
+  `);
+});
+it("define remarks", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocRemarks, {
+        children: "remarks here"
+      });
+    }
+  })).toRenderTo(`
+    /// <remarks>
+    /// remarks here
+    /// </remarks>
+  `);
+});
+it("define value", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocValue, {
+        children: "property value"
+      });
+    }
+  })).toRenderTo(`
+    /// <value>
+    /// property value
+    /// </value>
+  `);
+});
+it("define permission", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocPermission, {
+        children: "permission info"
+      });
+    }
+  })).toRenderTo(`
+    /// <permission>
+    /// permission info
+    /// </permission>
+  `);
+});
+it("define response", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocResponse, {
+        children: "response info"
+      });
+    }
+  })).toRenderTo(`
+    /// <response>
+    /// response info
+    /// </response>
+  `);
+});
+it("define completionlist", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocCompletionList, {
+        children: "completion list"
+      });
+    }
+  })).toRenderTo(`
+    /// <completionlist>
+    /// completion list
+    /// </completionlist>
+  `);
+});
+it("define list", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocList, {
+        children: "list content"
+      });
+    }
+  })).toRenderTo(`
+    /// <list>
+    /// list content
+    /// </list>
+  `);
+});
+it("define item", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocItem, {
+        children: "item content"
+      });
+    }
+  })).toRenderTo(`
+    /// <item>
+    /// item content
+    /// </item>
+  `);
+});
+it("define term", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocTerm, {
+        children: "term content"
+      });
+    }
+  })).toRenderTo(`
+    /// <term>
+    /// term content
+    /// </term>
+  `);
+});
+it("define description", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocDescription, {
+        children: "description content"
+      });
+    }
+  })).toRenderTo(`
+    /// <description>
+    /// description content
+    /// </description>
+  `);
+});
+it("define para", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocPara, {
+        children: "paragraph content"
+      });
+    }
+  })).toRenderTo(`
+    /// <para>
+    /// paragraph content
+    /// </para>
+  `);
+});
+it("define see", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return [_$memo(() => DocSee({
+        cref: "T:MyType"
+      }))];
+    }
+  })).toRenderTo(`
+    /// <see cref="T:MyType" />
+  `);
+});
+it("define seealso", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return [_$memo(() => DocSeeAlso({
+        cref: "T:OtherType"
+      }))];
+    }
+  })).toRenderTo(`
+    /// <seealso cref="T:OtherType" />
+  `);
+});
+it("define paramref", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return [_$memo(() => DocParamRef({
+        name: "x"
+      }))];
+    }
+  })).toRenderTo(`
+    /// <paramref name="x" />
+  `);
+});
+it("define typeparamref", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return [_$memo(() => DocTypeParamRef({
+        name: "T"
+      }))];
+    }
+  })).toRenderTo(`
+    /// <typeparamref name="T" />
+  `);
+});
+it("wrap long summary", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocSummary, {
+        children: "This is a very long sample doc comment that exceeds the typical line length limit and should be wrapped appropriately in the generated documentation."
+      });
+    }
+  })).toRenderTo(`
+    /// <summary>
+    /// This is a very long sample doc comment that exceeds the typical line length limit
+    /// and should be wrapped appropriately in the generated documentation.
+    /// </summary>
+  `);
+});
+it("combine multiple tags", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return [_$createComponent(DocSummary, {
+        children: "This operator determines whether two Points have the same location."
+      }), _$createComponent(DocParam, {
+        name: "p1",
+        children: "The first Point to be compared."
+      }), _$createComponent(DocParam, {
+        name: "p2",
+        children: "The second Point to be compared."
+      }), _$createComponent(DocReturns, {
+        children: "True if the Points do not have the same location and the exact same type; otherwise, false."
+      }), _$createComponent(DocSeeAlso, {
+        cref: "Equals"
+      }), _$createComponent(DocSeeAlso, {
+        cref: "operator=="
+      })];
+    }
+  })).toRenderTo(`
+    /// <summary>
+    /// This operator determines whether two Points have the same location.
+    /// </summary>
+    /// <param name="p1">The first Point to be compared.</param>
+    /// <param name="p2">The second Point to be compared.</param>
+    /// <returns>
+    /// True if the Points do not have the same location and the exact same type; otherwise,
+    /// false.
+    /// </returns>
+    /// <seealso cref="Equals" />
+    /// <seealso cref="operator==" />
+  `);
+});

package/dist/src/components/index.d.ts

@@ -1,7 +1,9 @@
 export * from "./ClassDeclaration.jsx";
-export { ClassMethod, type ClassMethodProps } from "./ClassMethod.jsx";
+export * from "./ClassMethod.jsx";
 export * from "./Declaration.js";
 export * from "./EnumDeclaration.jsx";
+export * from "./interface/declaration.js";
+export * from "./interface/method.js";
 export * from "./Name.js";
 export * from "./Namespace.js";
 export * from "./Parameters.js";

package/dist/src/components/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,KAAK,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACvE,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC"}

package/dist/src/components/index.js

@@ -1,7 +1,9 @@
 export * from "./ClassDeclaration.js";
-export { ClassMethod } from "./ClassMethod.js";
+export * from "./ClassMethod.js";
 export * from "./Declaration.js";
 export * from "./EnumDeclaration.js";
+export * from "./interface/declaration.js";
+export * from "./interface/method.js";
 export * from "./Name.js";
 export * from "./Namespace.js";
 export * from "./Parameters.js";

package/dist/src/components/interface/declaration.d.ts

@@ -0,0 +1,34 @@
+import * as core from "@alloy-js/core";
+import { AccessModifiers } from "../../modifiers.js";
+export interface InterfaceModifiers {
+    readonly partial?: boolean;
+}
+export interface InterfaceDeclarationProps extends Omit<core.DeclarationProps, "nameKind">, AccessModifiers, InterfaceModifiers {
+    name: string;
+    /** Doc comment */
+    doc?: core.Children;
+    refkey?: core.Refkey;
+    typeParameters?: Record<string, core.Refkey>;
+}
+/**
+ * CSharp interface declaration.
+ * @example
+ * ```tsx
+ * <InterfaceDeclaration public name="IMyInterface">
+ *   <InterfaceMember public name="MyProperty" type="int" />
+ *   <InterfaceMethod public name="MyMethod" returnType="void">
+ *     <Parameter name="value" type="int" />
+ *   </InterfaceMethod>
+ * </InterfaceDeclaration>
+ * ```
+ * This will produce:
+ * ```csharp
+ * public interface MyIface
+ * {
+ *   public int MyProperty { get; set; }
+ *   public void MyMethod(int value);
+ * }
+ * ```
+ */
+export declare function InterfaceDeclaration(props: InterfaceDeclarationProps): core.Children;
+//# sourceMappingURL=declaration.d.ts.map

package/dist/src/components/interface/declaration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"declaration.d.ts","sourceRoot":"","sources":["../../../../src/components/interface/declaration.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gBAAgB,CAAC;AACvC,OAAO,EACL,eAAe,EAIhB,MAAM,oBAAoB,CAAC;AAO5B,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC5B;AAKD,MAAM,WAAW,yBACf,SAAQ,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC,EAC7C,eAAe,EACf,kBAAkB;IACpB,IAAI,EAAE,MAAM,CAAC;IAEb,kBAAkB;IAClB,GAAG,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC;IACpB,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;CAC9C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,iBAwDpE"}