Skip to content

Commit ea953e1

Browse files
authored
Move documentation before release tag and deprecation (#1211)
1 parent a17478e commit ea953e1

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -189,15 +189,15 @@ boolean writeShapeDocs(Shape shape, UnaryOperator<String> preprocessor) {
189189
docs = docs.replace("{", "\\{")
190190
.replace("}", "\\}");
191191
docs = preprocessor.apply(docs);
192+
docs = addReleaseTag(shape, docs);
192193
if (shape.getTrait(DeprecatedTrait.class).isPresent()) {
193194
DeprecatedTrait deprecatedTrait = shape.expectTrait(DeprecatedTrait.class);
194195
String deprecationMessage = deprecatedTrait.getMessage()
195196
.map(msg -> " " + msg)
196197
.orElse("");
197198
String deprecationString = "@deprecated" + deprecationMessage;
198-
docs = deprecationString + "\n\n" + docs;
199+
docs = docs + "\n" + deprecationString;
199200
}
200-
docs = addReleaseTag(shape, docs);
201201
writeDocs(docs);
202202
return true;
203203
}).orElse(false);
@@ -248,9 +248,9 @@ private boolean isTargetDeprecated(Model model, MemberShape member) {
248248

249249
private String addReleaseTag(Shape shape, String docs) {
250250
if (shape.getTrait(InternalTrait.class).isPresent()) {
251-
docs = "@internal\n" + docs;
251+
docs = docs + "\n@internal";
252252
} else {
253-
docs = "@public\n" + docs;
253+
docs = docs + "\n@public";
254254
}
255255
return docs;
256256
}

0 commit comments

Comments
 (0)