feat: add code examples for properties

src/docgen/transpile/java.ts

@@ -8,6 +8,11 @@ const toCamelCase = (text?: string) => {
   return Case.camel(text ?? '');
 };
 
+const toUpperCamelCase = (test?: string) => {
+  const camelCase = toCamelCase(test);
+  return camelCase.charAt(0).toUpperCase() + camelCase.slice(1);
+};
+
 // [1, 2, 3] -> [[], [1], [1, 2], [1, 2, 3]]
 const prefixArrays = <T>(arr: T[]): T[][] => {
   const out: T[][] = [[]];
@@ -166,20 +171,24 @@ export class JavaTranspile extends transpile.TranspileBase {
   public parameter(
     parameter: reflect.Parameter,
   ): transpile.TranspiledParameter {
+    const typeRef = this.typeReference(parameter.type);
     return {
       name: parameter.name,
       parentType: this.type(parameter.parentType),
-      typeReference: this.typeReference(parameter.type),
+      typeReference: typeRef,
       optional: parameter.optional,
+      declaration: this.formatProperty(parameter.name, typeRef),
     };
   }
 
   public property(property: reflect.Property): transpile.TranspiledProperty {
+    const typeRef = this.typeReference(property.type);
     return {
       name: property.name,
       parentType: this.type(property.parentType),
-      typeReference: this.typeReference(property.type),
+      typeReference: typeRef,
       optional: property.optional,
+      declaration: this.formatProperty(property.name, typeRef),
     };
   }
 
@@ -373,4 +382,18 @@ export class JavaTranspile extends transpile.TranspileBase {
     parameters.splice(parameters.indexOf(firstStruct), 1);
     return struct;
   }
+
+  private formatProperty(
+    name: string,
+    typeReference: transpile.TranspiledTypeReference,
+  ): string {
+    const tf = typeReference.toString({
+      typeFormatter: (t) => t.name,
+    });
+    if (tf.includes(' OR ')) {
+      return `public java.lang.Object get${toUpperCamelCase(name)}();`;
+    } else {
+      return `public ${tf} get${toUpperCamelCase(name)}();`;
+    }
+  }
 }

src/docgen/transpile/python.ts

@@ -138,11 +138,14 @@ export class PythonTranspile extends transpile.TranspileBase {
   }
 
   public property(property: reflect.Property): transpile.TranspiledProperty {
+    const name = property.const ? property.name : toSnakeCase(property.name);
+    const typeRef = this.typeReference(property.type);
     return {
-      name: property.const ? property.name : toSnakeCase(property.name),
+      name,
       parentType: this.type(property.parentType),
-      typeReference: this.typeReference(property.type),
+      typeReference: typeRef,
       optional: property.optional,
+      declaration: this.formatProperty(name, typeRef),
     };
   }
 
@@ -156,11 +159,14 @@ export class PythonTranspile extends transpile.TranspileBase {
   public parameter(
     parameter: reflect.Parameter,
   ): transpile.TranspiledParameter {
+    const name = toSnakeCase(parameter.name);
+    const typeRef = this.typeReference(parameter.type);
     return {
-      name: toSnakeCase(parameter.name),
+      name,
       parentType: this.type(parameter.parentType),
-      typeReference: this.typeReference(parameter.type),
+      typeReference: typeRef,
       optional: parameter.optional,
+      declaration: this.formatProperty(name, typeRef),
     };
   }
 
@@ -267,4 +273,14 @@ export class PythonTranspile extends transpile.TranspileBase {
     });
     return `${transpiled.name}: ${tf}${transpiled.optional ? ' = None' : ''}`;
   }
+
+  private formatProperty(
+    name: string,
+    typeReference: transpile.TranspiledTypeReference,
+  ): string {
+    const tf = typeReference.toString({
+      typeFormatter: (t) => t.name,
+    });
+    return `${name}: ${tf}`;
+  }
 }

src/docgen/transpile/transpile.ts

@@ -144,6 +144,11 @@ export interface TranspiledParameter {
    * Whether or not the parameter is optional.
    */
   readonly optional: boolean;
+  /**
+   * The signature of the property, or its getter if the language
+   * supports that.
+   */
+  readonly declaration: string;
 }
 
 /**

src/docgen/transpile/typescript.ts

@@ -112,11 +112,13 @@ export class TypeScriptTranspile extends transpile.TranspileBase {
   }
 
   public property(property: reflect.Property): transpile.TranspiledProperty {
+    const typeRef = this.typeReference(property.type);
     return {
       name: property.name,
       parentType: this.type(property.parentType),
-      typeReference: this.typeReference(property.type),
+      typeReference: typeRef,
       optional: property.optional,
+      declaration: this.formatProperty(property.name, typeRef),
     };
   }
 
@@ -130,11 +132,13 @@ export class TypeScriptTranspile extends transpile.TranspileBase {
   public parameter(
     parameter: reflect.Parameter,
   ): transpile.TranspiledParameter {
+    const typeRef = this.typeReference(parameter.type);
     return {
       name: parameter.name,
       parentType: this.type(parameter.parentType),
-      typeReference: this.typeReference(parameter.type),
+      typeReference: typeRef,
       optional: parameter.optional,
+      declaration: this.formatProperty(parameter.name, typeRef),
     };
   }
 
@@ -209,4 +213,14 @@ export class TypeScriptTranspile extends transpile.TranspileBase {
     });
     return `${transpiled.name}${transpiled.optional ? '?' : ''}: ${tf}`;
   }
+
+  private formatProperty(
+    name: string,
+    typeReference: transpile.TranspiledTypeReference,
+  ): string {
+    const tf = typeReference.toString({
+      typeFormatter: (t) => t.name,
+    });
+    return `public readonly ${name}: ${tf};`;
+  }
 }

src/docgen/view/property.ts

@@ -5,7 +5,7 @@ import { Transpile, TranspiledProperty, TranspiledType } from '../transpile/tran
 export class Property {
   private readonly transpiled: TranspiledProperty;
   constructor(
-    transpile: Transpile,
+    private readonly transpile: Transpile,
     private readonly property: reflect.Property,
     private readonly linkFormatter: (type: TranspiledType) => string,
   ) {
@@ -38,6 +38,10 @@ export class Property {
       md.lines('');
     }
 
+    if (!this.property.const) {
+      md.code(this.transpile.language.toString(), this.transpiled.declaration);
+    }
+
     const metadata: any = {
       Type: this.transpiled.typeReference.toString({
         typeFormatter: (t) => `[${Markdown.pre(t.fqn)}](${this.linkFormatter(t)})`,