fix newlines in generated markdown

CraftTweaker · Apr 27, 2021 · 54454e9 · 54454e9
1 parent 6680115
commit 54454e9
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 6 deletions.
diff --git a/...ttweaker_annotation_processors/processors/document/page/comment/DocumentationComment.java b/...ttweaker_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", " <br /> ");
+    }
+
     public boolean hasDescription() {
         return getOptionalDescription().isPresent();
     }

diff --git a/...ed/crafttweaker_annotation_processors/processors/document/page/member/PropertyMember.java b/...ed/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/...otation_processors/processors/document/page/member/header/DocumentedGenericParameter.java b/...otation_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/...ker_annotation_processors/processors/document/page/member/header/DocumentedParameter.java b/...ker_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/...notation_processors/processors/document/page/member/static_member/StaticMethodMember.java b/...notation_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/...notation_processors/processors/document/page/member/virtual_member/ConstructorMember.java b/...notation_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/..._annotation_processors/processors/document/page/member/virtual_member/OperatorMember.java b/..._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();
         }
     }