Document lineBreakRendering

commonmark · Sep 24, 2024 · 1906ee9 · 1906ee9
1 parent 97eeb6a
commit 1906ee9
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 6 deletions.
diff --git a/commonmark/src/main/java/org/commonmark/renderer/text/TextContentNodeRendererContext.java b/commonmark/src/main/java/org/commonmark/renderer/text/TextContentNodeRendererContext.java
@@ -5,9 +5,7 @@
 public interface TextContentNodeRendererContext {
 
     /**
-     * TODO
-     *
-     * @return
+     * Controls how line breaks should be rendered, see {@link LineBreakRendering}.
      */
     LineBreakRendering lineBreakRendering();
 

diff --git a/commonmark/src/main/java/org/commonmark/renderer/text/TextContentRenderer.java b/commonmark/src/main/java/org/commonmark/renderer/text/TextContentRenderer.java
@@ -70,10 +70,11 @@ public TextContentRenderer build() {
         }
 
         /**
-         * TODO
+         * Configure how line breaks (newlines) are rendered, see {@link LineBreakRendering}.
+         * The default is {@link LineBreakRendering#COMPACT}.
          *
-         * @param lineBreakRendering
-         * @return
+         * @param lineBreakRendering the mode to use
+         * @return {@code this}
          */
         public Builder lineBreakRendering(LineBreakRendering lineBreakRendering) {
             this.lineBreakRendering = lineBreakRendering;