From 1906ee9c6966616ed65f1d4eba8e925c9cf3a1f1 Mon Sep 17 00:00:00 2001 From: Robin Stocker Date: Tue, 24 Sep 2024 18:52:23 +1000 Subject: [PATCH] Document lineBreakRendering --- .../renderer/text/TextContentNodeRendererContext.java | 4 +--- .../org/commonmark/renderer/text/TextContentRenderer.java | 7 ++++--- 2 files changed, 5 insertions(+), 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 index b3685f67..d6fcb8d7 100644 --- 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 index c36f0a27..57006bfc 100644 --- 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;