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/29 14:17:16 UTC
[maven-doxia] branch DOXIA-569 updated: fix review feedback
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 54393282 fix review feedback
54393282 is described below
commit 54393282b8d2cc10a10829756b1618501251ef3a
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Thu Dec 29 15:17:07 2022 +0100
fix review feedback
---
.../maven/doxia/sink/impl/AbstractSinkTest.java | 2 +-
.../doxia/module/markdown/MarkdownMarkup.java | 23 ++++++-------------
.../maven/doxia/module/markdown/MarkdownSink.java | 26 +++++-----------------
.../doxia/module/markdown/MarkdownSinkTest.java | 8 +++----
4 files changed, 17 insertions(+), 42 deletions(-)
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractSinkTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractSinkTest.java
index ec19828a..d396a9af 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractSinkTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractSinkTest.java
@@ -492,7 +492,7 @@ public abstract class AbstractSinkTest
* the same result as {@link #getListBlock getListBlock}( item ).
*
*/
- public void _testList()
+ public void testList()
{
String item = "list_item";
sink.list();
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 05428767..88f0a4e4 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
@@ -33,36 +33,30 @@ public interface MarkdownMarkup
// Markup separators
// ----------------------------------------------------------------------
- /** APT backslash markup char: '\\' */
+ /** backslash markup char: '\\' */
char BACKSLASH = '\\';
String COMMENT_START = "<!-- ";
String COMMENT_END = " -->";
- /** APT numbering decimal markup char: '1' */
+ /** numbering decimal markup char: '1' */
char NUMBERING = '1';
- /** APT numbering lower alpha markup char: 'a' */
+ /** numbering lower alpha markup char: 'a' */
char NUMBERING_LOWER_ALPHA_CHAR = 'a';
- /** APT numbering lower roman markup char: 'i' */
+ /** numbering lower roman markup char: 'i' */
char NUMBERING_LOWER_ROMAN_CHAR = 'i';
- /** APT numbering upper alpha markup char: 'A' */
+ /** numbering upper alpha markup char: 'A' */
char NUMBERING_UPPER_ALPHA_CHAR = 'A';
- /** APT numbering upper roman markup char: 'I' */
+ /** numbering upper roman markup char: 'I' */
char NUMBERING_UPPER_ROMAN_CHAR = 'I';
- /** APT page break markup char: '\f' */
+ /** page break markup char: '\f' */
char PAGE_BREAK = '\f';
- /** APT percent markup char: '%' */
- char PERCENT = '%';
-
- /** APT tab markup char: '\t' */
- char TAB = '\t';
-
// ----------------------------------------------------------------------
// Markup syntax
// ----------------------------------------------------------------------
@@ -100,9 +94,6 @@ public interface MarkdownMarkup
/** Syntax for the link start: "](" */
String LINK_START_2_MARKUP = "](";
- /** Syntax for the list end: "[]" */
- String LIST_END_MARKUP = String.valueOf( LEFT_SQUARE_BRACKET ) + RIGHT_SQUARE_BRACKET;
-
/** Syntax for the list start: "-" */
String LIST_START_MARKUP = "-";
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 c5abccb4..1152960d 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
@@ -471,14 +471,7 @@ public class MarkdownSink
*/
public void numberedList_()
{
- if ( listNestingIndent.length() <= 1 )
- {
- write( EOL + listNestingIndent + LIST_END_MARKUP + EOL );
- }
- else
- {
- write( EOL );
- }
+ write( EOL );
listNestingIndent = StringUtils.chomp( listNestingIndent, " " );
listStyles.pop();
itemFlag = false;
@@ -518,14 +511,7 @@ public class MarkdownSink
*/
public void definitionList_()
{
- if ( listNestingIndent.length() <= 1 )
- {
- write( EOL + listNestingIndent + LIST_END_MARKUP + EOL );
- }
- else
- {
- write( EOL );
- }
+ write( EOL );
listNestingIndent = StringUtils.chomp( listNestingIndent, " " );
listStyles.pop();
itemFlag = false;
@@ -991,7 +977,7 @@ public class MarkdownSink
}
else
{
- write( "\\" + EOL );
+ write( BACKSLASH + EOL );
}
}
@@ -1079,7 +1065,7 @@ public class MarkdownSink
*/
protected void content( String text )
{
- write( escapeAPT( text ) );
+ write( escapeMarkdown( text ) );
}
/**
@@ -1115,7 +1101,7 @@ public class MarkdownSink
// ----------------------------------------------------------------------
/**
- * Escape special characters in a text in APT:
+ * Escape special characters in a text in Markdown:
*
* <pre>
* \~, \=, \-, \+, \*, \[, \], \<, \>, \{, \}, \\
@@ -1124,7 +1110,7 @@ public class MarkdownSink
* @param text the String to escape, may be null
* @return the text escaped, "" if null String input
*/
- private static String escapeAPT( String text )
+ private static String escapeMarkdown( String text )
{
if ( text == null )
{
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 a4fc143e..0cb58b4e 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
@@ -159,8 +159,7 @@ public class MarkdownSinkTest extends AbstractSinkTest
/** {@inheritDoc} */
protected String getListBlock( String item )
{
- return EOL + EOL + Markup.SPACE + "" + MarkdownMarkup.LIST_START_MARKUP + "" + Markup.SPACE + item + EOL + EOL
- + Markup.SPACE + "" + MarkdownMarkup.LIST_END_MARKUP + EOL;
+ return EOL + EOL + Markup.SPACE + "" + MarkdownMarkup.LIST_START_MARKUP + "" + Markup.SPACE + item + EOL + EOL;
}
/** {@inheritDoc} */
@@ -168,15 +167,14 @@ public class MarkdownSinkTest extends AbstractSinkTest
{
return EOL + EOL + Markup.SPACE + ""
+ MarkdownMarkup.NUMBERING_LOWER_ROMAN_CHAR + ""
- + Markup.SPACE + item + EOL + EOL + Markup.SPACE + "" + MarkdownMarkup.LIST_END_MARKUP + EOL;
+ + Markup.SPACE + item + EOL + EOL;
}
/** {@inheritDoc} */
protected String getDefinitionListBlock( String definum, String definition )
{
return EOL + EOL + Markup.SPACE + "" + Markup.LEFT_SQUARE_BRACKET + definum
- + Markup.RIGHT_SQUARE_BRACKET + "" + Markup.SPACE + definition + EOL + EOL
- + Markup.SPACE + "" + MarkdownMarkup.LIST_END_MARKUP + EOL;
+ + Markup.RIGHT_SQUARE_BRACKET + "" + Markup.SPACE + definition + EOL + EOL;
}
/** {@inheritDoc} */