fix: generate jsdocs for operations with no documentation (#971)

smithy-lang · Sep 28, 2023 · f574977 · f574977
1 parent 2f70f10
commit f574977
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/.changeset/four-kids-grin.md b/.changeset/four-kids-grin.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/...ipt-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CommandGenerator.java b/...ipt-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CommandGenerator.java
@@ -42,8 +42,10 @@
 import software.amazon.smithy.model.shapes.Shape;
 import software.amazon.smithy.model.shapes.ShapeId;
 import software.amazon.smithy.model.shapes.StructureShape;
+import software.amazon.smithy.model.traits.DeprecatedTrait;
 import software.amazon.smithy.model.traits.DocumentationTrait;
 import software.amazon.smithy.model.traits.ErrorTrait;
+import software.amazon.smithy.model.traits.InternalTrait;
 import software.amazon.smithy.rulesengine.traits.EndpointRuleSetTrait;
 import software.amazon.smithy.typescript.codegen.documentation.StructureExampleGenerator;
 import software.amazon.smithy.typescript.codegen.endpointsV2.EndpointsParamNameMap;
@@ -139,9 +141,23 @@ private void generateClientCommand() {
                 .append("\n")
                 .append(getThrownExceptions());
 
-        writer.writeShapeDocs(
+        boolean operationHasDocumentation = operation.hasTrait(DocumentationTrait.class);
+
+        if (operationHasDocumentation) {
+            writer.writeShapeDocs(
                 operation,
-                shapeDoc -> shapeDoc + additionalDocs);
+                shapeDoc -> shapeDoc + additionalDocs
+            );
+        } else {
+            boolean isPublic = !operation.hasTrait(InternalTrait.class);
+            boolean isDeprecated = operation.hasTrait(DeprecatedTrait.class);
+
+            writer.writeDocs(
+                (isPublic ? "@public\n" : "@internal\n")
+                + (isDeprecated ? "@deprecated\n" : "")
+                + additionalDocs
+            );
+        }
 
         writer.openBlock(
                 "export class $L extends $$Command<$T, $T, $L> {", "}",