Document lineBreakRendering

robinst · robinst · commit 1906ee9c6966 · 2024-09-24T18:52:23.000+10:00
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;

Original file line number	Diff line number	Diff line change
`@@ -70,10 +70,11 @@ public TextContentRenderer build() {`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`/**`
`73`		`- * TODO`
	`73`	`+ * Configure how line breaks (newlines) are rendered, see {@link LineBreakRendering}.`
	`74`	`+ * The default is {@link LineBreakRendering#COMPACT}.`
`74`	`75`	`*`
`75`		`- * @param lineBreakRendering`
`76`		`- * @return`
	`76`	`+ * @param lineBreakRendering the mode to use`
	`77`	`+ * @return {@code this}`
`77`	`78`	`*/`
`78`	`79`	`public Builder lineBreakRendering(LineBreakRendering lineBreakRendering) {`
`79`	`80`	`this.lineBreakRendering = lineBreakRendering;`