From 54454e9a85b7e57334be59b421477bfe6a74c08c Mon Sep 17 00:00:00 2001 From: Jared Date: Tue, 27 Apr 2021 22:55:32 +0200 Subject: [PATCH] fix newlines in generated markdown --- .../document/page/comment/DocumentationComment.java | 4 ++++ .../processors/document/page/member/PropertyMember.java | 2 +- .../page/member/header/DocumentedGenericParameter.java | 2 +- .../document/page/member/header/DocumentedParameter.java | 2 +- .../page/member/static_member/StaticMethodMember.java | 2 +- .../page/member/virtual_member/ConstructorMember.java | 2 +- .../document/page/member/virtual_member/OperatorMember.java | 2 +- 7 files changed, 10 insertions(+), 6 deletions(-) diff --git a/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/comment/DocumentationComment.java b/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/comment/DocumentationComment.java index 96959e440..e136a19a4 100644 --- a/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/comment/DocumentationComment.java +++ b/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/comment/DocumentationComment.java @@ -27,6 +27,10 @@ public String getDescription() { return getOptionalDescription().orElse("No Description Provided"); } + public String getMarkdownDescription(){ + return getDescription().replaceAll("\n", "
"); + } + public boolean hasDescription() { return getOptionalDescription().isPresent(); } diff --git a/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/PropertyMember.java b/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/PropertyMember.java index d4a8f93cd..e7365726c 100644 --- a/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/PropertyMember.java +++ b/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/PropertyMember.java @@ -37,7 +37,7 @@ public static PropertyMember merge(PropertyMember left, PropertyMember right) { } public void writeTableRow(PrintWriter writer) { - writer.printf("| %s | %s | %s | %s | %s |%n", name, type.getClickableMarkdown(), hasGetter, hasSetter, comment.getDescription()); + writer.printf("| %s | %s | %s | %s | %s |%n", name, type.getClickableMarkdown(), hasGetter, hasSetter, comment.getMarkdownDescription()); } public String getName() { diff --git a/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/header/DocumentedGenericParameter.java b/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/header/DocumentedGenericParameter.java index c74e2860b..9ebcefc62 100644 --- a/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/header/DocumentedGenericParameter.java +++ b/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/header/DocumentedGenericParameter.java @@ -55,7 +55,7 @@ public int numberOfExamples() { } public String getDescription() { - return comment.getDescription(); + return comment.getMarkdownDescription(); } public String getExample(int exampleIndex) { diff --git a/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/header/DocumentedParameter.java b/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/header/DocumentedParameter.java index 8a74fa758..35155e83f 100644 --- a/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/header/DocumentedParameter.java +++ b/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/header/DocumentedParameter.java @@ -27,7 +27,7 @@ public int numberOfExamples() { } public String getDescription() { - return comment.getDescription(); + return comment.getMarkdownDescription(); } public boolean isOptional() { diff --git a/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/static_member/StaticMethodMember.java b/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/static_member/StaticMethodMember.java index 64825068b..6cfa7d643 100644 --- a/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/static_member/StaticMethodMember.java +++ b/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/static_member/StaticMethodMember.java @@ -91,7 +91,7 @@ private boolean returnTypeInfoPresent() { private void writeDescription(PrintWriter writer) { if(methodComment.hasDescription()) { - writer.println(methodComment.getDescription()); + writer.println(methodComment.getMarkdownDescription()); writer.println(); } } diff --git a/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/virtual_member/ConstructorMember.java b/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/virtual_member/ConstructorMember.java index f5a07d93d..77bf09161 100644 --- a/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/virtual_member/ConstructorMember.java +++ b/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/virtual_member/ConstructorMember.java @@ -31,7 +31,7 @@ private void writeParameterDescriptionTable(PrintWriter writer) { private void writeDescription(PrintWriter writer) { final DocumentationComment comment = getComment(); - writer.println(comment.getDescription()); + writer.println(comment.getMarkdownDescription()); } private AbstractTypeInfo getConstructedType() { diff --git a/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/virtual_member/OperatorMember.java b/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/virtual_member/OperatorMember.java index b5f2efe86..4c9416b6c 100644 --- a/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/virtual_member/OperatorMember.java +++ b/Crafttweaker_Annotation_Processors/src/main/java/com/blamejared/crafttweaker_annotation_processors/processors/document/page/member/virtual_member/OperatorMember.java @@ -42,7 +42,7 @@ private void writeTitle(PrintWriter writer) { private void writeDescription(PrintWriter writer) { if(getComment().hasDescription()) { - writer.println(getComment().getDescription()); + writer.println(getComment().getMarkdownDescription()); writer.println(); } }