Simplify & make DocXmlWriter more consistent

fern-api · Oct 4, 2024 · 8f8e20c · 8f8e20c
1 parent 669164a
commit 8f8e20c
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 32 deletions.
diff --git a/generators/csharp/codegen/src/ast/Class.ts b/generators/csharp/codegen/src/ast/Class.ts
@@ -5,6 +5,7 @@ import { ClassInstantiation } from "./ClassInstantiation";
 import { ClassReference } from "./ClassReference";
 import { CodeBlock } from "./CodeBlock";
 import { AstNode } from "./core/AstNode";
+import { DocXmlWriter } from "./core/DocXmlWriter";
 import { Writer } from "./core/Writer";
 import { Field } from "./Field";
 import { Interface } from "./Interface";
@@ -168,7 +169,8 @@ export class Class extends AstNode {
         }
 
         if (this.summary != null) {
-            writer.writeDocXml().writeNodeWithEscaping("summary", this.summary);
+            const docXmlWriter = new DocXmlWriter(writer);
+            docXmlWriter.writeNodeWithEscaping("summary", this.summary);
         }
         if (this.annotations.length > 0) {
             writer.write("[");

diff --git a/generators/csharp/codegen/src/ast/Field.ts b/generators/csharp/codegen/src/ast/Field.ts
@@ -3,6 +3,7 @@ import { Annotation } from "./Annotation";
 import { ClassReference } from "./ClassReference";
 import { CodeBlock } from "./CodeBlock";
 import { AstNode } from "./core/AstNode";
+import { DocXmlWriter } from "./core/DocXmlWriter";
 import { Writer } from "./core/Writer";
 import { Type } from "./Type";
 
@@ -108,7 +109,8 @@ export class Field extends AstNode {
 
     public write(writer: Writer): void {
         if (this.summary != null) {
-            writer.writeDocXml().writeNodeWithEscaping("summary", this.summary);
+            const docXmlWriter = new DocXmlWriter(writer);
+            docXmlWriter.writeNodeWithEscaping("summary", this.summary);
         }
 
         if (this.annotations.length > 0) {

diff --git a/generators/csharp/codegen/src/ast/Method.ts b/generators/csharp/codegen/src/ast/Method.ts
@@ -3,6 +3,7 @@ import { Annotation } from "./Annotation";
 import { ClassReference } from "./ClassReference";
 import { CodeBlock } from "./CodeBlock";
 import { AstNode } from "./core/AstNode";
+import { DocXmlWriter } from "./core/DocXmlWriter";
 import { Writer } from "./core/Writer";
 import { Parameter } from "./Parameter";
 import { Type } from "./Type";
@@ -89,17 +90,16 @@ export class Method extends AstNode {
     }
 
     public write(writer: Writer): void {
+        const docXmlWriter = new DocXmlWriter(writer);
         if (this.summary != null) {
-            writer.writeDocXml().writeNodeWithEscaping("summary", this.summary);
+            docXmlWriter.writeNodeWithEscaping("summary", this.summary);
         }
         if (this.codeExample != null) {
-            writer
-                .writeDocXml()
-                .writeOpenNode("example")
-                .writeOpenNode("code")
-                .writeMultilineWithEscaping(this.codeExample)
-                .writeCloseNode("code")
-                .writeCloseNode("example");
+            docXmlWriter.writeOpenNode("example");
+            docXmlWriter.writeOpenNode("code");
+            docXmlWriter.writeMultilineWithEscaping(this.codeExample);
+            docXmlWriter.writeCloseNode("code");
+            docXmlWriter.writeCloseNode("example");
         }
 
         if (this.annotations.length > 0) {

diff --git a/generators/csharp/codegen/src/ast/core/DocXmlWriter.ts b/generators/csharp/codegen/src/ast/core/DocXmlWriter.ts
@@ -6,53 +6,46 @@ export class DocXmlWriter {
         this.writer = writer;
     }
 
-    public writeLine(text?: string): this {
+    public writeLine(text?: string): void {
         this.writer.writeLine(`/// ${text}`);
-        return this;
     }
 
     public writePrefix(): this {
         this.writer.write("/// ");
         return this;
     }
 
-    public writeOpenNode(nodeName: string): this {
+    public writeOpenNode(nodeName: string): void {
         this.writeLine(`<${nodeName}>`);
-        return this;
     }
 
-    public writeCloseNode(nodeName: string): this {
+    public writeCloseNode(nodeName: string): void {
         this.writeLine(`</${nodeName}>`);
-        return this;
     }
 
-    public writeNode(nodeName: string, text: string): this {
+    public writeNode(nodeName: string, text: string): void {
         this.writeOpenNode(nodeName);
         this.writeMultiline(text);
         this.writeCloseNode(nodeName);
-        return this;
     }
 
-    public writeNodeWithEscaping(nodeName: string, text: string): this {
+    public writeNodeWithEscaping(nodeName: string, text: string): void {
         this.writeOpenNode(nodeName);
         this.writeMultilineWithEscaping(text);
         this.writeCloseNode(nodeName);
-        return this;
     }
 
-    public writeMultiline(text: string): this {
+    public writeMultiline(text: string): void {
         text.trim()
             .split("\n")
             .forEach((line) => {
                 this.writeLine(line);
             });
-        return this;
     }
 
-    public writeMultilineWithEscaping(text: string): this {
+    public writeMultilineWithEscaping(text: string): void {
         text = this.escapeXmlDocContent(text);
         this.writeMultiline(text);
-        return this;
     }
 
     private escapeXmlDocContent(text: string): string {

diff --git a/generators/csharp/codegen/src/ast/core/Writer.ts b/generators/csharp/codegen/src/ast/core/Writer.ts
@@ -95,14 +95,6 @@ export class Writer extends AbstractWriter {
         return this.customConfig["simplify-object-dictionaries"] ?? true;
     }
 
-    public writeDocXml(write?: (writer: DocXmlWriter) => void): DocXmlWriter {
-        const writer = new DocXmlWriter(this);
-        if (write) {
-            write(writer);
-        }
-        return writer;
-    }
-
     public toString(skipImports = false): string {
         if (!skipImports) {
             const imports = this.stringifyImports();