Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move documentation before release tag and deprecation #1211

Merged
merged 1 commit into from
Mar 15, 2024
Merged

Move documentation before release tag and deprecation #1211

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions ...ipt-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,15 +189,15 @@ boolean writeShapeDocs(Shape shape, UnaryOperator<String> preprocessor) {
docs = docs.replace("{", "\\{")
.replace("}", "\\}");
docs = preprocessor.apply(docs);
docs = addReleaseTag(shape, docs);
if (shape.getTrait(DeprecatedTrait.class).isPresent()) {
DeprecatedTrait deprecatedTrait = shape.expectTrait(DeprecatedTrait.class);
String deprecationMessage = deprecatedTrait.getMessage()
.map(msg -> " " + msg)
.orElse("");
String deprecationString = "@deprecated" + deprecationMessage;
docs = deprecationString + "\n\n" + docs;
docs = docs + "\n" + deprecationString;
}
docs = addReleaseTag(shape, docs);
writeDocs(docs);
return true;
}).orElse(false);
Expand Down Expand Up @@ -248,9 +248,9 @@ private boolean isTargetDeprecated(Model model, MemberShape member) {

private String addReleaseTag(Shape shape, String docs) {
if (shape.getTrait(InternalTrait.class).isPresent()) {
docs = "@internal\n" + docs;
docs = docs + "\n@internal";
} else {
docs = "@public\n" + docs;
docs = docs + "\n@public";
}
return docs;
}
Expand Down
Loading