You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2022/12/28 15:37:40 UTC
[maven-doxia] branch DOXIA-569 updated: add comments
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch DOXIA-569
in repository https://gitbox.apache.org/repos/asf/maven-doxia.git
The following commit(s) were added to refs/heads/DOXIA-569 by this push:
new a42bf1ee add comments
a42bf1ee is described below
commit a42bf1eee7019b5a2a69a8227961df05d5c63a1c
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Wed Dec 28 16:37:31 2022 +0100
add comments
---
.../java/org/apache/maven/doxia/module/markdown/MarkdownMarkup.java | 4 ++--
.../java/org/apache/maven/doxia/module/markdown/MarkdownSink.java | 2 +-
.../java/org/apache/maven/doxia/module/markdown/MarkdownSinkTest.java | 4 ++--
3 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownMarkup.java b/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownMarkup.java
index 6c2e97c7..05428767 100644
--- a/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownMarkup.java
+++ b/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownMarkup.java
@@ -36,8 +36,8 @@ public interface MarkdownMarkup
/** APT backslash markup char: '\\' */
char BACKSLASH = '\\';
- /** APT comment markup char: '~' */
- char COMMENT = '~';
+ String COMMENT_START = "<!-- ";
+ String COMMENT_END = " -->";
/** APT numbering decimal markup char: '1' */
char NUMBERING = '1';
diff --git a/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownSink.java b/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownSink.java
index c50f46ca..c5abccb4 100644
--- a/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownSink.java
+++ b/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownSink.java
@@ -1040,7 +1040,7 @@ public class MarkdownSink
/** {@inheritDoc} */
public void comment( String comment )
{
- rawText( ( startFlag ? "" : EOL ) + COMMENT + COMMENT + comment );
+ rawText( ( startFlag ? "" : EOL ) + COMMENT_START + comment + COMMENT_END );
}
/**
diff --git a/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownSinkTest.java b/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownSinkTest.java
index 8afa2b86..a4fc143e 100644
--- a/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownSinkTest.java
+++ b/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownSinkTest.java
@@ -337,7 +337,7 @@ public class MarkdownSinkTest extends AbstractSinkTest
{
// "\\~, \\=, \\-, \\+, \\*, \\[, \\], \\<, \\>, \\{, \\}, \\\\"
StringBuilder sb = new StringBuilder();
- sb.append( getSpecialCharacters( MarkdownMarkup.COMMENT ) ).append( ",_" );
+ sb.append( getSpecialCharacters( '~' ) ).append( ",_" );
sb.append( getSpecialCharacters( Markup.EQUAL ) ).append( ",_" );
sb.append( getSpecialCharacters( Markup.MINUS ) ).append( ",_" );
sb.append( getSpecialCharacters( Markup.PLUS ) ).append( ",_" );
@@ -379,7 +379,7 @@ public class MarkdownSinkTest extends AbstractSinkTest
/** {@inheritDoc} */
protected String getCommentBlock( String text )
{
- return "~~" + text;
+ return "<!-- " + text + " -->";
}
/**