Skip to content

Commit 3582007

Browse files
authored
Document deprecation in comments for shapes and members (#258)
1 parent d9b0001 commit 3582007

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptWriter.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
import software.amazon.smithy.model.Model;
3434
import software.amazon.smithy.model.shapes.MemberShape;
3535
import software.amazon.smithy.model.shapes.Shape;
36+
import software.amazon.smithy.model.traits.DeprecatedTrait;
3637
import software.amazon.smithy.model.traits.DocumentationTrait;
3738
import software.amazon.smithy.utils.CodeWriter;
3839
import software.amazon.smithy.utils.StringUtils;
@@ -216,6 +217,9 @@ boolean writeShapeDocs(Shape shape) {
216217
return shape.getTrait(DocumentationTrait.class)
217218
.map(DocumentationTrait::getValue)
218219
.map(docs -> {
220+
if (shape.getTrait(DeprecatedTrait.class).isPresent()) {
221+
docs = "@deprecated\n\n" + docs;
222+
}
219223
writeDocs(docs);
220224
return true;
221225
}).orElse(false);
@@ -232,6 +236,9 @@ boolean writeMemberDocs(Model model, MemberShape member) {
232236
return member.getMemberTrait(model, DocumentationTrait.class)
233237
.map(DocumentationTrait::getValue)
234238
.map(docs -> {
239+
if (member.getMemberTrait(model, DeprecatedTrait.class).isPresent()) {
240+
docs = "@deprecated\n\n" + docs;
241+
}
235242
writeDocs(docs);
236243
return true;
237244
}).orElse(false);

0 commit comments

Comments
 (0)