You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2020/02/12 01:40:45 UTC
[maven-doxia] branch javadocfix created (now be4769c)
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a change to branch javadocfix
in repository https://gitbox.apache.org/repos/asf/maven-doxia.git.
at be4769c (doc) fix javadoc warnings
This branch includes the following new commits:
new be4769c (doc) fix javadoc warnings
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[maven-doxia] 01/01: (doc) fix javadoc warnings
Posted by sl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch javadocfix
in repository https://gitbox.apache.org/repos/asf/maven-doxia.git
commit be4769c1a53118aef753e484bacfaefc503ed7a5
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Tue Feb 11 23:26:19 2020 +0100
(doc) fix javadoc warnings
---
.../java/org/apache/maven/doxia/DefaultDoxia.java | 1 -
.../main/java/org/apache/maven/doxia/Doxia.java | 1 -
.../org/apache/maven/doxia/index/IndexEntry.java | 3 +-
.../org/apache/maven/doxia/index/IndexingSink.java | 92 ++++--
.../apache/maven/doxia/macro/AbstractMacro.java | 2 -
.../org/apache/maven/doxia/macro/EchoMacro.java | 2 -
.../java/org/apache/maven/doxia/macro/Macro.java | 1 -
.../maven/doxia/macro/MacroExecutionException.java | 1 -
.../org/apache/maven/doxia/macro/MacroRequest.java | 25 +-
.../org/apache/maven/doxia/macro/SsiMacro.java | 1 +
.../org/apache/maven/doxia/macro/SwfMacro.java | 1 -
.../doxia/macro/manager/DefaultMacroManager.java | 1 -
.../maven/doxia/macro/manager/MacroManager.java | 1 -
.../macro/manager/MacroNotFoundException.java | 1 -
.../maven/doxia/macro/snippet/SnippetMacro.java | 6 +-
.../maven/doxia/macro/snippet/SnippetReader.java | 2 -
.../org/apache/maven/doxia/macro/toc/TocMacro.java | 1 -
.../org/apache/maven/doxia/markup/HtmlMarkup.java | 2 -
.../java/org/apache/maven/doxia/markup/Markup.java | 1 -
.../org/apache/maven/doxia/markup/TextMarkup.java | 1 -
.../org/apache/maven/doxia/markup/XmlMarkup.java | 1 -
.../apache/maven/doxia/parser/AbstractParser.java | 18 +-
.../maven/doxia/parser/AbstractTextParser.java | 1 -
.../maven/doxia/parser/AbstractXmlParser.java | 1 -
.../apache/maven/doxia/parser/ParseException.java | 1 -
.../java/org/apache/maven/doxia/parser/Parser.java | 1 -
.../maven/doxia/parser/Xhtml5BaseParser.java | 4 +-
.../apache/maven/doxia/parser/XhtmlBaseParser.java | 4 +-
.../doxia/parser/manager/DefaultParserManager.java | 1 -
.../maven/doxia/parser/manager/ParserManager.java | 1 -
.../parser/manager/ParserNotFoundException.java | 1 -
.../doxia/parser/module/AbstractParserModule.java | 26 +-
.../parser/module/DefaultParserModuleManager.java | 6 +-
.../doxia/sink/impl/AbstractBinarySinkFactory.java | 1 -
.../apache/maven/doxia/sink/impl/AbstractSink.java | 20 +-
.../maven/doxia/sink/impl/AbstractTextSink.java | 1 -
.../doxia/sink/impl/AbstractTextSinkFactory.java | 1 -
.../maven/doxia/sink/impl/AbstractXmlSink.java | 6 +-
.../doxia/sink/impl/AbstractXmlSinkFactory.java | 1 -
.../apache/maven/doxia/sink/impl/PipelineSink.java | 5 +-
.../maven/doxia/sink/impl/RandomAccessSink.java | 202 +++++++++++-
.../apache/maven/doxia/sink/impl/SinkAdapter.java | 166 +++++++++-
.../doxia/sink/impl/SinkEventAttributeSet.java | 32 +-
.../apache/maven/doxia/sink/impl/SinkUtils.java | 1 -
.../maven/doxia/sink/impl/Xhtml5BaseSink.java | 126 ++------
.../maven/doxia/sink/impl/XhtmlBaseSink.java | 3 +-
.../maven/doxia/util/ByLineReaderSource.java | 35 ++-
.../org/apache/maven/doxia/util/ByLineSource.java | 1 -
.../org/apache/maven/doxia/util/DoxiaUtils.java | 15 -
.../org/apache/maven/doxia/util/HtmlTools.java | 1 -
.../org/apache/maven/doxia/util/LineBreaker.java | 2 -
.../org/apache/maven/doxia/util/XmlValidator.java | 1 -
.../javadoc/org/apache/maven/doxia/package.html | 30 +-
.../org/apache/maven/doxia/AbstractModuleTest.java | 1 -
.../apache/maven/doxia/index/IndexEntryTest.java | 1 -
.../doxia/macro/snippet/SnippetMacroTest.java | 1 -
.../apache/maven/doxia/macro/toc/TocMacroTest.java | 1 -
.../maven/doxia/module/AbstractIdentityTest.java | 3 -
.../maven/doxia/parser/AbstractParserTest.java | 2 -
.../maven/doxia/parser/AbstractParserTestCase.java | 1 -
.../maven/doxia/parser/XhtmlBaseParserTest.java | 1 -
.../doxia/sink/impl/AbstractSinkTestCase.java | 1 -
.../maven/doxia/sink/impl/SinkEventElement.java | 1 -
.../doxia/sink/impl/SinkEventTestingSink.java | 1 -
.../maven/doxia/sink/impl/SinkTestDocument.java | 2 -
.../sink/impl/WellformednessCheckingSink.java | 1 -
.../maven/doxia/sink/impl/XhtmlBaseSinkTest.java | 1 -
.../apache/maven/doxia/util/DoxiaUtilsTest.java | 1 -
.../org/apache/maven/doxia/util/HtmlToolsTest.java | 1 -
.../apache/maven/doxia/util/XmlValidatorTest.java | 1 -
.../maven/doxia/xsd/AbstractXmlValidatorTest.java | 1 -
.../java/org/apache/maven/doxia/logging/Log.java | 1 -
.../org/apache/maven/doxia/logging/LogEnabled.java | 1 -
.../maven/doxia/logging/PlexusLoggerWrapper.java | 49 ++-
.../maven/doxia/logging/SystemStreamLog.java | 49 ++-
.../apache/maven/doxia/module/apt/AptMarkup.java | 2 -
.../maven/doxia/module/apt/AptParseException.java | 1 -
.../apache/maven/doxia/module/apt/AptParser.java | 7 +-
.../maven/doxia/module/apt/AptReaderSource.java | 21 +-
.../org/apache/maven/doxia/module/apt/AptSink.java | 261 ++++++++++++----
.../maven/doxia/module/apt/AptSinkFactory.java | 1 -
.../apache/maven/doxia/module/apt/AptSource.java | 2 -
.../apache/maven/doxia/module/apt/AptUtils.java | 4 -
.../maven/doxia/module/apt/AptParserTest.java | 2 -
.../maven/doxia/module/apt/AptUtilsTest.java | 1 -
.../doxia/module/confluence/ConfluenceMarkup.java | 3 +-
.../doxia/module/confluence/ConfluenceParser.java | 7 +-
.../doxia/module/confluence/ConfluenceSink.java | 178 ++++++++---
.../module/confluence/ConfluenceSinkFactory.java | 1 -
.../confluence/parser/AbstractFatherBlock.java | 2 -
.../module/confluence/parser/AnchorBlock.java | 2 +-
.../doxia/module/confluence/parser/Block.java | 2 -
.../module/confluence/parser/BlockParser.java | 2 -
.../doxia/module/confluence/parser/BoldBlock.java | 2 -
.../confluence/parser/ChildBlocksBuilder.java | 1 -
.../confluence/parser/DefinitionListBlock.java | 2 +-
.../parser/DefinitionListBlockParser.java | 1 -
.../module/confluence/parser/FigureBlock.java | 2 +-
.../confluence/parser/FigureBlockParser.java | 1 -
.../confluence/parser/HorizontalRuleBlock.java | 2 +-
.../parser/HorizontalRuleBlockParser.java | 2 -
.../module/confluence/parser/ItalicBlock.java | 2 +-
.../module/confluence/parser/LinebreakBlock.java | 1 -
.../module/confluence/parser/LinethroughBlock.java | 9 +-
.../doxia/module/confluence/parser/LinkBlock.java | 2 +-
.../module/confluence/parser/MonospaceBlock.java | 2 +-
.../module/confluence/parser/ParagraphBlock.java | 3 +-
.../confluence/parser/ParagraphBlockParser.java | 5 +-
.../module/confluence/parser/SectionBlock.java | 3 +-
.../confluence/parser/SectionBlockParser.java | 1 -
.../doxia/module/confluence/parser/SubBlock.java | 9 +-
.../doxia/module/confluence/parser/SupBlock.java | 9 +-
.../doxia/module/confluence/parser/TextBlock.java | 1 -
.../module/confluence/parser/UnderlineBlock.java | 9 +-
.../module/confluence/parser/VerbatimBlock.java | 3 +-
.../confluence/parser/VerbatimBlockParser.java | 1 -
.../confluence/parser/list/BulletedListBlock.java | 3 +-
.../module/confluence/parser/list/ListBlock.java | 3 +-
.../confluence/parser/list/ListBlockParser.java | 1 -
.../confluence/parser/list/ListItemBlock.java | 2 +-
.../confluence/parser/list/NumberedListBlock.java | 2 -
.../confluence/parser/list/TreeComponent.java | 9 +-
.../confluence/parser/list/TreeListBuilder.java | 2 -
.../module/confluence/parser/table/TableBlock.java | 2 +-
.../confluence/parser/table/TableBlockParser.java | 3 +-
.../confluence/parser/table/TableCellBlock.java | 2 +-
.../parser/table/TableCellHeaderBlock.java | 2 +-
.../confluence/parser/table/TableRowBlock.java | 2 +-
.../module/confluence/ConfluenceSinkTest.java | 1 -
.../maven/doxia/module/docbook/DocBookParser.java | 5 +-
.../maven/doxia/module/docbook/DocBookSink.java | 140 +++++++--
.../maven/doxia/module/docbook/DocbookMarkup.java | 1 -
.../doxia/module/docbook/DocbookSinkFactory.java | 1 -
.../maven/doxia/module/docbook/DocbookUtils.java | 2 +-
.../module/docbook/SimplifiedDocbookMarkup.java | 1 -
.../doxia/module/docbook/DocBookParserTest.java | 1 -
.../doxia/module/docbook/DocBookSinkTest.java | 1 -
.../doxia/module/docbook/DocbookUtilsTest.java | 1 -
.../maven/doxia/module/fml/FmlContentParser.java | 5 +-
.../apache/maven/doxia/module/fml/FmlMarkup.java | 1 -
.../apache/maven/doxia/module/fml/FmlParser.java | 5 +-
.../maven/doxia/module/fml/FmlParserTest.java | 1 -
.../maven/doxia/module/fml/FmlValidatorTest.java | 1 -
.../maven/doxia/module/fo/FoAggregateSink.java | 56 ++--
.../maven/doxia/module/fo/FoConfiguration.java | 1 -
.../org/apache/maven/doxia/module/fo/FoMarkup.java | 1 -
.../org/apache/maven/doxia/module/fo/FoSink.java | 343 +++++++++++++++------
.../maven/doxia/module/fo/FoSinkFactory.java | 1 -
.../org/apache/maven/doxia/module/fo/FoUtils.java | 1 -
.../maven/doxia/module/fo/NumberedListItem.java | 1 -
.../maven/doxia/module/fo/FoAggregateSinkTest.java | 2 -
.../maven/doxia/module/fo/FoConfigurationTest.java | 2 -
.../apache/maven/doxia/module/fo/FoSinkTest.java | 2 -
.../apache/maven/doxia/module/itext/ITextFont.java | 2 -
.../maven/doxia/module/itext/ITextHeader.java | 1 -
.../apache/maven/doxia/module/itext/ITextSink.java | 334 ++++++++++++++------
.../maven/doxia/module/itext/ITextSinkFactory.java | 1 -
.../apache/maven/doxia/module/itext/ITextUtil.java | 1 -
.../doxia/module/itext/SinkActionContext.java | 1 -
.../doxia/module/itext/ITextSinkTestCase.java | 1 -
.../maven/doxia/module/itext/ITextUtilTest.java | 1 -
.../apache/maven/doxia/module/latex/LatexSink.java | 63 ++--
.../maven/doxia/module/latex/LatexSinkFactory.java | 1 -
.../maven/doxia/module/latex/LatexSinkTest.java | 1 -
.../module/markdown/FlexmarkDoxiaExtension.java | 8 +
.../module/markdown/FlexmarkDoxiaLinkResolver.java | 18 +-
.../module/markdown/FlexmarkDoxiaNodeRenderer.java | 1 +
.../doxia/module/markdown/MarkdownParser.java | 6 +
.../maven/doxia/module/rtf/AlphaNumerals.java | 2 +-
.../org/apache/maven/doxia/module/rtf/Font.java | 2 -
.../apache/maven/doxia/module/rtf/FontMetrics.java | 2 +-
.../apache/maven/doxia/module/rtf/Monospace.java | 2 +-
.../maven/doxia/module/rtf/MonospaceBold.java | 2 +-
.../doxia/module/rtf/MonospaceBoldItalic.java | 2 +-
.../maven/doxia/module/rtf/MonospaceItalic.java | 2 +-
.../apache/maven/doxia/module/rtf/PBMReader.java | 2 -
.../maven/doxia/module/rtf/RomanNumerals.java | 2 +-
.../org/apache/maven/doxia/module/rtf/RtfSink.java | 307 +++++++++++++-----
.../maven/doxia/module/rtf/RtfSinkFactory.java | 1 -
.../apache/maven/doxia/module/rtf/SansSerif.java | 2 +-
.../maven/doxia/module/rtf/SansSerifBold.java | 2 +-
.../doxia/module/rtf/SansSerifBoldItalic.java | 2 +-
.../maven/doxia/module/rtf/SansSerifItalic.java | 2 +-
.../org/apache/maven/doxia/module/rtf/Serif.java | 2 +-
.../apache/maven/doxia/module/rtf/SerifBold.java | 2 +-
.../maven/doxia/module/rtf/SerifBoldItalic.java | 2 +-
.../apache/maven/doxia/module/rtf/SerifItalic.java | 2 +-
.../apache/maven/doxia/module/rtf/WMFWriter.java | 2 +-
.../apache/maven/doxia/module/rtf/RtfSinkTest.java | 1 -
.../maven/doxia/module/twiki/TWikiMarkup.java | 4 +-
.../maven/doxia/module/twiki/TWikiParser.java | 7 +-
.../apache/maven/doxia/module/twiki/TWikiSink.java | 190 ++++++++----
.../maven/doxia/module/twiki/TWikiSinkFactory.java | 1 -
.../module/twiki/parser/AbstractFatherBlock.java | 9 +-
.../doxia/module/twiki/parser/AnchorBlock.java | 17 +-
.../maven/doxia/module/twiki/parser/Block.java | 1 -
.../doxia/module/twiki/parser/BlockParser.java | 1 -
.../maven/doxia/module/twiki/parser/BoldBlock.java | 1 -
.../module/twiki/parser/FormatedTextParser.java | 2 -
.../twiki/parser/GenericListBlockParser.java | 7 +-
.../module/twiki/parser/HRuleBlockParser.java | 5 +-
.../module/twiki/parser/HorizontalRuleBlock.java | 7 +-
.../doxia/module/twiki/parser/ImageBlock.java | 7 +-
.../doxia/module/twiki/parser/ItalicBlock.java | 1 -
.../maven/doxia/module/twiki/parser/LinkBlock.java | 7 +-
.../maven/doxia/module/twiki/parser/ListBlock.java | 1 -
.../doxia/module/twiki/parser/ListItemBlock.java | 7 +-
.../doxia/module/twiki/parser/MonospaceBlock.java | 1 -
.../maven/doxia/module/twiki/parser/NopBlock.java | 7 +-
.../module/twiki/parser/NumeratedListBlock.java | 7 +-
.../doxia/module/twiki/parser/ParagraphBlock.java | 1 -
.../module/twiki/parser/ParagraphBlockParser.java | 7 +-
.../doxia/module/twiki/parser/SectionBlock.java | 7 +-
.../module/twiki/parser/SectionBlockParser.java | 9 +-
.../doxia/module/twiki/parser/TableBlock.java | 1 -
.../module/twiki/parser/TableBlockParser.java | 5 +-
.../doxia/module/twiki/parser/TableCellBlock.java | 1 -
.../module/twiki/parser/TableCellHeaderBlock.java | 1 -
.../doxia/module/twiki/parser/TableRowBlock.java | 1 -
.../maven/doxia/module/twiki/parser/TextBlock.java | 13 +-
.../doxia/module/twiki/parser/TextParser.java | 1 -
.../module/twiki/parser/UnorderedListBlock.java | 1 -
.../doxia/module/twiki/parser/VerbatimBlock.java | 1 -
.../module/twiki/parser/VerbatimBlockParser.java | 5 +-
.../doxia/module/twiki/parser/WikiWordBlock.java | 9 +-
.../module/twiki/parser/WikiWordLinkResolver.java | 1 -
.../doxia/module/twiki/parser/XHTMLBlock.java | 11 +-
.../twiki/parser/XHTMLWikiWordLinkResolver.java | 1 -
.../maven/doxia/module/twiki/TWikiSinkTest.java | 1 -
.../maven/doxia/module/twiki/parser/TitleTest.java | 3 +-
.../apache/maven/doxia/module/xdoc/XdocMarkup.java | 1 -
.../apache/maven/doxia/module/xdoc/XdocParser.java | 17 +-
.../apache/maven/doxia/module/xdoc/XdocSink.java | 20 +-
.../maven/doxia/module/xdoc/XdocSinkFactory.java | 1 -
.../maven/doxia/module/xdoc/XmlWriterXdocSink.java | 5 +-
.../maven/doxia/module/xdoc/XdocParserTest.java | 1 -
.../maven/doxia/module/xdoc/XdocSinkTest.java | 1 -
.../module/xdoc/XdocSinkWithLanguageIdTest.java | 1 -
.../maven/doxia/module/xdoc/XdocValidatorTest.java | 1 -
.../doxia/module/xdoc/XmlWriterXdocSinkTest.java | 1 -
.../doxia/module/xhtml/AbstractXhtmlSink.java | 1 -
.../maven/doxia/module/xhtml/XhtmlMarkup.java | 1 -
.../maven/doxia/module/xhtml/XhtmlParser.java | 5 +-
.../apache/maven/doxia/module/xhtml/XhtmlSink.java | 15 +-
.../maven/doxia/module/xhtml/XhtmlSinkFactory.java | 1 -
.../maven/doxia/module/xhtml/XhtmlParserTest.java | 1 -
.../maven/doxia/module/xhtml/XhtmlSinkTest.java | 1 -
.../module/xhtml/XhtmlSinkWithLanguageIdTest.java | 1 -
.../maven/doxia/module/xhtml5/Xhtml5Parser.java | 4 +-
.../maven/doxia/module/xhtml5/Xhtml5Sink.java | 32 +-
.../java/org/apache/maven/doxia/sink/Sink.java | 4 +-
.../maven/doxia/sink/SinkEventAttributes.java | 1 -
.../org/apache/maven/doxia/sink/SinkFactory.java | 9 +-
.../main/java/org/codehaus/doxia/sink/Sink.java | 1 -
.../org/apache/maven/doxia/sink/package.html | 195 ++++++------
255 files changed, 2485 insertions(+), 1157 deletions(-)
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/DefaultDoxia.java b/doxia-core/src/main/java/org/apache/maven/doxia/DefaultDoxia.java
index b39e026..f8583e7 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/DefaultDoxia.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/DefaultDoxia.java
@@ -37,7 +37,6 @@ import java.io.Reader;
* uses a ParserManager to lookup a parser.
*
* @author Jason van Zyl
- * @version $Id$
* @since 1.0
*/
@Component( role = Doxia.class )
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java b/doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java
index 6fa7941..837bdc2 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java
@@ -30,7 +30,6 @@ import java.io.Reader;
* Basic interface of the Doxia framework.
*
* @author Jason van Zyl
- * @version $Id$
* @since 1.0
*/
public interface Doxia
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexEntry.java b/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexEntry.java
index 086d225..d0e4b9e 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexEntry.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexEntry.java
@@ -29,7 +29,6 @@ import org.codehaus.plexus.util.StringUtils;
* <p>IndexEntry class.</p>
*
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- * @version $Id$
*/
public class IndexEntry
{
@@ -276,6 +275,8 @@ public class IndexEntry
/**
* Returns a string representation of the object.
+ *
+ * @return Returns a string representation of all objects
*/
public String toString()
{
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexingSink.java b/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexingSink.java
index 3a78b63..cfa8bdd 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexingSink.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexingSink.java
@@ -29,7 +29,6 @@ import org.apache.maven.doxia.util.HtmlTools;
*
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class IndexingSink
extends SinkAdapter
@@ -97,128 +96,177 @@ public class IndexingSink
// Sink Overrides
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void title()
{
this.type = TITLE;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section1()
{
pushNewEntry();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle1()
{
this.type = TYPE_SECTION_1;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void title_()
{
this.type = 0;
}
+ /**
+ * <p>sectionTitle1_.</p>
+ */
public void sectionTitle1_()
{
this.type = 0;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section1_()
{
pop();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section2()
{
pushNewEntry();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle2()
{
this.type = TYPE_SECTION_2;
}
+ /**
+ * <p>sectionTitle2_.</p>
+ */
public void sectionTitle2_()
{
this.type = 0;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section2_()
{
pop();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section3()
{
pushNewEntry();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle3()
{
this.type = TYPE_SECTION_3;
}
+ /**
+ * <p>sectionTitle3_.</p>
+ */
public void sectionTitle3_()
{
this.type = 0;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section3_()
{
pop();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section4()
{
pushNewEntry();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle4()
{
this.type = TYPE_SECTION_4;
}
+ /**
+ * <p>sectionTitle4_.</p>
+ */
public void sectionTitle4_()
{
this.type = 0;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section4_()
{
pop();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section5()
{
pushNewEntry();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle5()
{
this.type = TYPE_SECTION_5;
}
+ /**
+ * <p>sectionTitle5_.</p>
+ */
public void sectionTitle5_()
{
this.type = 0;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section5_()
{
pop();
@@ -315,7 +363,9 @@ public class IndexingSink
return stack.peek();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void close()
{
super.close();
@@ -323,7 +373,9 @@ public class IndexingSink
init();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected void init()
{
this.type = 0;
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/AbstractMacro.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/AbstractMacro.java
index 79b88fa..391ef93 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/AbstractMacro.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/AbstractMacro.java
@@ -31,7 +31,6 @@ import org.codehaus.plexus.util.StringUtils;
* Abstract base class to execute <code>Macro</code>.
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
* @since 1.0
*/
public abstract class AbstractMacro
@@ -86,7 +85,6 @@ public abstract class AbstractMacro
* @param parameters the macro parameters.
* @return a SinkEventAttributeSet containing the same parameters,
* or null if parameters is null.
- *
* @since 1.1.1.
*/
protected static SinkEventAttributes getAttributesFromMap( Map<?, ?> parameters )
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java
index 2bcf18d..5791805 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java
@@ -25,8 +25,6 @@ import org.codehaus.plexus.component.annotations.Component;
/**
* A simple macro that prints out the key and value of some supplied parameters.
- *
- * @version $Id$
*/
@Component( role = Macro.class, hint = "echo" )
public class EchoMacro
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/Macro.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/Macro.java
index 1c8e37b..be52dad 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/Macro.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/Macro.java
@@ -26,7 +26,6 @@ import org.apache.maven.doxia.sink.Sink;
* Base interface of a macro.
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
* @since 1.0
*/
public interface Macro
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroExecutionException.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroExecutionException.java
index b4c30b4..1aec3e7 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroExecutionException.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroExecutionException.java
@@ -23,7 +23,6 @@ package org.apache.maven.doxia.macro;
* Wrap an exception that occurs during the execution of a Doxia macro.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- * @version $Id$
* @since 1.0
*/
public class MacroExecutionException
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroRequest.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroRequest.java
index 3ab7242..d83ca19 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroRequest.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroRequest.java
@@ -30,7 +30,6 @@ import java.io.File;
* <p>MacroRequest class.</p>
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
* @since 1.0
*/
public class MacroRequest
@@ -57,6 +56,14 @@ public class MacroRequest
this.basedir = base;
}
+ /**
+ * <p>Constructor for MacroRequest.</p>
+ *
+ * @param sourceContent a {@link java.lang.String} object.
+ * @param parser a {@link org.apache.maven.doxia.parser.AbstractParser} object.
+ * @param param a {@link java.util.Map} object.
+ * @param base a {@link java.io.File} object.
+ */
public MacroRequest( String sourceContent, AbstractParser parser, Map<String, Object> param, File base )
{
this.parameters = param;
@@ -108,16 +115,32 @@ public class MacroRequest
return parameters.get( key );
}
+ /**
+ * <p>getSourceContent.</p>
+ *
+ * @return a {@link java.lang.String} object.
+ */
public String getSourceContent()
{
return (String) getParameter( PARAM_SOURCE_CONTENT );
}
+ /**
+ * <p>getParser.</p>
+ *
+ * @return a {@link org.apache.maven.doxia.parser.Parser} object.
+ */
public Parser getParser()
{
return (Parser) getParameter( PARAM_PARSER );
}
+ /**
+ * <p>isInternalParameter.</p>
+ *
+ * @param name a {@link java.lang.String} object.
+ * @return a boolean.
+ */
public static boolean isInternalParameter( String name )
{
return PARAM_PARSER.equals( name ) || PARAM_SOURCE_CONTENT.equals( name );
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/SsiMacro.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/SsiMacro.java
index d06bd06..6f1ec3a 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/SsiMacro.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/SsiMacro.java
@@ -27,6 +27,7 @@ import org.codehaus.plexus.component.annotations.Component;
* Server-Side Include directive, to insert a SSI into the output.
* Required parameter is <code>function</code> to define SSI function, then
* additional parameters are completely free.
+ *
* @since 1.7
*/
@Component( role = Macro.class, hint = "ssi" )
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/SwfMacro.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/SwfMacro.java
index 896f612..da38793 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/SwfMacro.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/SwfMacro.java
@@ -28,7 +28,6 @@ import org.codehaus.plexus.util.StringUtils;
*
* @author <a href="mailto:steve.motola@gmail.com">Steve Motola</a>
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
@Component( role = Macro.class, hint = "swf" )
public class SwfMacro
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/DefaultMacroManager.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/DefaultMacroManager.java
index 1e251a3..e240d5a 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/DefaultMacroManager.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/DefaultMacroManager.java
@@ -29,7 +29,6 @@ import java.util.Map;
* Default implementation of <code>MacroManager</code>
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
* @since 1.0
*/
@Component( role = MacroManager.class )
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroManager.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroManager.java
index b38be30..c3b7a5a 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroManager.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroManager.java
@@ -25,7 +25,6 @@ import org.apache.maven.doxia.macro.Macro;
* Handles MacroManager lookups.
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
* @since 1.0
*/
public interface MacroManager
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroNotFoundException.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroNotFoundException.java
index a20ad71..7c7337a 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroNotFoundException.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroNotFoundException.java
@@ -24,7 +24,6 @@ package org.apache.maven.doxia.macro.manager;
* does not exist or could not be found.
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
* @since 1.0
*/
public class MacroNotFoundException
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java
index 2166a3e..cbff994 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java
@@ -37,8 +37,6 @@ import java.util.Map;
/**
* A macro that prints out the content of a file or a URL.
- *
- * @version $Id$
*/
@Component( role = Macro.class, hint = "snippet" )
public class SnippetMacro
@@ -71,9 +69,7 @@ public class SnippetMacro
*/
private boolean ignoreDownloadError = true;
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void execute( Sink sink, MacroRequest request )
throws MacroExecutionException
{
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java
index 12d3e22..c313bd6 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java
@@ -32,8 +32,6 @@ import org.codehaus.plexus.util.IOUtil;
/**
* Utility class for reading snippets.
- *
- * @version $Id$
*/
public class SnippetReader
{
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java
index f57f3e9..c96a84e 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java
@@ -75,7 +75,6 @@ import org.codehaus.plexus.util.StringUtils;
* </pre>
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
@Component( role = Macro.class, hint = "toc" )
public class TocMacro
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/markup/HtmlMarkup.java b/doxia-core/src/main/java/org/apache/maven/doxia/markup/HtmlMarkup.java
index da7b1b1..54c3832 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/markup/HtmlMarkup.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/markup/HtmlMarkup.java
@@ -32,9 +32,7 @@ import javax.swing.text.html.HTML.Tag;
* @see <a href=
* "https://www.w3.org/TR/2012/WD-html-markup-20121011/elements-by-function.html">
* https://www.w3.org/TR/2012/WD-html-markup-20121011/elements-by-function.html</a>
- *
* @author ltheussl
- * @version $Id$
* @since 1.0
*/
@SuppressWarnings( "checkstyle:interfaceistype" )
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/markup/Markup.java b/doxia-core/src/main/java/org/apache/maven/doxia/markup/Markup.java
index 37da4f4..0eff103 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/markup/Markup.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/markup/Markup.java
@@ -23,7 +23,6 @@ package org.apache.maven.doxia.markup;
* List of constants used by all markup syntax.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.0
*/
@SuppressWarnings( "checkstyle:interfaceistype" )
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/markup/TextMarkup.java b/doxia-core/src/main/java/org/apache/maven/doxia/markup/TextMarkup.java
index 59a86b7..c790358 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/markup/TextMarkup.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/markup/TextMarkup.java
@@ -23,7 +23,6 @@ package org.apache.maven.doxia.markup;
* List of constants used by <code>Text</code> markup syntax.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.0
*/
@SuppressWarnings( "checkstyle:interfaceistype" )
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/markup/XmlMarkup.java b/doxia-core/src/main/java/org/apache/maven/doxia/markup/XmlMarkup.java
index 6288094..cb46b5a 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/markup/XmlMarkup.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/markup/XmlMarkup.java
@@ -24,7 +24,6 @@ package org.apache.maven.doxia.markup;
* List of constants used by <code>Xml</code> markup syntax.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.0
*/
@SuppressWarnings( "checkstyle:interfaceistype" )
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java
index cf5599d..1745585 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java
@@ -42,7 +42,6 @@ import org.codehaus.plexus.component.annotations.Requirement;
* Provides a macro mechanism to give dynamic functionalities for the parsing.
*
* @author Jason van Zyl
- * @version $Id$
* @since 1.0
*/
public abstract class AbstractParser
@@ -99,17 +98,27 @@ public abstract class AbstractParser
DOXIA_VERSION = props.getProperty( "version" );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a int.
+ */
public int getType()
{
return UNKNOWN_TYPE;
}
+ /** {@inheritDoc} */
public void setEmitComments( boolean emitComments )
{
this.emitComments = emitComments;
}
+ /**
+ * <p>isEmitComments.</p>
+ *
+ * @return a boolean.
+ */
public boolean isEmitComments()
{
return emitComments;
@@ -140,7 +149,6 @@ public abstract class AbstractParser
* Returns the current base directory.
*
* @return The base directory.
- *
* @deprecated this does not work in multi-module builds, see DOXIA-373
*/
protected File getBasedir()
@@ -159,6 +167,8 @@ public abstract class AbstractParser
}
/**
+ * {@inheritDoc}
+ *
* Convenience method to parse an arbitrary string and emit events into the given sink.
*
* @param string A string that provides the source input.
@@ -172,6 +182,7 @@ public abstract class AbstractParser
parse( new StringReader( string ), sink );
}
+ /** {@inheritDoc} */
@Override
public void parse( Reader source, Sink sink, String reference )
throws ParseException
@@ -250,7 +261,6 @@ public abstract class AbstractParser
* The current Doxia version.
*
* @return the current Doxia version as a String.
- *
* @since 1.2
*/
protected static String doxiaVersion()
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractTextParser.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractTextParser.java
index 507ded9..760ee50 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractTextParser.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractTextParser.java
@@ -25,7 +25,6 @@ import org.apache.maven.doxia.markup.TextMarkup;
* An abstract class that defines some convenience methods for <code>Text</code> parsers.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.0
*/
public abstract class AbstractTextParser
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java
index 3891bd3..224c1cf 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java
@@ -65,7 +65,6 @@ import org.xml.sax.SAXException;
* An abstract class that defines some convenience methods for <code>XML</code> parsers.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.0
*/
public abstract class AbstractXmlParser
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/ParseException.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/ParseException.java
index b83285a..96d1ea9 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/ParseException.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/ParseException.java
@@ -23,7 +23,6 @@ package org.apache.maven.doxia.parser;
* Encapsulate a Doxia parse error.
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
* @since 1.0
*/
public class ParseException
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java
index 15fd313..6a2934b 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java
@@ -30,7 +30,6 @@ import java.io.Reader;
* by any Doxia Sink.
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
* @since 1.0
*/
public interface Parser
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/Xhtml5BaseParser.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/Xhtml5BaseParser.java
index 58c45c8..5dfc757 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/Xhtml5BaseParser.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/Xhtml5BaseParser.java
@@ -447,7 +447,7 @@ public class Xhtml5BaseParser
* Goes through a common list of possible html end tags.
* These should be re-usable by different xhtml-based parsers.
* The tags handled here are the same as for {@link #baseStartTag(XmlPullParser,Sink)},
- * except for the empty elements ({@code<br/>, <hr/>, <img/>}).
+ * except for the empty elements ({@code <br/>, <hr/>, <img/>}).
* </p>
*
* @param parser A parser.
@@ -844,6 +844,7 @@ public class Xhtml5BaseParser
*
* @param newLevel the new section level, all upper levels have to be closed.
* @param sink the sink to receive the events.
+ * @param attribs a {@link org.apache.maven.doxia.sink.impl.SinkEventAttributeSet} object.
*/
protected void consecutiveSections( int newLevel, Sink sink, SinkEventAttributeSet attribs )
{
@@ -975,7 +976,6 @@ public class Xhtml5BaseParser
* Checks if we are currently inside a <script> tag.
*
* @return true if we are currently inside <code><script></code> tags.
- *
* @since 1.1.1.
*/
protected boolean isScriptBlock()
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/XhtmlBaseParser.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/XhtmlBaseParser.java
index 776fd6c..36b1024 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/XhtmlBaseParser.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/XhtmlBaseParser.java
@@ -43,7 +43,6 @@ import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @author ltheussl
- * @version $Id$
* @since 1.1
*/
public class XhtmlBaseParser
@@ -567,7 +566,7 @@ public class XhtmlBaseParser
* Goes through a common list of possible html end tags.
* These should be re-usable by different xhtml-based parsers.
* The tags handled here are the same as for {@link #baseStartTag(XmlPullParser,Sink)},
- * except for the empty elements ({@code<br/>, <hr/>, <img/>}).
+ * except for the empty elements ({@code <br/>, <hr/>, <img/>}).
* </p>
*
* @param parser A parser.
@@ -982,7 +981,6 @@ public class XhtmlBaseParser
* Checks if we are currently inside a <script> tag.
*
* @return true if we are currently inside <code><script></code> tags.
- *
* @since 1.1.1.
*/
protected boolean isScriptBlock()
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java
index ef7b277..ac602f7 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java
@@ -29,7 +29,6 @@ import java.util.Map;
* Simple implementation of the <code>ParserManager</code> interface.
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
* @since 1.0
*/
@Component( role = ParserManager.class )
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserManager.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserManager.java
index 69f081c..2751472 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserManager.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserManager.java
@@ -25,7 +25,6 @@ import org.apache.maven.doxia.parser.Parser;
* Handles parser lookups.
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
* @since 1.0
*/
public interface ParserManager
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserNotFoundException.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserNotFoundException.java
index 9da655e..57f9948 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserNotFoundException.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserNotFoundException.java
@@ -24,7 +24,6 @@ package org.apache.maven.doxia.parser.manager;
* does not exist or could not be found.
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
* @since 1.0
*/
public class ParserNotFoundException
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/module/AbstractParserModule.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/module/AbstractParserModule.java
index a3c411d..1cb37ad 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/module/AbstractParserModule.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/module/AbstractParserModule.java
@@ -46,7 +46,7 @@ public abstract class AbstractParserModule
/**
* Constructor with same value for everything: source directory and file extension equal parserId.
- *
+ *
* @param parserId the parser id
*/
public AbstractParserModule( String parserId )
@@ -56,7 +56,7 @@ public abstract class AbstractParserModule
/**
* Constructor with same value for parser id and source directory.
- *
+ *
* @param parserId the parser id
* @param extension the file extension
*/
@@ -66,6 +66,8 @@ public abstract class AbstractParserModule
}
/**
+ * <p>Constructor for AbstractParserModule.</p>
+ *
* @param sourceDirectory not null
* @param extension not null
* @param parserId not null
@@ -81,6 +83,8 @@ public abstract class AbstractParserModule
}
/**
+ * <p>Constructor for AbstractParserModule.</p>
+ *
* @param sourceDirectory not null
* @param parserId not null (usually equals sourceDirectory)
* @param extensions not null
@@ -94,19 +98,31 @@ public abstract class AbstractParserModule
this.parserId = parserId;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a {@link java.lang.String} object.
+ */
public String getSourceDirectory()
{
return sourceDirectory;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return an array of {@link java.lang.String} objects.
+ */
public String[] getExtensions()
{
return extensions;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a {@link java.lang.String} object.
+ */
public String getParserId()
{
return parserId;
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/module/DefaultParserModuleManager.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/module/DefaultParserModuleManager.java
index 06e59ca..3aac039 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/parser/module/DefaultParserModuleManager.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/parser/module/DefaultParserModuleManager.java
@@ -41,7 +41,11 @@ public class DefaultParserModuleManager
private Collection<ParserModule> parserModulesValues;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a {@link java.util.Collection} object.
+ */
public Collection<ParserModule> getParserModules()
{
if ( parserModulesValues == null )
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractBinarySinkFactory.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractBinarySinkFactory.java
index 50ee9b5..2485c86 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractBinarySinkFactory.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractBinarySinkFactory.java
@@ -32,7 +32,6 @@ import org.codehaus.plexus.util.WriterFactory;
* An abstract <code>SinkFactory</code> for binary output.
*
* @author <a href="mailto:hboutemy@apache.org">Hervé Boutemy</a>
- * @version $Id$
* @since 1.1
*/
public abstract class AbstractBinarySinkFactory
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractSink.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractSink.java
index 33b4684..4b0c137 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractSink.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractSink.java
@@ -29,7 +29,6 @@ import org.apache.maven.doxia.sink.Sink;
*
* @author ltheussl
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.1
*/
public abstract class AbstractSink
@@ -59,16 +58,15 @@ public abstract class AbstractSink
return logger;
}
- /**
- * Parses the given String and replaces all occurrences of
- * '\n', '\r' and '\r\n' with the system EOL. All Sinks should
- * make sure that text output is filtered through this method.
- *
- * @param text the text to scan.
- * May be null in which case null is returned.
- *
- * @return a String that contains only System EOLs.
- */
+ /**
+ * Parses the given String and replaces all occurrences of
+ * '\n', '\r' and '\r\n' with the system EOL. All Sinks should
+ * make sure that text output is filtered through this method.
+ *
+ * @param text the text to scan.
+ * May be null in which case null is returned.
+ * @return a String that contains only System EOLs.
+ */
protected static String unifyEOLs( String text )
{
if ( text == null )
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractTextSink.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractTextSink.java
index 6a90add..eb8bbb9 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractTextSink.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractTextSink.java
@@ -25,7 +25,6 @@ import org.apache.maven.doxia.markup.TextMarkup;
* An abstract <code>Sink</code> for text markup syntax.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public abstract class AbstractTextSink
extends SinkAdapter
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractTextSinkFactory.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractTextSinkFactory.java
index c13cd5a..e07979e 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractTextSinkFactory.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractTextSinkFactory.java
@@ -35,7 +35,6 @@ import org.codehaus.plexus.util.WriterFactory;
*
* @author Hervé Boutemy
* @author Benjamin Bentmann
- * @version $Id$
* @since 1.1
*/
public abstract class AbstractTextSinkFactory
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractXmlSink.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractXmlSink.java
index adb116b..c4292c1 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractXmlSink.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractXmlSink.java
@@ -28,7 +28,6 @@ import org.apache.maven.doxia.markup.XmlMarkup;
* An abstract <code>Sink</code> for xml markup syntax.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.0
*/
public abstract class AbstractXmlSink
@@ -42,6 +41,11 @@ public abstract class AbstractXmlSink
private boolean insertNewline = true;
+ /**
+ * <p>Setter for the field <code>insertNewline</code>.</p>
+ *
+ * @param insertNewline a boolean.
+ */
public void setInsertNewline( boolean insertNewline )
{
this.insertNewline = insertNewline;
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractXmlSinkFactory.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractXmlSinkFactory.java
index 1231e27..4a516b5 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractXmlSinkFactory.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractXmlSinkFactory.java
@@ -28,7 +28,6 @@ import org.apache.maven.doxia.sink.Sink;
* when no encoding is specified.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.1
*/
public abstract class AbstractXmlSinkFactory
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/PipelineSink.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/PipelineSink.java
index f79ba08..14187da 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/PipelineSink.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/PipelineSink.java
@@ -32,7 +32,6 @@ import org.apache.maven.doxia.sink.Sink;
* May be used to invoke the same method on a List of Sinks.
*
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- * @version $Id$
*/
public class PipelineSink
implements InvocationHandler
@@ -66,6 +65,10 @@ public class PipelineSink
*
* @throws IllegalAccessException if any.
* @throws InvocationTargetException if any.
+ * @param proxy a {@link java.lang.Object} object.
+ * @param method a {@link java.lang.reflect.Method} object.
+ * @param args an array of {@link java.lang.Object} objects.
+ * @return a {@link java.lang.Object} object.
*/
public Object invoke( Object proxy, Method method, Object[] args )
throws IllegalAccessException, InvocationTargetException
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/RandomAccessSink.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/RandomAccessSink.java
index 62f6e07..a74bf1e 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/RandomAccessSink.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/RandomAccessSink.java
@@ -36,8 +36,8 @@ import org.apache.maven.doxia.sink.SinkFactory;
* The RandomAccessSink provides the ability to create a {@link Sink} with hooks.
* A page can be prepared by first creating its structure and specifying the positions of these hooks.
* After specifying the structure, the page can be filled with content from one or more models.
- * These hooks can prevent you to have to loop over the model multiple times to build the page as desired.
- *
+ * These hooks can prevent you to have to loop over the model multiple times to build the page as desired.
+ *
* @author Robert Scholte
* @since 1.3
*/
@@ -58,6 +58,13 @@ public class RandomAccessSink
private Sink currentSink;
+ /**
+ * <p>Constructor for RandomAccessSink.</p>
+ *
+ * @param sinkFactory a {@link org.apache.maven.doxia.sink.SinkFactory} object.
+ * @param stream a {@link java.io.OutputStream} object.
+ * @throws java.io.IOException if any.
+ */
public RandomAccessSink( SinkFactory sinkFactory, OutputStream stream )
throws IOException
{
@@ -67,6 +74,14 @@ public class RandomAccessSink
this.coreSink = this.currentSink;
}
+ /**
+ * <p>Constructor for RandomAccessSink.</p>
+ *
+ * @param sinkFactory a {@link org.apache.maven.doxia.sink.SinkFactory} object.
+ * @param stream a {@link java.io.OutputStream} object.
+ * @param encoding a {@link java.lang.String} object.
+ * @throws java.io.IOException if any.
+ */
public RandomAccessSink( SinkFactory sinkFactory, OutputStream stream, String encoding )
throws IOException
{
@@ -77,6 +92,14 @@ public class RandomAccessSink
this.coreSink = this.currentSink;
}
+ /**
+ * <p>Constructor for RandomAccessSink.</p>
+ *
+ * @param sinkFactory a {@link org.apache.maven.doxia.sink.SinkFactory} object.
+ * @param outputDirectory a {@link java.io.File} object.
+ * @param outputName a {@link java.lang.String} object.
+ * @throws java.io.IOException if any.
+ */
public RandomAccessSink( SinkFactory sinkFactory, File outputDirectory, String outputName )
throws IOException
{
@@ -86,6 +109,15 @@ public class RandomAccessSink
this.coreSink = this.currentSink;
}
+ /**
+ * <p>Constructor for RandomAccessSink.</p>
+ *
+ * @param sinkFactory a {@link org.apache.maven.doxia.sink.SinkFactory} object.
+ * @param outputDirectory a {@link java.io.File} object.
+ * @param outputName a {@link java.lang.String} object.
+ * @param encoding a {@link java.lang.String} object.
+ * @throws java.io.IOException if any.
+ */
public RandomAccessSink( SinkFactory sinkFactory, File outputDirectory, String outputName, String encoding )
throws IOException
{
@@ -96,18 +128,21 @@ public class RandomAccessSink
this.coreSink = this.currentSink;
}
+ /** {@inheritDoc} */
@Override
public void address()
{
currentSink.address();
}
+ /** {@inheritDoc} */
@Override
public void address( SinkEventAttributes attributes )
{
currentSink.address( attributes );
}
+ /** {@inheritDoc} */
@Override
public void address_()
{
@@ -117,7 +152,7 @@ public class RandomAccessSink
/**
* By calling this method a sink reference is added at the current position. You can write to both the new sink
* reference and the original sink. After flushing all sinks will be flushed in the right order.
- *
+ *
* @return a subsink reference you can write to
*/
public Sink addSinkHook()
@@ -151,102 +186,119 @@ public class RandomAccessSink
return subSink;
}
+ /** {@inheritDoc} */
@Override
public void anchor( String name )
{
currentSink.anchor( name );
}
+ /** {@inheritDoc} */
@Override
public void anchor( String name, SinkEventAttributes attributes )
{
currentSink.anchor( name, attributes );
}
+ /** {@inheritDoc} */
@Override
public void anchor_()
{
currentSink.anchor_();
}
+ /** {@inheritDoc} */
@Override
public void article()
{
currentSink.article();
}
+ /** {@inheritDoc} */
@Override
public void article( SinkEventAttributes attributes )
{
currentSink.article( attributes );
}
+ /** {@inheritDoc} */
@Override
public void article_()
{
currentSink.article_();
}
+ /** {@inheritDoc} */
@Override
public void author()
{
currentSink.author();
}
+ /** {@inheritDoc} */
@Override
public void author( SinkEventAttributes attributes )
{
currentSink.author( attributes );
}
+ /** {@inheritDoc} */
@Override
public void author_()
{
currentSink.author_();
}
+ /** {@inheritDoc} */
@Override
public void blockquote()
{
currentSink.blockquote();
}
+ /** {@inheritDoc} */
@Override
public void blockquote( SinkEventAttributes attributes )
{
currentSink.blockquote( attributes );
}
+ /** {@inheritDoc} */
@Override
public void blockquote_()
{
currentSink.blockquote_();
}
+ /** {@inheritDoc} */
@Override
public void body()
{
currentSink.body();
}
+ /** {@inheritDoc} */
@Override
public void body( SinkEventAttributes attributes )
{
currentSink.body( attributes );
}
+ /** {@inheritDoc} */
@Override
public void body_()
{
currentSink.body_();
}
+ /** {@inheritDoc} */
@Override
public void bold()
{
currentSink.bold();
}
+ /** {@inheritDoc} */
@Override
public void bold_()
{
@@ -266,198 +318,231 @@ public class RandomAccessSink
coreSink.close();
}
+ /** {@inheritDoc} */
@Override
public void comment( String comment )
{
currentSink.comment( comment );
}
+ /** {@inheritDoc} */
@Override
public void content()
{
currentSink.content();
}
+ /** {@inheritDoc} */
@Override
public void content( SinkEventAttributes attributes )
{
currentSink.content( attributes );
}
+ /** {@inheritDoc} */
@Override
public void content_()
{
currentSink.content_();
}
+ /** {@inheritDoc} */
@Override
public void data( String value )
{
currentSink.data( value );
}
+ /** {@inheritDoc} */
@Override
public void data( String value, SinkEventAttributes attributes )
{
currentSink.data( value, attributes );
}
+ /** {@inheritDoc} */
@Override
public void data_()
{
currentSink.data_();
}
+ /** {@inheritDoc} */
@Override
public void date()
{
currentSink.date();
}
+ /** {@inheritDoc} */
@Override
public void date( SinkEventAttributes attributes )
{
currentSink.date( attributes );
}
+ /** {@inheritDoc} */
@Override
public void date_()
{
currentSink.date_();
}
+ /** {@inheritDoc} */
@Override
public void definedTerm()
{
currentSink.definedTerm();
}
+ /** {@inheritDoc} */
@Override
public void definedTerm( SinkEventAttributes attributes )
{
currentSink.definedTerm( attributes );
}
+ /** {@inheritDoc} */
@Override
public void definedTerm_()
{
currentSink.definedTerm_();
}
+ /** {@inheritDoc} */
@Override
public void definition()
{
currentSink.definition();
}
+ /** {@inheritDoc} */
@Override
public void definition( SinkEventAttributes attributes )
{
currentSink.definition( attributes );
}
+ /** {@inheritDoc} */
@Override
public void definitionList()
{
currentSink.definitionList();
}
+ /** {@inheritDoc} */
@Override
public void definitionList( SinkEventAttributes attributes )
{
currentSink.definitionList( attributes );
}
+ /** {@inheritDoc} */
@Override
public void definitionListItem()
{
currentSink.definitionListItem();
}
+ /** {@inheritDoc} */
@Override
public void definitionListItem( SinkEventAttributes attributes )
{
currentSink.definitionListItem( attributes );
}
+ /** {@inheritDoc} */
@Override
public void definitionListItem_()
{
currentSink.definitionListItem_();
}
+ /** {@inheritDoc} */
@Override
public void definitionList_()
{
currentSink.definitionList_();
}
+ /** {@inheritDoc} */
@Override
public void definition_()
{
currentSink.definition_();
}
+ /** {@inheritDoc} */
@Override
public void division()
{
currentSink.division();
}
+ /** {@inheritDoc} */
@Override
public void division( SinkEventAttributes attributes )
{
currentSink.division( attributes );
}
+ /** {@inheritDoc} */
@Override
public void division_()
{
currentSink.division_();
}
+ /** {@inheritDoc} */
@Override
public void figure()
{
currentSink.figure();
}
+ /** {@inheritDoc} */
@Override
public void figure( SinkEventAttributes attributes )
{
currentSink.figure( attributes );
}
+ /** {@inheritDoc} */
@Override
public void figureCaption()
{
currentSink.figureCaption();
}
+ /** {@inheritDoc} */
@Override
public void figureCaption( SinkEventAttributes attributes )
{
currentSink.figureCaption( attributes );
}
+ /** {@inheritDoc} */
@Override
public void figureCaption_()
{
currentSink.figureCaption_();
}
+ /** {@inheritDoc} */
@Override
public void figureGraphics( String name )
{
currentSink.figureGraphics( name );
}
+ /** {@inheritDoc} */
@Override
public void figureGraphics( String src, SinkEventAttributes attributes )
{
currentSink.figureGraphics( src, attributes );
}
+ /** {@inheritDoc} */
@Override
public void figure_()
{
@@ -489,666 +574,777 @@ public class RandomAccessSink
coreSink.flush();
}
+ /** {@inheritDoc} */
@Override
public void footer()
{
currentSink.footer();
}
+ /** {@inheritDoc} */
@Override
public void footer( SinkEventAttributes attributes )
{
currentSink.footer( attributes );
}
+ /** {@inheritDoc} */
@Override
public void footer_()
{
currentSink.footer_();
}
+ /** {@inheritDoc} */
@Override
public void head()
{
currentSink.head();
}
+ /** {@inheritDoc} */
@Override
public void head( SinkEventAttributes attributes )
{
currentSink.head( attributes );
}
+ /** {@inheritDoc} */
@Override
public void head_()
{
currentSink.head_();
}
+ /** {@inheritDoc} */
@Override
public void header()
{
currentSink.header();
}
+ /** {@inheritDoc} */
@Override
public void header( SinkEventAttributes attributes )
{
currentSink.header( attributes );
}
+ /** {@inheritDoc} */
@Override
public void header_()
{
currentSink.header_();
}
+ /** {@inheritDoc} */
@Override
public void horizontalRule()
{
currentSink.horizontalRule();
}
+ /** {@inheritDoc} */
@Override
public void horizontalRule( SinkEventAttributes attributes )
{
currentSink.horizontalRule( attributes );
}
+ /** {@inheritDoc} */
@Override
public void inline()
{
currentSink.inline();
}
+ /** {@inheritDoc} */
@Override
public void inline( SinkEventAttributes attributes )
{
currentSink.inline( attributes );
}
+ /** {@inheritDoc} */
@Override
public void inline_()
{
currentSink.inline_();
}
+ /** {@inheritDoc} */
@Override
public void italic()
{
currentSink.italic();
}
+ /** {@inheritDoc} */
@Override
public void italic_()
{
currentSink.italic_();
}
+ /** {@inheritDoc} */
@Override
public void lineBreak()
{
currentSink.lineBreak();
}
+ /** {@inheritDoc} */
@Override
public void lineBreak( SinkEventAttributes attributes )
{
currentSink.lineBreak( attributes );
}
+ /** {@inheritDoc} */
@Override
public void lineBreakOpportunity()
{
currentSink.lineBreakOpportunity();
}
+ /** {@inheritDoc} */
@Override
public void lineBreakOpportunity( SinkEventAttributes attributes )
{
currentSink.lineBreakOpportunity( attributes );
}
+ /** {@inheritDoc} */
@Override
public void link( String name )
{
currentSink.link( name );
}
+ /** {@inheritDoc} */
@Override
public void link( String name, SinkEventAttributes attributes )
{
currentSink.link( name, attributes );
}
+ /** {@inheritDoc} */
@Override
public void link_()
{
currentSink.link_();
}
+ /** {@inheritDoc} */
@Override
public void list()
{
currentSink.list();
}
+ /** {@inheritDoc} */
@Override
public void list( SinkEventAttributes attributes )
{
currentSink.list( attributes );
}
+ /** {@inheritDoc} */
@Override
public void listItem()
{
currentSink.listItem();
}
+ /** {@inheritDoc} */
@Override
public void listItem( SinkEventAttributes attributes )
{
currentSink.listItem( attributes );
}
+ /** {@inheritDoc} */
@Override
public void listItem_()
{
currentSink.listItem_();
}
+ /** {@inheritDoc} */
@Override
public void list_()
{
currentSink.list_();
}
+ /** {@inheritDoc} */
@Override
public void monospaced()
{
currentSink.monospaced();
}
+ /** {@inheritDoc} */
@Override
public void monospaced_()
{
currentSink.monospaced_();
}
+ /** {@inheritDoc} */
@Override
public void navigation()
{
currentSink.navigation();
}
+ /** {@inheritDoc} */
@Override
public void navigation( SinkEventAttributes attributes )
{
currentSink.navigation( attributes );
}
+ /** {@inheritDoc} */
@Override
public void navigation_()
{
currentSink.navigation_();
}
+ /** {@inheritDoc} */
@Override
public void nonBreakingSpace()
{
currentSink.nonBreakingSpace();
}
+ /** {@inheritDoc} */
@Override
public void numberedList( int numbering )
{
currentSink.numberedList( numbering );
}
+ /** {@inheritDoc} */
@Override
public void numberedList( int numbering, SinkEventAttributes attributes )
{
currentSink.numberedList( numbering, attributes );
}
+ /** {@inheritDoc} */
@Override
public void numberedListItem()
{
currentSink.numberedListItem();
}
+ /** {@inheritDoc} */
@Override
public void numberedListItem( SinkEventAttributes attributes )
{
currentSink.numberedListItem( attributes );
}
+ /** {@inheritDoc} */
@Override
public void numberedListItem_()
{
currentSink.numberedListItem_();
}
+ /** {@inheritDoc} */
@Override
public void numberedList_()
{
currentSink.numberedList_();
}
+ /** {@inheritDoc} */
@Override
public void pageBreak()
{
currentSink.pageBreak();
}
+ /** {@inheritDoc} */
@Override
public void paragraph()
{
currentSink.paragraph();
}
+ /** {@inheritDoc} */
@Override
public void paragraph( SinkEventAttributes attributes )
{
currentSink.paragraph( attributes );
}
+ /** {@inheritDoc} */
@Override
public void paragraph_()
{
currentSink.paragraph_();
}
+ /** {@inheritDoc} */
@Override
public void rawText( String text )
{
currentSink.rawText( text );
}
+ /** {@inheritDoc} */
@Override
public void section( int level, SinkEventAttributes attributes )
{
currentSink.section( level, attributes );
}
+ /** {@inheritDoc} */
@Override
public void section1()
{
currentSink.section1();
}
+ /** {@inheritDoc} */
@Override
public void section1_()
{
currentSink.section1_();
}
+ /** {@inheritDoc} */
@Override
public void section2()
{
currentSink.section2();
}
+ /** {@inheritDoc} */
@Override
public void section2_()
{
currentSink.section2_();
}
+ /** {@inheritDoc} */
@Override
public void section3()
{
currentSink.section3();
}
+ /** {@inheritDoc} */
@Override
public void section3_()
{
currentSink.section3_();
}
+ /** {@inheritDoc} */
@Override
public void section4()
{
currentSink.section4();
}
+ /** {@inheritDoc} */
@Override
public void section4_()
{
currentSink.section4_();
}
+ /** {@inheritDoc} */
@Override
public void section5()
{
currentSink.section5();
}
+ /** {@inheritDoc} */
@Override
public void section5_()
{
currentSink.section5_();
}
+ /** {@inheritDoc} */
@Override
public void section6()
{
currentSink.section5();
}
+ /** {@inheritDoc} */
@Override
public void section6_()
{
currentSink.section5_();
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle()
{
currentSink.sectionTitle();
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle( int level, SinkEventAttributes attributes )
{
currentSink.sectionTitle( level, attributes );
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle1()
{
currentSink.sectionTitle1();
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle1_()
{
currentSink.sectionTitle1_();
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle2()
{
currentSink.sectionTitle2();
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle2_()
{
currentSink.sectionTitle2_();
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle3()
{
currentSink.sectionTitle3();
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle3_()
{
currentSink.sectionTitle3_();
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle4()
{
currentSink.sectionTitle4();
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle4_()
{
currentSink.sectionTitle4_();
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle5()
{
currentSink.sectionTitle5();
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle5_()
{
currentSink.sectionTitle5_();
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle6()
{
currentSink.sectionTitle5();
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle6_()
{
currentSink.sectionTitle5_();
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle_()
{
currentSink.sectionTitle_();
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle_( int level )
{
currentSink.sectionTitle_( level );
}
+ /** {@inheritDoc} */
@Override
public void section_( int level )
{
currentSink.section_( level );
}
+ /** {@inheritDoc} */
@Override
public void sidebar()
{
currentSink.sidebar();
}
+ /** {@inheritDoc} */
@Override
public void sidebar( SinkEventAttributes attributes )
{
currentSink.sidebar( attributes );
}
+ /** {@inheritDoc} */
@Override
public void sidebar_()
{
currentSink.sidebar_();
}
+ /** {@inheritDoc} */
@Override
public void table()
{
currentSink.table();
}
+ /** {@inheritDoc} */
@Override
public void table( SinkEventAttributes attributes )
{
currentSink.table( attributes );
}
+ /** {@inheritDoc} */
@Override
public void tableCaption()
{
currentSink.tableCaption();
}
+ /** {@inheritDoc} */
@Override
public void tableCaption( SinkEventAttributes attributes )
{
currentSink.tableCaption( attributes );
}
+ /** {@inheritDoc} */
@Override
public void tableCaption_()
{
currentSink.tableCaption_();
}
+ /** {@inheritDoc} */
@Override
public void tableCell()
{
currentSink.tableCell();
}
+ /** {@inheritDoc} */
@Override
public void tableCell( String width )
{
currentSink.tableCell( width );
}
+ /** {@inheritDoc} */
@Override
public void tableCell( SinkEventAttributes attributes )
{
currentSink.tableCell( attributes );
}
+ /** {@inheritDoc} */
@Override
public void tableCell_()
{
currentSink.tableCell_();
}
+ /** {@inheritDoc} */
@Override
public void tableHeaderCell()
{
currentSink.tableHeaderCell();
}
+ /** {@inheritDoc} */
@Override
public void tableHeaderCell( String width )
{
currentSink.tableHeaderCell( width );
}
+ /** {@inheritDoc} */
@Override
public void tableHeaderCell( SinkEventAttributes attributes )
{
currentSink.tableHeaderCell( attributes );
}
+ /** {@inheritDoc} */
@Override
public void tableHeaderCell_()
{
currentSink.tableHeaderCell_();
}
+ /** {@inheritDoc} */
@Override
public void tableRow()
{
currentSink.tableRow();
}
+ /** {@inheritDoc} */
@Override
public void tableRow( SinkEventAttributes attributes )
{
currentSink.tableRow( attributes );
}
+ /** {@inheritDoc} */
@Override
public void tableRow_()
{
currentSink.tableRow_();
}
+ /** {@inheritDoc} */
@Override
public void tableRows( int[] justification, boolean grid )
{
currentSink.tableRows( justification, grid );
}
+ /** {@inheritDoc} */
@Override
public void tableRows_()
{
currentSink.tableRows_();
}
+ /** {@inheritDoc} */
@Override
public void table_()
{
currentSink.table_();
}
+ /** {@inheritDoc} */
@Override
public void text( String text )
{
currentSink.text( text );
}
+ /** {@inheritDoc} */
@Override
public void text( String text, SinkEventAttributes attributes )
{
currentSink.text( text, attributes );
}
+ /** {@inheritDoc} */
@Override
public void time( String datetime )
{
currentSink.time( datetime );
}
+ /** {@inheritDoc} */
@Override
public void time( String datetime, SinkEventAttributes attributes )
{
currentSink.time( datetime, attributes );
}
+ /** {@inheritDoc} */
@Override
public void time_()
{
currentSink.time_();
}
+ /** {@inheritDoc} */
@Override
public void title()
{
currentSink.title();
}
+ /** {@inheritDoc} */
@Override
public void title( SinkEventAttributes attributes )
{
currentSink.title( attributes );
}
+ /** {@inheritDoc} */
@Override
public void title_()
{
currentSink.title_();
}
+ /** {@inheritDoc} */
@Override
public void unknown( String name, Object[] requiredParams, SinkEventAttributes attributes )
{
currentSink.unknown( name, requiredParams, attributes );
}
+ /** {@inheritDoc} */
@Override
public void verbatim( boolean boxed )
{
currentSink.verbatim( boxed );
}
+ /** {@inheritDoc} */
@Override
public void verbatim( SinkEventAttributes attributes )
{
currentSink.verbatim( attributes );
}
+ /** {@inheritDoc} */
@Override
public void verbatim_()
{
currentSink.verbatim_();
}
+ /** {@inheritDoc} */
@Override
public void enableLogging( Log log )
{
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkAdapter.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkAdapter.java
index b383a60..b2c04c9 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkAdapter.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkAdapter.java
@@ -29,772 +29,899 @@ import org.apache.maven.doxia.sink.SinkEventAttributes;
* @since 1.0
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class SinkAdapter
extends AbstractSink
{
+ /** {@inheritDoc} */
@Override
public void head()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void head_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void body()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void body_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void article()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void article_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void navigation()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void navigation_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void sidebar()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void sidebar_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void section1()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void section1_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void section2()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void section2_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void section3()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void section3_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void section4()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void section4_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void section5()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void section5_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void section6()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void section6_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void list()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void list_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void listItem()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void listItem_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void numberedList( int numbering )
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void numberedList_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void numberedListItem()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void numberedListItem_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void definitionList()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void definitionList_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void definitionListItem()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void definitionListItem_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void definition()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void definition_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void figure()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void figure_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void table()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void table_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void tableRows( int[] justification, boolean grid )
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void tableRows_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void tableRow()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void tableRow_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void title()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void title_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void author()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void author_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void date()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void date_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle1()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle1_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle2()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle2_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle3()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle3_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle4()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle4_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle5()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle5_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle6()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle6_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void header()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void header_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void content()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void content_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void footer()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void footer_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void paragraph()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void paragraph_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void data( String value )
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void data_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void time( String datetime )
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void time_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void address()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void address_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void blockquote()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void blockquote_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void division()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void division_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void verbatim( boolean boxed )
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void verbatim_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void definedTerm()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void definedTerm_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void figureCaption()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void figureCaption_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void tableCell()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void tableCell( String width )
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void tableCell_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void tableHeaderCell()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void tableHeaderCell( String width )
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void tableHeaderCell_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void tableCaption()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void tableCaption_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void figureGraphics( String name )
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void horizontalRule()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void pageBreak()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void anchor( String name )
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void anchor_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void link( String name )
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void link_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void inline()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void inline_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void italic()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void italic_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void bold()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void bold_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void monospaced()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void monospaced_()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void lineBreak()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void lineBreakOpportunity()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void nonBreakingSpace()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void text( String text )
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void rawText( String text )
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void comment( String comment )
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void flush()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void close()
{
// nop
}
+ /** {@inheritDoc} */
@Override
public void head( SinkEventAttributes attributes )
{
head();
}
+ /** {@inheritDoc} */
@Override
public void title( SinkEventAttributes attributes )
{
title();
}
+ /** {@inheritDoc} */
@Override
public void author( SinkEventAttributes attributes )
{
author();
}
+ /** {@inheritDoc} */
@Override
public void date( SinkEventAttributes attributes )
{
date();
}
+ /** {@inheritDoc} */
@Override
public void body( SinkEventAttributes attributes )
{
body();
}
+ /** {@inheritDoc} */
@Override
public void article( SinkEventAttributes attributes )
{
article();
}
+ /** {@inheritDoc} */
@Override
public void navigation( SinkEventAttributes attributes )
{
navigation();
}
+ /** {@inheritDoc} */
@Override
public void sidebar( SinkEventAttributes attributes )
{
sidebar();
}
+ /** {@inheritDoc} */
@Override
public void section( int level, SinkEventAttributes attributes )
{
@@ -820,6 +947,7 @@ public class SinkAdapter
}
}
+ /** {@inheritDoc} */
@Override
public void section_( int level )
{
@@ -845,6 +973,7 @@ public class SinkAdapter
}
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle( int level, SinkEventAttributes attributes )
{
@@ -870,6 +999,7 @@ public class SinkAdapter
}
}
+ /** {@inheritDoc} */
@Override
public void sectionTitle_( int level )
{
@@ -895,156 +1025,182 @@ public class SinkAdapter
}
}
+ /** {@inheritDoc} */
@Override
public void header( SinkEventAttributes attributes )
{
header();
}
+ /** {@inheritDoc} */
@Override
public void content( SinkEventAttributes attributes )
{
content();
}
+ /** {@inheritDoc} */
@Override
public void footer( SinkEventAttributes attributes )
{
footer();
}
+ /** {@inheritDoc} */
@Override
public void list( SinkEventAttributes attributes )
{
list();
}
+ /** {@inheritDoc} */
@Override
public void listItem( SinkEventAttributes attributes )
{
listItem();
}
+ /** {@inheritDoc} */
@Override
public void numberedList( int numbering, SinkEventAttributes attributes )
{
numberedList( numbering );
}
+ /** {@inheritDoc} */
@Override
public void numberedListItem( SinkEventAttributes attributes )
{
numberedListItem();
}
+ /** {@inheritDoc} */
@Override
public void definitionList( SinkEventAttributes attributes )
{
definitionList();
}
+ /** {@inheritDoc} */
@Override
public void definitionListItem( SinkEventAttributes attributes )
{
definitionListItem();
}
+ /** {@inheritDoc} */
@Override
public void definition( SinkEventAttributes attributes )
{
definition();
}
+ /** {@inheritDoc} */
@Override
public void definedTerm( SinkEventAttributes attributes )
{
definedTerm();
}
+ /** {@inheritDoc} */
@Override
public void figure( SinkEventAttributes attributes )
{
figure();
}
+ /** {@inheritDoc} */
@Override
public void figureCaption( SinkEventAttributes attributes )
{
figureCaption();
}
+ /** {@inheritDoc} */
@Override
public void figureGraphics( String src, SinkEventAttributes attributes )
{
figureGraphics( src );
}
+ /** {@inheritDoc} */
@Override
public void table( SinkEventAttributes attributes )
{
table();
}
+ /** {@inheritDoc} */
@Override
public void tableRow( SinkEventAttributes attributes )
{
tableRow();
}
+ /** {@inheritDoc} */
@Override
public void tableCell( SinkEventAttributes attributes )
{
tableCell();
}
+ /** {@inheritDoc} */
@Override
public void tableHeaderCell( SinkEventAttributes attributes )
{
tableHeaderCell();
}
+ /** {@inheritDoc} */
@Override
public void tableCaption( SinkEventAttributes attributes )
{
tableCaption();
}
+ /** {@inheritDoc} */
@Override
public void paragraph( SinkEventAttributes attributes )
{
paragraph();
}
+ /** {@inheritDoc} */
@Override
public void data( String value, SinkEventAttributes attributes )
{
data( value );
}
+ /** {@inheritDoc} */
@Override
public void time( String datetime, SinkEventAttributes attributes )
{
time( datetime );
}
+ /** {@inheritDoc} */
@Override
public void address( SinkEventAttributes attributes )
{
address();
}
+ /** {@inheritDoc} */
@Override
public void blockquote( SinkEventAttributes attributes )
{
blockquote();
}
+ /** {@inheritDoc} */
@Override
public void division( SinkEventAttributes attributes )
{
division();
}
+ /** {@inheritDoc} */
@Override
public void verbatim( SinkEventAttributes attributes )
{
@@ -1060,48 +1216,56 @@ public class SinkAdapter
verbatim( boxed );
}
+ /** {@inheritDoc} */
@Override
public void horizontalRule( SinkEventAttributes attributes )
{
horizontalRule();
}
+ /** {@inheritDoc} */
@Override
public void anchor( String name, SinkEventAttributes attributes )
{
anchor( name );
}
+ /** {@inheritDoc} */
@Override
public void link( String name, SinkEventAttributes attributes )
{
link( name );
}
+ /** {@inheritDoc} */
@Override
public void inline( SinkEventAttributes attributes )
{
inline();
}
+ /** {@inheritDoc} */
@Override
public void lineBreak( SinkEventAttributes attributes )
{
lineBreak();
}
+ /** {@inheritDoc} */
@Override
public void lineBreakOpportunity( SinkEventAttributes attributes )
{
lineBreakOpportunity();
}
+ /** {@inheritDoc} */
@Override
public void text( String text, SinkEventAttributes attributes )
{
text( text );
}
+ /** {@inheritDoc} */
@Override
public void unknown( String name, Object[] requiredParams, SinkEventAttributes attributes )
{
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkEventAttributeSet.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkEventAttributeSet.java
index 152a912..afd33eb 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkEventAttributeSet.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkEventAttributeSet.java
@@ -32,7 +32,6 @@ import org.apache.maven.doxia.sink.SinkEventAttributes;
* Implementation of MutableAttributeSet using a LinkedHashMap.
*
* @author ltheussl
- * @version $Id$
* @since 1.1
*/
public class SinkEventAttributeSet
@@ -183,7 +182,6 @@ public class SinkEventAttributeSet
* will result in an UnsupportedOperationException.
*
* @return an unmodifiable view of this AttributeSet.
- *
* @since 1.1.1
*/
public SinkEventAttributeSet unmodifiable()
@@ -203,7 +201,11 @@ public class SinkEventAttributeSet
return attribs.isEmpty();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a int.
+ */
public int getAttributeCount()
{
return attribs.size();
@@ -222,13 +224,21 @@ public class SinkEventAttributeSet
&& containsAttributes( attr ) );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a {@link javax.swing.text.AttributeSet} object.
+ */
public AttributeSet copyAttributes()
{
return ( (AttributeSet) clone() );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a {@link java.util.Enumeration} object.
+ */
public Enumeration<String> getAttributeNames()
{
return Collections.enumeration( attribs.keySet() );
@@ -317,7 +327,11 @@ public class SinkEventAttributeSet
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @param attributes a {@link javax.swing.text.AttributeSet} object.
+ */
public void removeAttributes( AttributeSet attributes )
{
if ( attributes == null )
@@ -345,7 +359,11 @@ public class SinkEventAttributeSet
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a {@link javax.swing.text.AttributeSet} object.
+ */
public AttributeSet getResolveParent()
{
return this.resolveParent;
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkUtils.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkUtils.java
index 27edd43..f1c1ede 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkUtils.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkUtils.java
@@ -32,7 +32,6 @@ import org.apache.maven.doxia.sink.SinkEventAttributes;
* Collection of common utility methods for sinks.
*
* @author ltheussl
- * @version $Id$
* @since 1.1
*/
public class SinkUtils
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/Xhtml5BaseSink.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/Xhtml5BaseSink.java
index c2deb43..96d86a0 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/Xhtml5BaseSink.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/Xhtml5BaseSink.java
@@ -290,18 +290,14 @@ public class Xhtml5BaseSink
// Sections
// ----------------------------------------------------------------------
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void article()
{
article( null );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void article( SinkEventAttributes attributes )
{
@@ -311,27 +307,21 @@ public class Xhtml5BaseSink
writeStartTag( HtmlMarkup.ARTICLE, atts );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void article_()
{
writeEndTag( HtmlMarkup.ARTICLE );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void navigation()
{
navigation( null );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void navigation( SinkEventAttributes attributes )
{
@@ -341,27 +331,21 @@ public class Xhtml5BaseSink
writeStartTag( HtmlMarkup.NAV, atts );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void navigation_()
{
writeEndTag( HtmlMarkup.NAV );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void sidebar()
{
sidebar( null );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void sidebar( SinkEventAttributes attributes )
{
@@ -371,9 +355,7 @@ public class Xhtml5BaseSink
writeStartTag( HtmlMarkup.ASIDE, atts );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void sidebar_()
{
@@ -553,7 +535,6 @@ public class Xhtml5BaseSink
*
* @param depth The level of the section.
* @param attributes some attributes. May be null.
- * @see javax.swing.text.html.HTML.Tag#SECTION
*/
protected void onSection( int depth, SinkEventAttributes attributes )
{
@@ -653,18 +634,14 @@ public class Xhtml5BaseSink
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void header()
{
header( null );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void header( SinkEventAttributes attributes )
{
@@ -674,27 +651,21 @@ public class Xhtml5BaseSink
writeStartTag( HtmlMarkup.HEADER, atts );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void header_()
{
writeEndTag( HtmlMarkup.HEADER );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void content()
{
content( (SinkEventAttributes) null );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void content( SinkEventAttributes attributes )
{
@@ -721,9 +692,7 @@ public class Xhtml5BaseSink
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void content_()
{
@@ -737,18 +706,14 @@ public class Xhtml5BaseSink
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void footer()
{
footer( null );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void footer( SinkEventAttributes attributes )
{
@@ -758,9 +723,7 @@ public class Xhtml5BaseSink
writeStartTag( HtmlMarkup.FOOTER, atts );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void footer_()
{
@@ -1057,18 +1020,14 @@ public class Xhtml5BaseSink
writeEndTag( HtmlMarkup.DD );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void figure()
{
figure( null );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void figure( SinkEventAttributes attributes )
{
@@ -1114,9 +1073,7 @@ public class Xhtml5BaseSink
writeStartTag( HtmlMarkup.IMG, atts, true );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void figureCaption()
{
@@ -1176,20 +1133,14 @@ public class Xhtml5BaseSink
}
}
- /**
- * {@inheritDoc}
- * @see javax.swing.text.html.HTML.Tag#DATA
- */
+ /** {@inheritDoc} */
@Override
public void data( String value )
{
data( value, null );
}
- /**
- * {@inheritDoc}
- * @see javax.swing.text.html.HTML.Tag#DATA
- */
+ /** {@inheritDoc} */
@Override
public void data( String value, SinkEventAttributes attributes )
{
@@ -1206,30 +1157,21 @@ public class Xhtml5BaseSink
writeStartTag( HtmlMarkup.DATA, att );
}
- /**
- * {@inheritDoc}
- * @see javax.swing.text.html.HTML.Tag#DATA
- */
+ /** {@inheritDoc} */
@Override
public void data_()
{
writeEndTag( HtmlMarkup.DATA );
}
- /**
- * {@inheritDoc}
- * @see javax.swing.text.html.HTML.Tag#TIME
- */
+ /** {@inheritDoc} */
@Override
public void time( String datetime )
{
time( datetime, null );
}
- /**
- * {@inheritDoc}
- * @see javax.swing.text.html.HTML.Tag#DATA
- */
+ /** {@inheritDoc} */
@Override
public void time( String datetime, SinkEventAttributes attributes )
{
@@ -1246,9 +1188,7 @@ public class Xhtml5BaseSink
writeStartTag( HtmlMarkup.TIME, att );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public void time_()
{
@@ -2117,20 +2057,14 @@ public class Xhtml5BaseSink
}
}
- /**
- * {@inheritDoc}
- * @see javax.swing.text.html.HTML.Tag#WBR
- */
+ /** {@inheritDoc} */
@Override
public void lineBreakOpportunity()
{
lineBreakOpportunity( null );
}
- /**
- * {@inheritDoc}
- * @see javax.swing.text.html.HTML.Tag#WBR
- */
+ /** {@inheritDoc} */
@Override
public void lineBreakOpportunity( SinkEventAttributes attributes )
{
@@ -2239,6 +2173,8 @@ public class Xhtml5BaseSink
}
/**
+ * {@inheritDoc}
+ *
* Add an unknown event.
* This can be used to generate html tags for which no corresponding sink event exists.
*
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/XhtmlBaseSink.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/XhtmlBaseSink.java
index 87be49a..c4a5aa5 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/XhtmlBaseSink.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/XhtmlBaseSink.java
@@ -50,7 +50,6 @@ import org.codehaus.plexus.util.xml.PrettyPrintXMLWriter;
*
* @author Jason van Zyl
* @author ltheussl
- * @version $Id$
* @since 1.1
*/
public class XhtmlBaseSink
@@ -2024,6 +2023,8 @@ public class XhtmlBaseSink
}
/**
+ * {@inheritDoc}
+ *
* Add an unknown event.
* This can be used to generate html tags for which no corresponding sink event exists.
*
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java b/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java
index 07d938e..7d06f98 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java
@@ -33,8 +33,6 @@ import org.codehaus.plexus.util.IOUtil;
/**
* {@link ByLineSource} default implementation
- *
- * @version $Id$
*/
public class ByLineReaderSource implements ByLineSource
{
@@ -71,6 +69,12 @@ public class ByLineReaderSource implements ByLineSource
this( in, "" );
}
+ /**
+ * <p>Constructor for ByLineReaderSource.</p>
+ *
+ * @param in a {@link java.io.Reader} object.
+ * @param name a {@link java.lang.String} object.
+ */
public ByLineReaderSource( final Reader in, final String name )
{
this.reader = new LineNumberReader( in );
@@ -80,7 +84,12 @@ public class ByLineReaderSource implements ByLineSource
this.lineNumber = -1;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a {@link java.lang.String} object.
+ * @throws org.apache.maven.doxia.parser.ParseException if any.
+ */
public final String getNextLine() throws ParseException
{
if ( reader == null )
@@ -119,26 +128,38 @@ public class ByLineReaderSource implements ByLineSource
return line;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a {@link java.lang.String} object.
+ */
public final String getName()
{
return name;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a int.
+ */
public final int getLineNumber()
{
return lineNumber;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public final void close()
{
IOUtil.close( reader );
reader = null;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public final void ungetLine()
{
if ( ungetted )
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineSource.java b/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineSource.java
index 9a36b0f..e149140 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineSource.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineSource.java
@@ -26,7 +26,6 @@ import org.apache.maven.doxia.parser.ParseException;
*
* @author Juan F. Codagnone
* @since Nov 4, 2005
- * @version $Id$
*/
public interface ByLineSource
{
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/util/DoxiaUtils.java b/doxia-core/src/main/java/org/apache/maven/doxia/util/DoxiaUtils.java
index 07e9c8d..ede7ee3 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/util/DoxiaUtils.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/util/DoxiaUtils.java
@@ -46,7 +46,6 @@ import org.apache.maven.doxia.sink.impl.SinkEventAttributeSet;
*
* @author ltheussl
* @since 1.1
- * @version $Id$
*/
public class DoxiaUtils
{
@@ -63,7 +62,6 @@ public class DoxiaUtils
* @return True if the link starts with "#".
*
* @throws NullPointerException if link is null.
- *
* @see #isExternalLink(String)
* @see #isLocalLink(String)
*/
@@ -81,7 +79,6 @@ public class DoxiaUtils
* {@link #isLocalLink(java.lang.String)} will return true.
*
* @param link The link to check. Not null.
- *
* @return True if the link (ignoring case) starts with either "http:/",
* "https:/", "ftp:/", "mailto:", "file:/", or contains the string "://".
* Note that Windows style separators "\" are not allowed
@@ -110,7 +107,6 @@ public class DoxiaUtils
* {@link #isLocalLink(java.lang.String)} will return true.
*
* @param link The link to check. Not null.
- *
* @return True if the link is neither an external nor an internal link.
*
* @throws NullPointerException if link is null.
@@ -132,9 +128,7 @@ public class DoxiaUtils
*
* @param id The id to be encoded.
* May be null in which case null is returned.
- *
* @return The trimmed and encoded id, or null if id is null.
- *
* @see #encodeId(java.lang.String, boolean)
*/
public static String encodeId( final String id )
@@ -201,12 +195,9 @@ public class DoxiaUtils
* May be null in which case null is returned.
* @param chop true if non-ASCII characters should be ignored.
* If false, any non-ASCII characters will be replaced as specified above.
- *
* @return The trimmed and encoded id, or null if id is null.
* If id is not null, the return value is guaranteed to be a valid Doxia id.
- *
* @see #isValidId(java.lang.String)
- *
* @since 1.1.1
*/
public static String encodeId( final String id, final boolean chop )
@@ -265,7 +256,6 @@ public class DoxiaUtils
*
* @param b the byte value.
* @return the result of Integer.toHexString( b & 0xFF ).
- *
* @since 1.1.1
* @deprecated Use {@code String.format( "%02X", bytes[j] )}
*/
@@ -281,9 +271,7 @@ public class DoxiaUtils
*
* @param text The text to be tested.
* May be null in which case false is returned.
- *
* @return <code>true</code> if the text is a valid id, otherwise <code>false</code>.
- *
* @see #encodeId(String)
*/
public static boolean isValidId( final String text )
@@ -336,13 +324,11 @@ public class DoxiaUtils
* (ignoring case) return the current date.</p>
*
* @param str the date to parse, not null.
- *
* @return the parsed date, or the current date if the input String (ignoring case) was
* <code>"today"</code> or <code>"now"</code>.
*
* @throws ParseException if no pattern matches.
* @throws NullPointerException if str is null.
- *
* @since 1.1.1.
*/
public static Date parseDate( final String str )
@@ -387,7 +373,6 @@ public class DoxiaUtils
* contain width and height attribute keys whose values are the width and height of the image (as a String).
*
* @param logo a String containing either a URL or a path to an image file. Not null.
- *
* @return a set of SinkEventAttributes, or null if no ImageReader was found to read the image.
*
* @throws java.io.IOException if an error occurs during reading.
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java b/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
index c60ad85..906618d 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
@@ -35,7 +35,6 @@ import org.codehaus.plexus.util.StringUtils;
* The <code>HtmlTools</code> class defines methods to HTML handling.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.0
*/
public class HtmlTools
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/util/LineBreaker.java b/doxia-core/src/main/java/org/apache/maven/doxia/util/LineBreaker.java
index ac0056c..d5c5dfb 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/util/LineBreaker.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/util/LineBreaker.java
@@ -27,8 +27,6 @@ import java.io.Writer;
/**
* Allows to specify the line-length of an output writer.
- *
- * @version $Id$
*/
public class LineBreaker
{
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/util/XmlValidator.java b/doxia-core/src/main/java/org/apache/maven/doxia/util/XmlValidator.java
index 3a870de..b2c3986 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/util/XmlValidator.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/util/XmlValidator.java
@@ -42,7 +42,6 @@ import org.xml.sax.helpers.XMLReaderFactory;
/**
* A class to validate xml documents.
*
- * @version $Id$
* @since 1.1.3
*/
public class XmlValidator
diff --git a/doxia-core/src/main/javadoc/org/apache/maven/doxia/package.html b/doxia-core/src/main/javadoc/org/apache/maven/doxia/package.html
index f03dcec..6282d27 100644
--- a/doxia-core/src/main/javadoc/org/apache/maven/doxia/package.html
+++ b/doxia-core/src/main/javadoc/org/apache/maven/doxia/package.html
@@ -27,24 +27,24 @@ under the License.
<h2>Using Maven Doxia API</h2>
<p>The following snippet shows how to use the Doxia API:</p>
- <div align="left" class="java">
- <table border="0" cellpadding="3" cellspacing="0" bgcolor="#ffffff">
+ <div style="text-align:center" class="java">
+ <table>
<tr>
<!-- start source code -->
- <td nowrap="nowrap" valign="top" align="left">
+ <td nowrap="nowrap" style="text-align:left">
<code>
- <font color="#ffffff"> </font><font color="#000000">File userDir = </font><font color="#7f0055"><b>new </b></font><font color="#000000">File</font><font color="#000000">( </font><font color="#000000">System.getProperty </font><font color="#000000">( </font><font color="#2a00ff">"user.dir" </font><font color="#000000">) )</font><font color="#000000">;</font><br />
- <font color="#ffffff"> </font><font color="#000000">File inputFile = </font><font color="#7f0055"><b>new </b></font><font color="#000000">File</font><font color="#000000">( </font><font color="#000000">userDir, </font><font color="#2a00ff">"test.apt" </font><font color="#000000">)</font><font color="#000000">;</font><br />
- <font color="#ffffff"> </font><font color="#000000">File outputFile = </font><font color="#7f0055"><b>new </b></font><font color="#000000">File</font><font color="#000000">( </font><font color="#000000">userDir, </font><font color="#2a00ff">"test.html" </font><font color="#000000">)</font><font color="#000000">;</font><br />
- <font color="#ffffff"></font><br />
- <font color="#ffffff"> </font><font color="#000000">Reader source = ReaderFactory.newReader</font><font color="#000000">( </font><font color="#000000">inputFile, </font><font color="#2a00ff">"UTF-8" </font><font color="#000000">)</font><font color="#000000">;</font><br />
- <font color="#ffffff"></font><br />
- <font color="#ffffff"> </font><font color="#000000">SinkFactory sinkFactory = </font><font color="#000000">(</font><font color="#000000">SinkFactory</font><font color="#000000">) </font><font color="#000000">lookup</font><font color="#000000">( </font><font color="#000000">SinkFactory.ROLE, </font><font color="#2a00ff">"html" </font><font color="#000000">)</font><font color="#000000">; </font><font color="#3f7f5f">//& [...]
- <font color="#ffffff"> </font><font color="#000000">Sink sink = sinkFactory.createSink</font><font color="#000000">( </font><font color="#000000">outputFile.getParentFile</font><font color="#000000">()</font><font color="#000000">, outputFile.getName</font><font color="#000000">() ) )</font><font color="#000000">;</font><br />
- <font color="#ffffff"></font><br />
- <font color="#ffffff"> </font><font color="#000000">Doxia doxia = </font><font color="#000000">(</font><font color="#000000">Doxia</font><font color="#000000">) </font><font color="#000000">lookup</font><font color="#000000">( </font><font color="#000000">Doxia.ROLE </font><font color="#000000">)</font><font color="#000000">; </font><font color="#3f7f5f">// Plexus lookup</font><br />
- <font color="#ffffff"></font><br />
- <font color="#ffffff"> </font><font color="#000000">doxia.parse</font><font color="#000000">( </font><font color="#000000">source, </font><font color="#2a00ff">"apt"</font><font color="#000000">, sink </font><font color="#000000">)</font><font color="#000000">;</font>
+ <span style="color:#ffffff"> </span><span style="color:#000000">File userDir = </span><span style="color:#7f0055"><b>new </b></span><span style="color:#000000">File</span><span style="color:#000000">( </span><span style="color:#000000">System.getProperty </span><span style="color:#000000">( </span><span style="color:#2a00ff">"user.dir" </span><span style="color:#000000">) )</span><span style="color:#000000">;</sp [...]
+ <span style="color:#ffffff"> </span><span style="color:#000000">File inputFile = </span><span style="color:#7f0055"><b>new </b></span><span style="color:#000000">File</span><span style="color:#000000">( </span><span style="color:#000000">userDir, </span><span style="color:#2a00ff">"test.apt" </span><span style="color:#000000">)</span><span style="color:#000000">;</span><br/>
+ <span style="color:#ffffff"> </span><span style="color:#000000">File outputFile = </span><span style="color:#7f0055"><b>new </b></span><span style="color:#000000">File</span><span style="color:#000000">( </span><span style="color:#000000">userDir, </span><span style="color:#2a00ff">"test.html" </span><span style="color:#000000">)</span><span style="color:#000000">;</span><br/>
+ <span style="color:#ffffff"></span><br />
+ <span style="color:#ffffff"> </span><span style="color:#000000">Reader source = ReaderFactory.newReader</span><span style="color:#000000">( </span><span style="color:#000000">inputFile, </span><span style="color:#2a00ff">"UTF-8" </span><span style="color:#000000">)</span><span style="color:#000000">;</span><br />
+ <span style="color:#ffffff"></span><br />
+ <span style="color:#ffffff"> </span><span style="color:#000000">SinkFactory sinkFactory = </span><span style="color:#000000">(</span><span style="color:#000000">SinkFactory</span><span style="color:#000000">) </span><span style="color:#000000">lookup</span><span style="color:#000000">( </span><span style="color:#000000">SinkFactory.ROLE, </span><span style="color:#2a00ff">"html" </span><span style="color:#000000">)</span>< [...]
+ <span style="color:#ffffff"> </span><span style="color:#000000">Sink sink = sinkFactory.createSink</span><span style="color:#000000">( </span><span style="color:#000000">outputFile.getParentFile</span><span style="color:#000000">()</span><span style="color:#000000">, outputFile.getName</span><span style="color:#000000">() ) )</span><span style="color:#000000">;</span><br />
+ <span style="color:#ffffff"></span><br />
+ <span style="color:#ffffff"> </span><span style="color:#000000">Doxia doxia = </span><span style="color:#000000">(</span><span style="color:#000000">Doxia</span><span style="color:#000000">) </span><span style="color:#000000">lookup</span><span style="color:#000000">( </span><span style="color:#000000">Doxia.ROLE </span><span style="color:#000000">)</span><span style="color:#000000">; </span><span style="color:#3f7f5f">// Ple [...]
+ <span style="color:#ffffff"></span><br />
+ <span style="color:#ffffff"> </span><span style="color:#000000">doxia.parse</span><span style="color:#000000">( </span><span style="color:#000000">source, </span><span style="color:#2a00ff">"apt"</span><span style="color:#000000">, sink </span><span style="color:#000000">)</span><span style="color:#000000">;</span>
</code>
</td>
<!-- end source code -->
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/AbstractModuleTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/AbstractModuleTest.java
index 650edd9..3a1ec80 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/AbstractModuleTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/AbstractModuleTest.java
@@ -34,7 +34,6 @@ import java.io.Writer;
/**
* Provide some common convenience methods to test Doxia modules (parsers and sinks).
*
- * @version $Id$
* @since 1.0
*/
public abstract class AbstractModuleTest
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/index/IndexEntryTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/index/IndexEntryTest.java
index 5ae1815..d8913f7 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/index/IndexEntryTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/index/IndexEntryTest.java
@@ -26,7 +26,6 @@ import static org.junit.Assert.assertTrue;
/**
* @author <a href="mailto:trygve.laugstol@objectware.no">Trygve Laugstøl</a>
- * @version $Id$
*/
public class IndexEntryTest
{
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/macro/snippet/SnippetMacroTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/macro/snippet/SnippetMacroTest.java
index 121e573..a6b6c37 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/macro/snippet/SnippetMacroTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/macro/snippet/SnippetMacroTest.java
@@ -30,7 +30,6 @@ import org.apache.maven.doxia.sink.impl.SinkEventElement;
import org.apache.maven.doxia.sink.impl.SinkEventTestingSink;
import org.codehaus.plexus.PlexusTestCase;
import org.hamcrest.CoreMatchers;
-import org.junit.Assert;
import static org.hamcrest.MatcherAssert.assertThat;
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/macro/toc/TocMacroTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/macro/toc/TocMacroTest.java
index e9a2696..d124f2f 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/macro/toc/TocMacroTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/macro/toc/TocMacroTest.java
@@ -41,7 +41,6 @@ import static org.junit.Assert.*;
* Test toc macro.
*
* @author ltheussl
- * @version $Id$
*/
public class TocMacroTest
{
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/module/AbstractIdentityTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/module/AbstractIdentityTest.java
index 45292b5..9b4d868 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/module/AbstractIdentityTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/module/AbstractIdentityTest.java
@@ -34,15 +34,12 @@ import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.impl.SinkTestDocument;
import org.apache.maven.doxia.sink.impl.TextSink;
import org.codehaus.plexus.DefaultPlexusContainer;
-import org.codehaus.plexus.util.IOUtil;
/**
* If a module provides both Parser and Sink, this class
* can be used to check that chaining them together
* results in the identity transformation, ie the model is still the same
* after being piped through a Parser and the corresponding Sink.
- *
- * @version $Id$
*/
public abstract class AbstractIdentityTest
extends AbstractModuleTest
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/parser/AbstractParserTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/parser/AbstractParserTest.java
index 64803e3..78d29d5 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/parser/AbstractParserTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/parser/AbstractParserTest.java
@@ -37,8 +37,6 @@ import java.util.Iterator;
* <br>
* <b>Note</b>: you have to provide a sample "test." + outputExtension()
* file in the test resources directory if you extend this class.
- *
- * @version $Id$
* @since 1.0
*/
public abstract class AbstractParserTest
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/parser/AbstractParserTestCase.java b/doxia-core/src/test/java/org/apache/maven/doxia/parser/AbstractParserTestCase.java
index 8a746f5..3097bad 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/parser/AbstractParserTestCase.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/parser/AbstractParserTestCase.java
@@ -31,7 +31,6 @@ import java.io.Reader;
*
* @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
* @author <a href="mailto:evenisse@codehaus.org">Emmanuel Venisse</a>
- * @version $Id$
* @since 1.0
*/
public abstract class AbstractParserTestCase
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/parser/XhtmlBaseParserTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/parser/XhtmlBaseParserTest.java
index 70f2085..58342db 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/parser/XhtmlBaseParserTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/parser/XhtmlBaseParserTest.java
@@ -32,7 +32,6 @@ import static org.junit.Assert.assertNotEquals;
* Test for XhtmlBaseParser.
*
* @author ltheussl
- * @version $Id$
* @since 1.1
*/
public class XhtmlBaseParserTest
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractSinkTestCase.java b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractSinkTestCase.java
index e2d4521..1ffd78c 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractSinkTestCase.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractSinkTestCase.java
@@ -33,7 +33,6 @@ import org.codehaus.plexus.PlexusTestCase;
/**
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
* @since 1.0
*/
public abstract class AbstractSinkTestCase
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkEventElement.java b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkEventElement.java
index d4403db..78efe07 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkEventElement.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkEventElement.java
@@ -26,7 +26,6 @@ import org.apache.commons.lang3.builder.ToStringBuilder;
* the order and effect of some parser events.
*
* @author ltheussl
- * @version $Id$
* @since 1.1
*/
public class SinkEventElement
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkEventTestingSink.java b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkEventTestingSink.java
index 851ab3e..ed25e5e 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkEventTestingSink.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkEventTestingSink.java
@@ -30,7 +30,6 @@ import org.apache.maven.doxia.sink.impl.AbstractSink;
* the input of some parser is well-formed.
*
* @author ltheussl
- * @version $Id$
* @since 1.1
*/
public class SinkEventTestingSink
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkTestDocument.java b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkTestDocument.java
index 39626ca..f11d917 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkTestDocument.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/SinkTestDocument.java
@@ -24,8 +24,6 @@ import org.apache.maven.doxia.sink.impl.SinkEventAttributeSet;
/**
* Static methods to generate standard Doxia sink events.
- *
- * @version $Id$
*/
public class SinkTestDocument
{
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/WellformednessCheckingSink.java b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/WellformednessCheckingSink.java
index 2ad1a5a..4791778 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/WellformednessCheckingSink.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/WellformednessCheckingSink.java
@@ -32,7 +32,6 @@ import org.apache.maven.doxia.sink.impl.AbstractSink;
* the input of some parser is well-formed.
*
* @author <a href="mailto:lars@trieloff.net">Lars Trieloff</a>
- * @version $Id$
*/
public class WellformednessCheckingSink
extends AbstractSink
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/XhtmlBaseSinkTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/XhtmlBaseSinkTest.java
index a06b763..e9f7074 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/XhtmlBaseSinkTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/XhtmlBaseSinkTest.java
@@ -37,7 +37,6 @@ import static org.junit.Assert.assertTrue;
* Test for XhtmlBaseSink.
*
* @author ltheussl
- * @version $Id$
* @since 1.1
*/
public class XhtmlBaseSinkTest
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/util/DoxiaUtilsTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/util/DoxiaUtilsTest.java
index 3093701..1666b37 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/util/DoxiaUtilsTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/util/DoxiaUtilsTest.java
@@ -31,7 +31,6 @@ import org.codehaus.plexus.PlexusTestCase;
* Test case for <code>DoxiaUtils</code>.
*
* @author ltheussl
- * @version $Id$
*/
public class DoxiaUtilsTest
extends PlexusTestCase
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java
index 1afa281..f592abb 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java
@@ -27,7 +27,6 @@ import org.codehaus.plexus.PlexusTestCase;
* Test case for <code>HtmlTools</code>.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class HtmlToolsTest
extends PlexusTestCase
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/util/XmlValidatorTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/util/XmlValidatorTest.java
index 7f6c896..40a93d6 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/util/XmlValidatorTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/util/XmlValidatorTest.java
@@ -29,7 +29,6 @@ import org.codehaus.plexus.util.xml.XmlStreamReader;
* Test case for <code>XmlValidator</code>.
*
* @author Hervé Boutemy
- * @version $Id$
*/
public class XmlValidatorTest
extends PlexusTestCase
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/xsd/AbstractXmlValidatorTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/xsd/AbstractXmlValidatorTest.java
index cd7a057..db1fe0f 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/xsd/AbstractXmlValidatorTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/xsd/AbstractXmlValidatorTest.java
@@ -48,7 +48,6 @@ import org.xml.sax.EntityResolver;
* Abstract class to validate XML files with DTD or XSD mainly for Doxia namespaces.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.0
*/
public abstract class AbstractXmlValidatorTest
diff --git a/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/Log.java b/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/Log.java
index 7b42e0b..e4bd32f 100644
--- a/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/Log.java
+++ b/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/Log.java
@@ -32,7 +32,6 @@ package org.apache.maven.doxia.logging;
*
* @author jdcasey
* @author ltheussl
- * @version $Id$
* @since 1.1
*/
public interface Log
diff --git a/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/LogEnabled.java b/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/LogEnabled.java
index 11007f5..a435a98 100644
--- a/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/LogEnabled.java
+++ b/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/LogEnabled.java
@@ -26,7 +26,6 @@ package org.apache.maven.doxia.logging;
* Based on <code>org.codehaus.plexus.logging.LogEnabled</code>.
*
* @author ltheussl
- * @version $Id$
* @since 1.1
*/
public interface LogEnabled
diff --git a/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/PlexusLoggerWrapper.java b/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/PlexusLoggerWrapper.java
index 6e3134f..708b5aa 100644
--- a/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/PlexusLoggerWrapper.java
+++ b/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/PlexusLoggerWrapper.java
@@ -26,7 +26,6 @@ import org.codehaus.plexus.logging.Logger;
* Based on org.apache.maven.plugin.logging.Log.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.1
*/
public class PlexusLoggerWrapper
@@ -69,7 +68,11 @@ public class PlexusLoggerWrapper
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @param content a {@link java.lang.CharSequence} object.
+ */
public void debug( CharSequence content )
{
logger.debug( toString( content ) );
@@ -99,13 +102,21 @@ public class PlexusLoggerWrapper
logger.info( toString( content ), error );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @param error a {@link java.lang.Throwable} object.
+ */
public void info( Throwable error )
{
logger.info( "", error );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @param content a {@link java.lang.CharSequence} object.
+ */
public void warn( CharSequence content )
{
logger.warn( toString( content ) );
@@ -135,31 +146,51 @@ public class PlexusLoggerWrapper
logger.error( toString( content ), error );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @param error a {@link java.lang.Throwable} object.
+ */
public void error( Throwable error )
{
logger.error( "", error );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a boolean.
+ */
public boolean isDebugEnabled()
{
return logger.isDebugEnabled();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a boolean.
+ */
public boolean isInfoEnabled()
{
return logger.isInfoEnabled();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a boolean.
+ */
public boolean isWarnEnabled()
{
return logger.isWarnEnabled();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a boolean.
+ */
public boolean isErrorEnabled()
{
return logger.isErrorEnabled();
diff --git a/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/SystemStreamLog.java b/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/SystemStreamLog.java
index 44099d5..70bcb14 100644
--- a/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/SystemStreamLog.java
+++ b/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/SystemStreamLog.java
@@ -29,7 +29,6 @@ import java.io.StringWriter;
*
* @author jdcasey
* @author ltheussl
- * @version $Id$
* @since 1.1
*/
public class SystemStreamLog
@@ -64,7 +63,11 @@ public class SystemStreamLog
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @param content a {@link java.lang.CharSequence} object.
+ */
public void debug( CharSequence content )
{
if ( isDebugEnabled() )
@@ -109,7 +112,11 @@ public class SystemStreamLog
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @param error a {@link java.lang.Throwable} object.
+ */
public void info( Throwable error )
{
if ( isInfoEnabled() )
@@ -118,7 +125,11 @@ public class SystemStreamLog
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @param content a {@link java.lang.CharSequence} object.
+ */
public void warn( CharSequence content )
{
if ( isWarnEnabled() )
@@ -169,7 +180,11 @@ public class SystemStreamLog
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @param error a {@link java.lang.Throwable} object.
+ */
public void error( Throwable error )
{
if ( isErrorEnabled() )
@@ -183,25 +198,41 @@ public class SystemStreamLog
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a boolean.
+ */
public boolean isDebugEnabled()
{
return ( currentLevel <= LEVEL_DEBUG );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a boolean.
+ */
public boolean isInfoEnabled()
{
return ( currentLevel <= LEVEL_INFO );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a boolean.
+ */
public boolean isWarnEnabled()
{
return ( currentLevel <= LEVEL_WARN );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a boolean.
+ */
public boolean isErrorEnabled()
{
return ( currentLevel <= LEVEL_ERROR );
diff --git a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptMarkup.java b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptMarkup.java
index acb67d6..b8b8182 100644
--- a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptMarkup.java
+++ b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptMarkup.java
@@ -26,9 +26,7 @@ import org.codehaus.plexus.util.StringUtils;
* This interface defines all markups and syntaxes used by the <b>APT</b> format.
*
* @see <a href="https://maven.apache.org/doxia/references/apt-format.html">https://maven.apache.org/doxia/references/apt-format.html</a>
- *
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.0
*/
@SuppressWarnings( "checkstyle:interfaceistype" )
diff --git a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParseException.java b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParseException.java
index 970b798..0df36e1 100644
--- a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParseException.java
+++ b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParseException.java
@@ -24,7 +24,6 @@ import org.apache.maven.doxia.parser.ParseException;
/**
* Wraps an exception when parsing apt source documents.
*
- * @version $Id$
* @since 1.0
*/
public class AptParseException
diff --git a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java
index 21cf716..bccaddf 100644
--- a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java
+++ b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java
@@ -50,7 +50,6 @@ import java.util.TreeSet;
* <br>
* Based on the <a href="http://www.xmlmind.com/aptconvert.html">APTconvert</a> project.
*
- * @version $Id$
* @since 1.0
*/
@Component( role = Parser.class, hint = "apt" )
@@ -184,6 +183,7 @@ public class AptParser
// Public methods
// ----------------------------------------------------------------------
+ /** {@inheritDoc} */
@Override
public void parse( Reader source, Sink sink )
throws ParseException
@@ -191,6 +191,7 @@ public class AptParser
parse( source, sink, "" );
}
+ /** {@inheritDoc} */
@Override
public void parse( Reader source, Sink sink, String reference )
throws ParseException
@@ -714,7 +715,9 @@ public class AptParser
return replaced.toString();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected void init()
{
super.init();
diff --git a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptReaderSource.java b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptReaderSource.java
index bf6d664..8edf7b3 100644
--- a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptReaderSource.java
+++ b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptReaderSource.java
@@ -27,8 +27,6 @@ import org.codehaus.plexus.util.IOUtil;
/**
* Reader for apt source documents.
- *
- * @version $Id$
*/
public class AptReaderSource
implements AptSource
@@ -67,7 +65,12 @@ public class AptReaderSource
this.name = name;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a {@link java.lang.String} object.
+ * @throws org.apache.maven.doxia.module.apt.AptParseException if any.
+ */
public String getNextLine()
throws AptParseException
{
@@ -100,14 +103,22 @@ public class AptReaderSource
return line;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a {@link java.lang.String} object.
+ */
public String getName()
{
// never return null
return name != null ? name : "";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a int.
+ */
public int getLineNumber()
{
return lineNumber;
diff --git a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java
index 2fa1d27..a00754e 100644
--- a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java
+++ b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java
@@ -36,7 +36,6 @@ import org.codehaus.plexus.util.StringUtils;
* <b>Note</b>: The encoding used is UTF-8.
*
* @author eredmond
- * @version $Id$
* @since 1.0
*/
public class AptSink
@@ -158,7 +157,9 @@ public class AptSink
init();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected void init()
{
super.init();
@@ -203,7 +204,9 @@ public class AptSink
tableCaptionBuffer = new StringBuilder();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void head()
{
boolean startFlag = this.startFlag;
@@ -214,7 +217,9 @@ public class AptSink
this.startFlag = startFlag;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void head_()
{
headerFlag = false;
@@ -241,7 +246,9 @@ public class AptSink
write( HEADER_START_MARKUP + EOL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void title_()
{
if ( buffer.length() > 0 )
@@ -251,7 +258,9 @@ public class AptSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void author_()
{
if ( buffer.length() > 0 )
@@ -261,7 +270,9 @@ public class AptSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void date_()
{
if ( buffer.length() > 0 )
@@ -271,97 +282,129 @@ public class AptSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section1_()
{
write( EOL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section2_()
{
write( EOL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section3_()
{
write( EOL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section4_()
{
write( EOL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section5_()
{
write( EOL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle1()
{
write( EOL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle1_()
{
write( EOL + EOL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle2()
{
write( EOL + SECTION_TITLE_START_MARKUP );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle2_()
{
write( EOL + EOL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle3()
{
write( EOL + StringUtils.repeat( SECTION_TITLE_START_MARKUP, 2 ) );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle3_()
{
write( EOL + EOL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle4()
{
write( EOL + StringUtils.repeat( SECTION_TITLE_START_MARKUP, 3 ) );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle4_()
{
write( EOL + EOL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle5()
{
write( EOL + StringUtils.repeat( SECTION_TITLE_START_MARKUP, 4 ) );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle5_()
{
write( EOL + EOL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void list()
{
listNestingIndent += " ";
@@ -369,7 +412,9 @@ public class AptSink
write( EOL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void list_()
{
if ( listNestingIndent.length() <= 1 )
@@ -385,7 +430,9 @@ public class AptSink
itemFlag = false;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void listItem()
{
//if ( !numberedList )
@@ -395,7 +442,9 @@ public class AptSink
itemFlag = true;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void listItem_()
{
write( EOL );
@@ -431,7 +480,9 @@ public class AptSink
listStyles.push( style );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void numberedList_()
{
if ( listNestingIndent.length() <= 1 )
@@ -447,7 +498,9 @@ public class AptSink
itemFlag = false;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void numberedListItem()
{
String style = listStyles.peek();
@@ -464,14 +517,18 @@ public class AptSink
itemFlag = true;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void numberedListItem_()
{
write( EOL );
itemFlag = false;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definitionList()
{
listNestingIndent += " ";
@@ -479,7 +536,9 @@ public class AptSink
write( EOL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definitionList_()
{
if ( listNestingIndent.length() <= 1 )
@@ -495,38 +554,50 @@ public class AptSink
itemFlag = false;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definedTerm()
{
write( EOL + " [" );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definedTerm_()
{
write( "] " );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definition()
{
itemFlag = true;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definition_()
{
write( EOL );
itemFlag = false;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void pageBreak()
{
write( EOL + PAGE_BREAK + EOL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void paragraph()
{
if ( tableCellFlag )
@@ -543,7 +614,9 @@ public class AptSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void paragraph_()
{
if ( tableCellFlag )
@@ -572,7 +645,9 @@ public class AptSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void verbatim_()
{
if ( isBoxed )
@@ -587,19 +662,25 @@ public class AptSink
verbatimFlag = false;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void horizontalRule()
{
write( EOL + HORIZONTAL_RULE_MARKUP + EOL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void table()
{
write( EOL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void table_()
{
if ( rowLine != null )
@@ -623,21 +704,27 @@ public class AptSink
gridFlag = grid;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableRows_()
{
cellJustif = null;
gridFlag = false;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableRow()
{
bufferFlag = true;
cellCount = 0;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableRow_()
{
bufferFlag = false;
@@ -695,13 +782,17 @@ public class AptSink
this.rowLine = rLine.toString();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableCell()
{
tableCell( false );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableHeaderCell()
{
tableCell( true );
@@ -721,13 +812,17 @@ public class AptSink
tableCellFlag = true;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableCell_()
{
endTableCell();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableHeaderCell_()
{
endTableCell();
@@ -743,19 +838,25 @@ public class AptSink
cellCount++;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableCaption()
{
tableCaptionFlag = true;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableCaption_()
{
tableCaptionFlag = false;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void figureCaption_()
{
write( EOL );
@@ -773,7 +874,9 @@ public class AptSink
write( ANCHOR_START_MARKUP );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void anchor_()
{
write( ANCHOR_END_MARKUP );
@@ -790,7 +893,9 @@ public class AptSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void link_()
{
if ( !headerFlag )
@@ -816,7 +921,9 @@ public class AptSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void inline()
{
inline( null );
@@ -856,7 +963,9 @@ public class AptSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void inline_()
{
if ( !headerFlag )
@@ -868,43 +977,57 @@ public class AptSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void italic()
{
inline( SinkEventAttributeSet.Semantics.ITALIC );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void italic_()
{
inline_();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void bold()
{
inline( SinkEventAttributeSet.Semantics.BOLD );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void bold_()
{
inline_();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void monospaced()
{
inline( SinkEventAttributeSet.Semantics.CODE );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void monospaced_()
{
inline_();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void lineBreak()
{
if ( headerFlag || bufferFlag )
@@ -921,7 +1044,9 @@ public class AptSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void nonBreakingSpace()
{
if ( headerFlag || bufferFlag )
@@ -1016,13 +1141,17 @@ public class AptSink
write( escapeAPT( text ) );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void flush()
{
writer.flush();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void close()
{
writer.close();
diff --git a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSinkFactory.java b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSinkFactory.java
index 0c7db7c..82847fc 100644
--- a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSinkFactory.java
+++ b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSinkFactory.java
@@ -30,7 +30,6 @@ import org.codehaus.plexus.component.annotations.Component;
* APT implementation of the Sink factory.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.0
*/
@Component( role = SinkFactory.class, hint = "apt" )
diff --git a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSource.java b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSource.java
index 3582204..aff8706 100644
--- a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSource.java
+++ b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSource.java
@@ -21,8 +21,6 @@ package org.apache.maven.doxia.module.apt;
/**
* An interface to read apt source documents.
- *
- * @version $Id$
*/
public interface AptSource
{
diff --git a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptUtils.java b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptUtils.java
index 222de3e..80d7c29 100644
--- a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptUtils.java
+++ b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptUtils.java
@@ -26,7 +26,6 @@ import org.apache.maven.doxia.util.DoxiaUtils;
*
* @author ltheussl
* @since 1.1
- * @version $Id$
*/
public class AptUtils
{
@@ -64,7 +63,6 @@ public class AptUtils
*
* @param link The link to check.
* @return True if DoxiaUtils.isExternalLink(link) returns true.
- *
* @see org.apache.maven.doxia.util.DoxiaUtils#isExternalLink(String)
* @see #isInternalLink(String)
* @see #isLocalLink(String)
@@ -81,7 +79,6 @@ public class AptUtils
* @param link The link to check.
* @return True if link is neither an {@link #isExternalLink(String) external}
* nor a {@link #isLocalLink(String) local} link.
- *
* @see org.apache.maven.doxia.util.DoxiaUtils#isInternalLink(String)
* @see #isExternalLink(String)
* @see #isLocalLink(String)
@@ -97,7 +94,6 @@ public class AptUtils
*
* @param link The link to check.
* @return True if the link starts with either "/", "./" or "../".
- *
* @see org.apache.maven.doxia.util.DoxiaUtils#isLocalLink(String)
* @see #isExternalLink(String)
* @see #isInternalLink(String)
diff --git a/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptParserTest.java b/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptParserTest.java
index 163d28d..0112fde 100644
--- a/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptParserTest.java
+++ b/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptParserTest.java
@@ -33,11 +33,9 @@ import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.impl.SinkEventAttributeSet;
import org.apache.maven.doxia.sink.impl.SinkEventElement;
import org.apache.maven.doxia.sink.impl.SinkEventTestingSink;
-import org.codehaus.plexus.util.IOUtil;
/**
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class AptParserTest
extends AbstractParserTest
diff --git a/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptUtilsTest.java b/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptUtilsTest.java
index eb253eb..571e582 100644
--- a/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptUtilsTest.java
+++ b/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptUtilsTest.java
@@ -27,7 +27,6 @@ import static org.junit.Assert.*;
* Test AptUtils.
*
* @author ltheussl
- * @version $Id$
*/
public class AptUtilsTest
{
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceMarkup.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceMarkup.java
index d06059d..61ac735 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceMarkup.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceMarkup.java
@@ -28,7 +28,6 @@ import org.apache.maven.doxia.markup.TextMarkup;
* Confluence Notation Guide Overview</a>
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.0
*/
@SuppressWarnings( "checkstyle:interfaceistype" )
@@ -81,7 +80,7 @@ public interface ConfluenceMarkup
/** Syntax for the link start markup: "[" */
String LINK_START_MARKUP = "[";
- /** Syntax for the list item markup: "* */
+ /** Syntax for the list item markup: <code>"* "</code> */
String LIST_ITEM_MARKUP = "* ";
/** Syntax for the mono-spaced style start: "{{" */
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceParser.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceParser.java
index f63acd0..489a4f2 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceParser.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceParser.java
@@ -46,7 +46,6 @@ import org.codehaus.plexus.component.annotations.Component;
* See <a href="http://confluence.atlassian.com/display/CONF25/Confluence+Notation+Guide+Overview">
* Confluence Notation Guide Overview</a>
*
- * @version $Id$
* @since 1.0
*/
@Component( role = Parser.class, hint = "confluence" )
@@ -104,6 +103,7 @@ public class ConfluenceParser
return blocks;
}
+ /** {@inheritDoc} */
@Override
public void parse( Reader source, Sink sink )
throws ParseException
@@ -111,6 +111,7 @@ public class ConfluenceParser
parse( source, sink, "" );
}
+ /** {@inheritDoc} */
@Override
public synchronized void parse( Reader source, Sink sink, String reference )
throws ParseException
@@ -146,7 +147,9 @@ public class ConfluenceParser
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected void init()
{
super.init();
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceSink.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceSink.java
index 0f9e657..02fae85 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceSink.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceSink.java
@@ -40,7 +40,6 @@ import org.codehaus.plexus.util.StringUtils;
* <b>Note</b>: The encoding used is UTF-8.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.0
*/
public class ConfluenceSink
@@ -162,13 +161,17 @@ public class ConfluenceSink
// nop
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void bold()
{
inline( SinkEventAttributeSet.Semantics.BOLD );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void bold_()
{
inline_();
@@ -183,7 +186,9 @@ public class ConfluenceSink
// nop
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void close()
{
out.write( writer.toString() );
@@ -216,7 +221,9 @@ public class ConfluenceSink
// nop
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definedTerm()
{
// nop
@@ -244,9 +251,7 @@ public class ConfluenceSink
writer.write( CITATION_START_MARKUP );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void definition( SinkEventAttributes attributes )
{
definition();
@@ -380,14 +385,18 @@ public class ConfluenceSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void flush()
{
close();
writer.flush();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void head()
{
init();
@@ -401,7 +410,9 @@ public class ConfluenceSink
head();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void head_()
{
headFlag = false;
@@ -422,7 +433,9 @@ public class ConfluenceSink
horizontalRule();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void inline()
{
inline( null );
@@ -462,7 +475,9 @@ public class ConfluenceSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void inline_()
{
if ( !headFlag )
@@ -474,19 +489,25 @@ public class ConfluenceSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void italic()
{
inline( SinkEventAttributeSet.Semantics.ITALIC );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void italic_()
{
inline_();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void lineBreak()
{
write( LINE_BREAK_MARKUP );
@@ -511,14 +532,18 @@ public class ConfluenceSink
link( name );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void link_()
{
linkName = null;
write( LINK_END_MARKUP );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void list()
{
if ( !writer.toString().endsWith( EOL + EOL ) )
@@ -535,7 +560,9 @@ public class ConfluenceSink
list();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void list_()
{
levelList--;
@@ -546,7 +573,9 @@ public class ConfluenceSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void listItem()
{
write( StringUtils.repeat( "*", levelList ) + " " );
@@ -558,20 +587,26 @@ public class ConfluenceSink
listItem();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void listItem_()
{
writeEOL( true );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void monospaced()
{
monospacedFlag = true;
inline( SinkEventAttributeSet.Semantics.CODE );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void monospaced_()
{
monospacedFlag = false;
@@ -617,7 +652,9 @@ public class ConfluenceSink
numberedList( numbering );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void numberedList_()
{
levelList--;
@@ -629,7 +666,9 @@ public class ConfluenceSink
listStyles.pop();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void numberedListItem()
{
writeEOL( true );
@@ -648,7 +687,9 @@ public class ConfluenceSink
numberedListItem();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void numberedListItem_()
{
writeEOL( true );
@@ -678,7 +719,9 @@ public class ConfluenceSink
paragraph();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void paragraph_()
{
writeEOL( true );
@@ -820,61 +863,81 @@ public class ConfluenceSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle1()
{
sectionTitle( 1, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle1_()
{
sectionTitle_( 1 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle2()
{
sectionTitle( 2, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle2_()
{
sectionTitle_( 2 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle3()
{
sectionTitle( 3, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle3_()
{
sectionTitle_( 3 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle4()
{
sectionTitle( 4, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle4_()
{
sectionTitle_( 4 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle5()
{
sectionTitle( 5, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle5_()
{
sectionTitle_( 5 );
@@ -896,7 +959,9 @@ public class ConfluenceSink
writeEOL();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void table()
{
// nop
@@ -911,7 +976,9 @@ public class ConfluenceSink
table();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void table_()
{
tableFlag = false;
@@ -943,7 +1010,9 @@ public class ConfluenceSink
// nop
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableCell()
{
write( " " );
@@ -961,14 +1030,18 @@ public class ConfluenceSink
tableCell();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableCell_()
{
write( " " );
write( TABLE_CELL_MARKUP );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableHeaderCell()
{
tableHeaderFlag = true;
@@ -987,13 +1060,17 @@ public class ConfluenceSink
tableHeaderCell();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableHeaderCell_()
{
write( TABLE_CELL_HEADER_END_MARKUP );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableRow()
{
write( TABLE_ROW_MARKUP );
@@ -1005,7 +1082,9 @@ public class ConfluenceSink
tableRow();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableRow_()
{
if ( tableHeaderFlag )
@@ -1172,7 +1251,9 @@ public class ConfluenceSink
writeEOL( true );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void verbatim_()
{
if ( verbatimBoxedFlag )
@@ -1236,6 +1317,7 @@ public class ConfluenceSink
* Write HTML, and optionally Confluence, escaped text to output.
*
* @param text The text to write.
+ * @param escapeConfluence a boolean.
*/
protected void content( String text, boolean escapeConfluence )
{
@@ -1249,7 +1331,9 @@ public class ConfluenceSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected void init()
{
super.init();
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceSinkFactory.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceSinkFactory.java
index 57199cc..11146d3 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceSinkFactory.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceSinkFactory.java
@@ -30,7 +30,6 @@ import org.codehaus.plexus.component.annotations.Component;
* Confluence implementation of the Sink factory.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.0
*/
@Component( role = SinkFactory.class, hint = "confluence" )
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/AbstractFatherBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/AbstractFatherBlock.java
index d8286db..1a1fe3f 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/AbstractFatherBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/AbstractFatherBlock.java
@@ -25,8 +25,6 @@ import org.apache.maven.doxia.sink.Sink;
/**
* <p>Abstract AbstractFatherBlock class.</p>
- *
- * @version $Id$
*/
public abstract class AbstractFatherBlock
implements Block
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/AnchorBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/AnchorBlock.java
index 812512e..ebb7f02 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/AnchorBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/AnchorBlock.java
@@ -22,7 +22,7 @@ package org.apache.maven.doxia.module.confluence.parser;
import org.apache.maven.doxia.sink.Sink;
/**
- * @version $Id$
+ * AnchorBlock
*/
class AnchorBlock
implements Block
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/Block.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/Block.java
index b4dce02..77477d9 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/Block.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/Block.java
@@ -23,8 +23,6 @@ import org.apache.maven.doxia.sink.Sink;
/**
* <p>Block interface.</p>
- *
- * @version $Id$
*/
public interface Block
{
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/BlockParser.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/BlockParser.java
index 5b51d2c..2f6d839 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/BlockParser.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/BlockParser.java
@@ -24,8 +24,6 @@ import org.apache.maven.doxia.parser.ParseException;
/**
* <p>BlockParser interface.</p>
- *
- * @version $Id$
*/
public interface BlockParser
{
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/BoldBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/BoldBlock.java
index d8c010f..f7021d4 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/BoldBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/BoldBlock.java
@@ -25,8 +25,6 @@ import java.util.List;
/**
* <p>BoldBlock class.</p>
- *
- * @version $Id$
*/
public class BoldBlock
extends AbstractFatherBlock
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ChildBlocksBuilder.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ChildBlocksBuilder.java
index dfaef5f..3b6fefc 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ChildBlocksBuilder.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ChildBlocksBuilder.java
@@ -30,7 +30,6 @@ import org.codehaus.plexus.util.StringUtils;
* on the stack to preserve stateless behaviour in the caller.
*
* @author Dave Syer
- * @version $Id$
* @since 1.1
*/
public class ChildBlocksBuilder
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/DefinitionListBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/DefinitionListBlock.java
index 18bebcc..a9b5d2c 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/DefinitionListBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/DefinitionListBlock.java
@@ -25,7 +25,7 @@ import org.apache.maven.doxia.sink.Sink;
import org.codehaus.plexus.util.StringUtils;
/**
- * @version $Id$
+ * DefinitionListBlock
*/
class DefinitionListBlock
implements Block
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/DefinitionListBlockParser.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/DefinitionListBlockParser.java
index acd70a1..aa960be 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/DefinitionListBlockParser.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/DefinitionListBlockParser.java
@@ -26,7 +26,6 @@ import org.apache.maven.doxia.util.ByLineSource;
* <p>DefinitionListBlockParser class.</p>
*
* @author Dave Syer
- * @version $Id$
* @since 1.1
*/
public class DefinitionListBlockParser
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/FigureBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/FigureBlock.java
index ebe2c3a..93c486c 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/FigureBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/FigureBlock.java
@@ -22,7 +22,7 @@ package org.apache.maven.doxia.module.confluence.parser;
import org.apache.maven.doxia.sink.Sink;
/**
- * @version $Id$
+ * FigureBlock
*/
class FigureBlock
implements Block
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/FigureBlockParser.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/FigureBlockParser.java
index 9e63242..76f2d00 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/FigureBlockParser.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/FigureBlockParser.java
@@ -25,7 +25,6 @@ import org.apache.maven.doxia.util.ByLineSource;
/**
* <p>FigureBlockParser class.</p>
*
- * @version $Id$
* @since 1.1
*/
public class FigureBlockParser
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/HorizontalRuleBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/HorizontalRuleBlock.java
index 1a65cc9..2b5c9c9 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/HorizontalRuleBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/HorizontalRuleBlock.java
@@ -22,7 +22,7 @@ package org.apache.maven.doxia.module.confluence.parser;
import org.apache.maven.doxia.sink.Sink;
/**
- * @version $Id$
+ * HorizontalRuleBlock
*/
class HorizontalRuleBlock
implements Block
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/HorizontalRuleBlockParser.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/HorizontalRuleBlockParser.java
index f9eb0a9..7994fbe 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/HorizontalRuleBlockParser.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/HorizontalRuleBlockParser.java
@@ -24,8 +24,6 @@ import org.apache.maven.doxia.parser.ParseException;
/**
* <p>HorizontalRuleBlockParser class.</p>
- *
- * @version $Id$
*/
public class HorizontalRuleBlockParser
implements BlockParser
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ItalicBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ItalicBlock.java
index 66a0726..e988193 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ItalicBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ItalicBlock.java
@@ -24,7 +24,7 @@ import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
- * @version $Id$
+ * ItalicBlock
*/
class ItalicBlock
extends AbstractFatherBlock
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/LinebreakBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/LinebreakBlock.java
index b594f1c..76eef4f 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/LinebreakBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/LinebreakBlock.java
@@ -23,7 +23,6 @@ import org.apache.maven.doxia.sink.Sink;
/**
* @author Dave Syer
- * @version $Id$
*/
class LinebreakBlock
implements Block
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/LinethroughBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/LinethroughBlock.java
index 5eaf37a..5652986 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/LinethroughBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/LinethroughBlock.java
@@ -24,7 +24,8 @@ import org.apache.maven.doxia.sink.SinkEventAttributes;
import org.apache.maven.doxia.sink.impl.SinkEventAttributeSet;
/**
- *
+ * <p>LinethroughBlock class.</p>
+ *
* @author Robert Scholte
* @since 1.4
*/
@@ -33,11 +34,17 @@ public class LinethroughBlock
{
private String text;
+ /**
+ * <p>Constructor for LinethroughBlock.</p>
+ *
+ * @param text a {@link java.lang.String} object.
+ */
public LinethroughBlock( String text )
{
this.text = text;
}
+ /** {@inheritDoc} */
public void traverse( Sink sink )
{
sink.text( text, new SinkEventAttributeSet( SinkEventAttributes.DECORATION, "line-through" ) );
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/LinkBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/LinkBlock.java
index 7ecd06f..327eb10 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/LinkBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/LinkBlock.java
@@ -22,7 +22,7 @@ package org.apache.maven.doxia.module.confluence.parser;
import org.apache.maven.doxia.sink.Sink;
/**
- * @version $Id$
+ * LinkBlock
*/
class LinkBlock
implements Block
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/MonospaceBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/MonospaceBlock.java
index bd5c55d..f725ac8 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/MonospaceBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/MonospaceBlock.java
@@ -24,7 +24,7 @@ import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
- * @version $Id$
+ * MonospaceBlock
*/
class MonospaceBlock extends AbstractFatherBlock
{
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ParagraphBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ParagraphBlock.java
index 5e4986b..004b10b 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ParagraphBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ParagraphBlock.java
@@ -24,8 +24,9 @@ import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
+ * ParagraphBlock
+ *
* @author Juan F. Codagnone
- * @version $Id$
*/
class ParagraphBlock
extends AbstractFatherBlock
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ParagraphBlockParser.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ParagraphBlockParser.java
index 59735c5..45f9621 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ParagraphBlockParser.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ParagraphBlockParser.java
@@ -24,8 +24,6 @@ import org.apache.maven.doxia.util.ByLineSource;
/**
* <p>ParagraphBlockParser class.</p>
- *
- * @version $Id$
*/
public class ParagraphBlockParser
implements BlockParser
@@ -56,8 +54,7 @@ public class ParagraphBlockParser
* @param source the source.
* @param generateParagraphTags whether to generate a paragraph.
* @return the visited Block.
- *
- * @throws org.apache.maven.doxia.parser.ParseException if any
+ * @throws org.apache.maven.doxia.parser.ParseException if any.
*/
public Block visit( String line, ByLineSource source, boolean generateParagraphTags )
throws ParseException
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/SectionBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/SectionBlock.java
index 29c0831..f902d63 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/SectionBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/SectionBlock.java
@@ -22,8 +22,9 @@ package org.apache.maven.doxia.module.confluence.parser;
import org.apache.maven.doxia.sink.Sink;
/**
+ * SectionBlock
+ *
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
*/
class SectionBlock
implements Block
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/SectionBlockParser.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/SectionBlockParser.java
index d13ac51..50cc9b6 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/SectionBlockParser.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/SectionBlockParser.java
@@ -26,7 +26,6 @@ import org.apache.maven.doxia.parser.ParseException;
* <p>SectionBlockParser class.</p>
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
*/
public class SectionBlockParser
implements BlockParser
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/SubBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/SubBlock.java
index 332f212..edff17f 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/SubBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/SubBlock.java
@@ -24,7 +24,8 @@ import org.apache.maven.doxia.sink.SinkEventAttributes;
import org.apache.maven.doxia.sink.impl.SinkEventAttributeSet;
/**
- *
+ * <p>SubBlock class.</p>
+ *
* @author Robert Scholte
* @since 1.4
*/
@@ -33,11 +34,17 @@ public class SubBlock
{
private String text;
+ /**
+ * <p>Constructor for SubBlock.</p>
+ *
+ * @param text a {@link java.lang.String} object.
+ */
public SubBlock( String text )
{
this.text = text;
}
+ /** {@inheritDoc} */
public void traverse( Sink sink )
{
sink.text( text, new SinkEventAttributeSet( SinkEventAttributes.VALIGN, "sub" ) );
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/SupBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/SupBlock.java
index b97bacf..df0d14a 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/SupBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/SupBlock.java
@@ -24,7 +24,8 @@ import org.apache.maven.doxia.sink.SinkEventAttributes;
import org.apache.maven.doxia.sink.impl.SinkEventAttributeSet;
/**
- *
+ * <p>SupBlock class.</p>
+ *
* @author Robert Scholte
* @since 1.4
*/
@@ -33,11 +34,17 @@ public class SupBlock
{
private String text;
+ /**
+ * <p>Constructor for SupBlock.</p>
+ *
+ * @param text a {@link java.lang.String} object.
+ */
public SupBlock( String text )
{
this.text = text;
}
+ /** {@inheritDoc} */
public void traverse( Sink sink )
{
sink.text( text, new SinkEventAttributeSet( SinkEventAttributes.VALIGN, "sup" ) );
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/TextBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/TextBlock.java
index 127de81..d9a0200 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/TextBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/TextBlock.java
@@ -25,7 +25,6 @@ import org.apache.maven.doxia.sink.Sink;
* <p>TextBlock class.</p>
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
*/
public class TextBlock
implements Block
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/UnderlineBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/UnderlineBlock.java
index db939c0..0075e01 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/UnderlineBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/UnderlineBlock.java
@@ -24,7 +24,8 @@ import org.apache.maven.doxia.sink.SinkEventAttributes;
import org.apache.maven.doxia.sink.impl.SinkEventAttributeSet;
/**
- *
+ * <p>UnderlineBlock class.</p>
+ *
* @author Robert Scholte
* @since 1.4
*/
@@ -33,11 +34,17 @@ public class UnderlineBlock
{
private String text;
+ /**
+ * <p>Constructor for UnderlineBlock.</p>
+ *
+ * @param text a {@link java.lang.String} object.
+ */
public UnderlineBlock( String text )
{
this.text = text;
}
+ /** {@inheritDoc} */
public void traverse( Sink sink )
{
sink.text( text, new SinkEventAttributeSet( SinkEventAttributes.DECORATION, "underline" ) );
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/VerbatimBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/VerbatimBlock.java
index 8bef74a..c1e1a92 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/VerbatimBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/VerbatimBlock.java
@@ -23,8 +23,9 @@ import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.impl.SinkEventAttributeSet;
/**
+ * VerbatimBlock
+ *
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
*/
class VerbatimBlock
implements Block
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/VerbatimBlockParser.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/VerbatimBlockParser.java
index 4f8f10d..691e721 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/VerbatimBlockParser.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/VerbatimBlockParser.java
@@ -26,7 +26,6 @@ import org.apache.maven.doxia.parser.ParseException;
* <p>VerbatimBlockParser class.</p>
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
*/
public class VerbatimBlockParser
implements BlockParser
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/BulletedListBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/BulletedListBlock.java
index 9970671..95edc46 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/BulletedListBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/BulletedListBlock.java
@@ -25,8 +25,9 @@ import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
+ * BulletedListBlock
+ *
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
*/
class BulletedListBlock
extends ListBlock
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/ListBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/ListBlock.java
index c633e30..6e6b93d 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/ListBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/ListBlock.java
@@ -25,8 +25,9 @@ import org.apache.maven.doxia.module.confluence.parser.Block;
import java.util.List;
/**
+ * ListBlock
+ *
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
*/
abstract class ListBlock
extends AbstractFatherBlock
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/ListBlockParser.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/ListBlockParser.java
index 2ca8cbe..f16ef48 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/ListBlockParser.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/ListBlockParser.java
@@ -28,7 +28,6 @@ import org.apache.maven.doxia.parser.ParseException;
* <p>ListBlockParser class.</p>
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
*/
public class ListBlockParser
implements BlockParser
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/ListItemBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/ListItemBlock.java
index e62b743..a579c77 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/ListItemBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/ListItemBlock.java
@@ -26,7 +26,7 @@ import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
- * @version $Id$
+ * ListItemBlock
*/
class ListItemBlock
extends AbstractFatherBlock
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/NumberedListBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/NumberedListBlock.java
index 2a3ad9b..5c65eed 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/NumberedListBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/NumberedListBlock.java
@@ -26,8 +26,6 @@ import java.util.List;
/**
* <p>NumberedListBlock class.</p>
- *
- * @version $Id$
*/
public class NumberedListBlock
extends ListBlock
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/TreeComponent.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/TreeComponent.java
index 1b3297a..8c7d00e 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/TreeComponent.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/TreeComponent.java
@@ -23,8 +23,9 @@ import java.util.List;
import java.util.ArrayList;
/**
+ * TreeComponent
+ *
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
*/
class TreeComponent
{
@@ -83,7 +84,11 @@ class TreeComponent
return ret;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @return a {@link java.lang.String} object.
+ */
public String toString()
{
return toString( "" );
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/TreeListBuilder.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/TreeListBuilder.java
index c775f1a..0afee22 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/TreeListBuilder.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/TreeListBuilder.java
@@ -27,8 +27,6 @@ import org.apache.maven.doxia.module.confluence.parser.ChildBlocksBuilder;
/**
* <p>TreeListBuilder class.</p>
- *
- * @version $Id$
*/
public class TreeListBuilder
{
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableBlock.java
index 5df3ac2..1b0bd37 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableBlock.java
@@ -26,7 +26,7 @@ import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
- * @version $Id$
+ * TableBlock
*/
class TableBlock
extends AbstractFatherBlock
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableBlockParser.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableBlockParser.java
index 6c104a2..5904c1f 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableBlockParser.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableBlockParser.java
@@ -39,9 +39,8 @@ import org.codehaus.plexus.util.StringUtils;
/**
* Parse tables
- *
+ *
* @author Juan F. Codagnone
- * @version $Id$
*/
public class TableBlockParser
implements BlockParser
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableCellBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableCellBlock.java
index 7f61989..20b650e 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableCellBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableCellBlock.java
@@ -26,7 +26,7 @@ import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
- * @version $Id$
+ * TableCellBlock
*/
class TableCellBlock
extends AbstractFatherBlock
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableCellHeaderBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableCellHeaderBlock.java
index 86dce63..791f39a 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableCellHeaderBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableCellHeaderBlock.java
@@ -26,7 +26,7 @@ import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
- * @version $Id$
+ * TableCellHeaderBlock
*/
class TableCellHeaderBlock
extends AbstractFatherBlock
diff --git a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableRowBlock.java b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableRowBlock.java
index d814602..f537dee 100644
--- a/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableRowBlock.java
+++ b/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableRowBlock.java
@@ -26,7 +26,7 @@ import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
- * @version $Id$
+ * TableRowBlock
*/
class TableRowBlock
extends AbstractFatherBlock
diff --git a/doxia-modules/doxia-module-confluence/src/test/java/org/apache/maven/doxia/module/confluence/ConfluenceSinkTest.java b/doxia-modules/doxia-module-confluence/src/test/java/org/apache/maven/doxia/module/confluence/ConfluenceSinkTest.java
index 5e75bc1..4231f9b 100644
--- a/doxia-modules/doxia-module-confluence/src/test/java/org/apache/maven/doxia/module/confluence/ConfluenceSinkTest.java
+++ b/doxia-modules/doxia-module-confluence/src/test/java/org/apache/maven/doxia/module/confluence/ConfluenceSinkTest.java
@@ -29,7 +29,6 @@ import org.apache.maven.doxia.util.HtmlTools;
* Test the Confluence Sink
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @see ConfluenceSink
*/
public class ConfluenceSinkTest
diff --git a/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookParser.java b/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookParser.java
index 5267118..b92b393 100644
--- a/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookParser.java
+++ b/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookParser.java
@@ -39,7 +39,6 @@ import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
* and emit events into the specified doxia Sink.
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
* @since 1.0
*/
@Component( role = Parser.class, hint = "docbook" )
@@ -169,7 +168,9 @@ public class DocBookParser
IGNORABLE_ELEMENTS.add( SimplifiedDocbookMarkup.VOLUMENUM_TAG.toString() );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected void init()
{
super.init();
diff --git a/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSink.java b/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSink.java
index fb6cae7..b229835 100644
--- a/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSink.java
+++ b/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSink.java
@@ -50,7 +50,6 @@ import static org.apache.maven.doxia.util.HtmlTools.escapeHTML;
* It uses the Docbook v4.4 DTD <a href="http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd">
* http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd</a>.
*
- * @version $Id$
* @since 1.0
*/
public class DocBookSink
@@ -519,7 +518,9 @@ public class DocBookSink
init();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected void init()
{
hasTitle = false;
@@ -539,6 +540,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#DEFAULT_XML_PUBLIC_ID
* @see SimplifiedDocbookMarkup#DEFAULT_XML_SYSTEM_ID
* @see SimplifiedDocbookMarkup#ARTICLE_TAG
@@ -605,6 +607,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#ARTICLEINFO_TAG
*/
public void head_()
@@ -618,6 +621,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#ARTICLEINFO_TAG
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
@@ -630,6 +634,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void title_()
@@ -639,6 +644,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#CORPAUTHOR_TAG
*/
public void author()
@@ -649,6 +655,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#CORPAUTHOR_TAG
*/
public void author_()
@@ -659,6 +666,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#DATE_TAG
*/
public void date()
@@ -669,6 +677,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#DATE_TAG
*/
public void date_()
@@ -679,6 +688,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#ARTICLE_TAG
*/
public void body_()
@@ -690,6 +700,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#SIDEBAR_TAG
*/
public void sidebar()
@@ -699,6 +710,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#SIDEBAR_TAG
*/
public void sidebar_()
@@ -708,6 +720,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section1()
@@ -717,6 +730,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section1_()
@@ -726,6 +740,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section2()
@@ -735,6 +750,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section2_()
@@ -744,6 +760,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section3()
@@ -753,6 +770,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section3_()
@@ -762,6 +780,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section4()
@@ -771,6 +790,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section4_()
@@ -780,6 +800,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section5()
@@ -789,6 +810,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section5_()
@@ -798,6 +820,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle()
@@ -807,6 +830,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle_()
@@ -816,6 +840,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle1()
@@ -825,6 +850,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle1_()
@@ -834,6 +860,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle2()
@@ -843,6 +870,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle2_()
@@ -852,6 +880,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle3()
@@ -861,6 +890,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle3_()
@@ -870,6 +900,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle4()
@@ -879,6 +910,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle4_()
@@ -888,6 +920,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle5()
@@ -897,6 +930,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle5_()
@@ -906,6 +940,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#SECTIONINFO_TAG
*/
public void header()
@@ -915,6 +950,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#SECTIONINFO_TAG
*/
public void header_()
@@ -924,6 +960,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#ITEMIZEDLIST_TAG
*/
public void list()
@@ -934,6 +971,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#ITEMIZEDLIST_TAG
*/
public void list_()
@@ -943,6 +981,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#LISTITEM_TAG
*/
public void listItem()
@@ -953,6 +992,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#LISTITEM_TAG
*/
public void listItem_()
@@ -980,6 +1020,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#ORDEREDLIST_TAG
*/
public void numberedList_()
@@ -989,6 +1030,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#LISTITEM_TAG
*/
public void numberedListItem()
@@ -999,6 +1041,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#LISTITEM_TAG
*/
public void numberedListItem_()
@@ -1009,6 +1052,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#VARIABLELIST_TAG
*/
public void definitionList()
@@ -1019,6 +1063,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#VARIABLELIST_TAG
*/
public void definitionList_()
@@ -1028,6 +1073,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#VARLISTENTRY_TAG
*/
public void definitionListItem()
@@ -1037,6 +1083,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#VARLISTENTRY_TAG
*/
public void definitionListItem_()
@@ -1046,6 +1093,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#TERM_TAG
*/
public void definedTerm()
@@ -1055,6 +1103,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#TERM_TAG
*/
public void definedTerm_()
@@ -1064,6 +1113,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#LISTITEM_TAG
*/
public void definition()
@@ -1074,6 +1124,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#LISTITEM_TAG
*/
public void definition_()
@@ -1084,6 +1135,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#PARA_TAG
*/
public void paragraph()
@@ -1097,6 +1149,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#PARA_TAG
*/
public void paragraph_()
@@ -1121,6 +1174,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#PROGRAMLISTING_TAG
*/
public void verbatim_()
@@ -1129,25 +1183,33 @@ public class DocBookSink
verbatimFlag = false;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void horizontalRule()
{
markup( horizontalRuleElement );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void pageBreak()
{
markup( pageBreakElement );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void figure()
{
writeStartTag( SimplifiedDocbookMarkup.MEDIAOBJECT_TAG );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void figure_()
{
writeEndTag( SimplifiedDocbookMarkup.MEDIAOBJECT_TAG );
@@ -1206,6 +1268,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#FIGURE_TAG
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
@@ -1217,6 +1280,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#FIGURE_TAG
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
@@ -1226,7 +1290,9 @@ public class DocBookSink
writeEndTag( SimplifiedDocbookMarkup.CAPTION_TAG );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void table()
{
tableHasCaption = false;
@@ -1234,6 +1300,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#INFORMALTABLE_TAG
* @see SimplifiedDocbookMarkup#FRAME_ATTRIBUTE
* @see SimplifiedDocbookMarkup#ROWSEP_ATTRIBUTE
@@ -1325,6 +1392,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#TGROUP_TAG
* @see SimplifiedDocbookMarkup#TBODY_TAG
*/
@@ -1348,6 +1416,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#ROW_TAG
*/
public void tableRow()
@@ -1357,6 +1426,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#ROW_TAG
*/
public void tableRow_()
@@ -1366,6 +1436,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#ENTRY_TAG
*/
public void tableCell()
@@ -1375,6 +1446,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#ENTRY_TAG
*/
public void tableCell_()
@@ -1384,6 +1456,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#ENTRY_TAG
*/
public void tableHeaderCell()
@@ -1393,6 +1466,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#ENTRY_TAG
*/
public void tableHeaderCell_()
@@ -1402,6 +1476,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#TABLE_TAG
* @see SimplifiedDocbookMarkup#FRAME_ATTRIBUTE
* @see SimplifiedDocbookMarkup#ROWSEP_ATTRIBUTE
@@ -1437,6 +1512,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void tableCaption_()
@@ -1478,6 +1554,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#ANCHOR_TAG
*/
public void anchor_()
@@ -1519,6 +1596,7 @@ public class DocBookSink
/**
* {@inheritDoc}
+ *
* @see SimplifiedDocbookMarkup#ULINK_TAG
* @see SimplifiedDocbookMarkup#LINK_TAG
*/
@@ -1535,7 +1613,9 @@ public class DocBookSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void inline()
{
inline( null );
@@ -1575,7 +1655,9 @@ public class DocBookSink
inlineStack.push( tags );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void inline_()
{
for ( String tag: inlineStack.pop() )
@@ -1584,49 +1666,65 @@ public class DocBookSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void italic()
{
inline( SinkEventAttributeSet.Semantics.ITALIC );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void italic_()
{
inline_();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void bold()
{
inline( SinkEventAttributeSet.Semantics.BOLD );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void bold_()
{
inline_();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void monospaced()
{
inline( SinkEventAttributeSet.Semantics.CODE );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void monospaced_()
{
inline_();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void lineBreak()
{
markup( lineBreakElement );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void nonBreakingSpace()
{
markup( " " );
@@ -1735,13 +1833,17 @@ public class DocBookSink
// -----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void flush()
{
out.flush();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void close()
{
out.close();
diff --git a/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocbookMarkup.java b/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocbookMarkup.java
index 67aaf79..935cb45 100644
--- a/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocbookMarkup.java
+++ b/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocbookMarkup.java
@@ -29,7 +29,6 @@ import org.apache.maven.doxia.markup.XmlMarkup;
* remove full DocBook-only ones.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.0
* @deprecated This interface is incomplete and will be removed. Use {@link SimplifiedDocbookMarkup} instead.
*/
diff --git a/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocbookSinkFactory.java b/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocbookSinkFactory.java
index edadfed..0b15a1b 100644
--- a/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocbookSinkFactory.java
+++ b/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocbookSinkFactory.java
@@ -30,7 +30,6 @@ import org.codehaus.plexus.component.annotations.Component;
* Docbook implementation of the Sink factory.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.0
*/
@Component( role = SinkFactory.class, hint = "docbook" )
diff --git a/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocbookUtils.java b/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocbookUtils.java
index 5f38b41..4159fe9 100644
--- a/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocbookUtils.java
+++ b/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocbookUtils.java
@@ -25,7 +25,6 @@ import org.apache.maven.doxia.sink.Sink;
* Utility methods for Doxia Docbook Parser and Sink.
*
* @author ltheussl
- * @version $Id$
* @since 1.1.1
*/
public final class DocbookUtils
@@ -126,6 +125,7 @@ public final class DocbookUtils
* otherwise an IllegalArgumentException is thrown.</p>
*
* <p>The output is one of the style constants defined in {@link SimplifiedDocbookMarkup}.</p>
+ *
* @param numbering a doxia numbering style.
* @return a docbook ordered-list numbering style.
*/
diff --git a/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/SimplifiedDocbookMarkup.java b/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/SimplifiedDocbookMarkup.java
index 2feccab..fd64965 100644
--- a/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/SimplifiedDocbookMarkup.java
+++ b/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/SimplifiedDocbookMarkup.java
@@ -29,7 +29,6 @@ import org.apache.maven.doxia.markup.XmlMarkup;
* <a href="http://www.docbook.org/schemas/sdocbook/elements.html">Simplified DocBook DTD v. 1.1</a>.
*
* @author ltheussl
- * @version $Id$
* @since 1.1.1
*/
@SuppressWarnings( "checkstyle:interfaceistype" )
diff --git a/doxia-modules/doxia-module-docbook-simple/src/test/java/org/apache/maven/doxia/module/docbook/DocBookParserTest.java b/doxia-modules/doxia-module-docbook-simple/src/test/java/org/apache/maven/doxia/module/docbook/DocBookParserTest.java
index 8aaff87..5a9ed53 100644
--- a/doxia-modules/doxia-module-docbook-simple/src/test/java/org/apache/maven/doxia/module/docbook/DocBookParserTest.java
+++ b/doxia-modules/doxia-module-docbook-simple/src/test/java/org/apache/maven/doxia/module/docbook/DocBookParserTest.java
@@ -35,7 +35,6 @@ import org.codehaus.plexus.util.IOUtil;
/**
* @author <a href="mailto:lars@trieloff.net">Lars Trieloff</a>
- * @version $Id$
*/
public class DocBookParserTest extends AbstractParserTest
{
diff --git a/doxia-modules/doxia-module-docbook-simple/src/test/java/org/apache/maven/doxia/module/docbook/DocBookSinkTest.java b/doxia-modules/doxia-module-docbook-simple/src/test/java/org/apache/maven/doxia/module/docbook/DocBookSinkTest.java
index f7235fc..b414d98 100644
--- a/doxia-modules/doxia-module-docbook-simple/src/test/java/org/apache/maven/doxia/module/docbook/DocBookSinkTest.java
+++ b/doxia-modules/doxia-module-docbook-simple/src/test/java/org/apache/maven/doxia/module/docbook/DocBookSinkTest.java
@@ -35,7 +35,6 @@ import static org.apache.maven.doxia.util.HtmlTools.escapeHTML;
/**
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- * @version $Id$
*/
public class DocBookSinkTest extends AbstractSinkTest
{
diff --git a/doxia-modules/doxia-module-docbook-simple/src/test/java/org/apache/maven/doxia/module/docbook/DocbookUtilsTest.java b/doxia-modules/doxia-module-docbook-simple/src/test/java/org/apache/maven/doxia/module/docbook/DocbookUtilsTest.java
index 98a2533..befcfc8 100644
--- a/doxia-modules/doxia-module-docbook-simple/src/test/java/org/apache/maven/doxia/module/docbook/DocbookUtilsTest.java
+++ b/doxia-modules/doxia-module-docbook-simple/src/test/java/org/apache/maven/doxia/module/docbook/DocbookUtilsTest.java
@@ -28,7 +28,6 @@ import static org.junit.Assert.*;
* Test DocbookUtils.
*
* @author ltheussl
- * @version $Id$
*/
public class DocbookUtilsTest
{
diff --git a/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlContentParser.java b/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlContentParser.java
index a268d36..2cf0451 100644
--- a/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlContentParser.java
+++ b/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlContentParser.java
@@ -30,7 +30,6 @@ import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
* Parse Fml questions and answers, these may contain arbitrary xdoc elements.
*
* @author ltheussl
- * @version $Id$
* @since 1.0
*/
public class FmlContentParser
@@ -109,7 +108,9 @@ public class FmlContentParser
isEmptyElement = false;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected void init()
{
super.init();
diff --git a/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlMarkup.java b/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlMarkup.java
index e8ca5fa..7a2fa38 100644
--- a/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlMarkup.java
+++ b/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlMarkup.java
@@ -30,7 +30,6 @@ import org.apache.maven.doxia.markup.HtmlMarkup;
* as markups and custom tags.
*
* @author ltheussl
- * @version $Id$
* @since 1.0
*/
@SuppressWarnings( "checkstyle:interfaceistype" )
diff --git a/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlParser.java b/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlParser.java
index c1223d1..6fc121b 100644
--- a/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlParser.java
+++ b/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlParser.java
@@ -56,7 +56,6 @@ import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
*
* @author <a href="mailto:evenisse@codehaus.org">Emmanuel Venisse</a>
* @author ltheussl
- * @version $Id$
* @since 1.0
*/
@Component( role = Parser.class, hint = "fml" )
@@ -425,7 +424,9 @@ public class FmlParser
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected void init()
{
super.init();
diff --git a/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/module/fml/FmlParserTest.java b/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/module/fml/FmlParserTest.java
index 1eeb164..735c2f0 100644
--- a/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/module/fml/FmlParserTest.java
+++ b/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/module/fml/FmlParserTest.java
@@ -38,7 +38,6 @@ import org.codehaus.plexus.util.IOUtil;
/**
* @author <a href="mailto:evenisse@codehaus.org">Emmanuel Venisse</a>
- * @version $Id$
*/
public class FmlParserTest
extends AbstractParserTest
diff --git a/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/module/fml/FmlValidatorTest.java b/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/module/fml/FmlValidatorTest.java
index 7a51235..b301524 100644
--- a/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/module/fml/FmlValidatorTest.java
+++ b/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/module/fml/FmlValidatorTest.java
@@ -31,7 +31,6 @@ import org.codehaus.plexus.util.StringUtils;
* Test FML files with namespace.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.0
*/
public class FmlValidatorTest
diff --git a/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoAggregateSink.java b/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoAggregateSink.java
index 1c6df37..ec3b5dc 100644
--- a/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoAggregateSink.java
+++ b/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoAggregateSink.java
@@ -61,7 +61,6 @@ import org.codehaus.plexus.util.StringUtils;
* of them are used in this sink (i.e. author, confidential, date and title), the others are ignored.
*
* @author ltheussl
- * @version $Id$
* @since 1.1
*/
public class FoAggregateSink
@@ -144,9 +143,7 @@ public class FoAggregateSink
head( null );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void head( SinkEventAttributes attributes )
{
init();
@@ -171,9 +168,7 @@ public class FoAggregateSink
title( null );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void title( SinkEventAttributes attributes )
{
// ignored
@@ -195,9 +190,7 @@ public class FoAggregateSink
author( null );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void author( SinkEventAttributes attributes )
{
// ignored
@@ -219,9 +212,7 @@ public class FoAggregateSink
date( null );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void date( SinkEventAttributes attributes )
{
// ignored
@@ -243,9 +234,7 @@ public class FoAggregateSink
body( null );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void body( SinkEventAttributes attributes )
{
chapter++;
@@ -401,17 +390,13 @@ public class FoAggregateSink
//
// -----------------------------------------------------------------------
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void figureGraphics( String name )
{
figureGraphics( name, null );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void figureGraphics( String src, SinkEventAttributes attributes )
{
String anchor = src;
@@ -429,17 +414,13 @@ public class FoAggregateSink
super.figureGraphics( anchor, attributes );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void anchor( String name )
{
anchor( name, null );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void anchor( String name, SinkEventAttributes attributes )
{
if ( name == null )
@@ -467,17 +448,13 @@ public class FoAggregateSink
writeStartTag( INLINE_TAG, "id", anchor );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void link( String name )
{
link( name, null );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void link( String name, SinkEventAttributes attributes )
{
if ( name == null )
@@ -627,6 +604,7 @@ public class FoAggregateSink
//
// ----------------------------------------------------------------------
+ /** {@inheritDoc} */
@Override
protected void writeStartTag( Tag tag, String attributeId )
{
@@ -636,6 +614,7 @@ public class FoAggregateSink
}
}
+ /** {@inheritDoc} */
@Override
protected void writeStartTag( Tag tag, String id, String name )
{
@@ -645,6 +624,7 @@ public class FoAggregateSink
}
}
+ /** {@inheritDoc} */
@Override
protected void writeEndTag( Tag t )
{
@@ -654,6 +634,7 @@ public class FoAggregateSink
}
}
+ /** {@inheritDoc} */
@Override
protected void writeEmptyTag( Tag tag, String attributeId )
{
@@ -663,6 +644,7 @@ public class FoAggregateSink
}
}
+ /** {@inheritDoc} */
@Override
protected void write( String text )
{
@@ -672,6 +654,7 @@ public class FoAggregateSink
}
}
+ /** {@inheritDoc} */
@Override
protected void writeln( String text )
{
@@ -681,6 +664,7 @@ public class FoAggregateSink
}
}
+ /** {@inheritDoc} */
@Override
protected void content( String text )
{
@@ -764,12 +748,14 @@ public class FoAggregateSink
return "©" + actualYear + ", " + escaped( companyName, false ) + add;
}
+ /** {@inheritDoc} */
@Override
protected String getChapterString()
{
return chapter + ".";
}
+ /** {@inheritDoc} */
@Override
protected void regionBefore( String headerText )
{
@@ -800,6 +786,7 @@ public class FoAggregateSink
writeEndTag( STATIC_CONTENT_TAG );
}
+ /** {@inheritDoc} */
@Override
protected void regionAfter( String footerText )
{
@@ -815,6 +802,7 @@ public class FoAggregateSink
writeEndTag( STATIC_CONTENT_TAG );
}
+ /** {@inheritDoc} */
@Override
protected void chapterHeading( String headerText, boolean chapterNumber )
{
diff --git a/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoConfiguration.java b/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoConfiguration.java
index 9895eaa..ec9ffe6 100644
--- a/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoConfiguration.java
+++ b/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoConfiguration.java
@@ -35,7 +35,6 @@ import org.codehaus.plexus.util.ReaderFactory;
* A utility class to construct FO configuration parameters.
*
* @author ltheussl
- * @version $Id$
* @since 1.1
*/
public class FoConfiguration
diff --git a/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoMarkup.java b/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoMarkup.java
index 0c505f3..98d3892 100644
--- a/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoMarkup.java
+++ b/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoMarkup.java
@@ -27,7 +27,6 @@ import org.apache.maven.doxia.markup.XmlMarkup;
* List of <code>FO</code> markups.
*
* @author ltheussl
- * @version $Id$
* @since 1.1
*/
@SuppressWarnings( "checkstyle:interfaceistype" )
diff --git a/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoSink.java b/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoSink.java
index b5af267..1f2a5e0 100644
--- a/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoSink.java
+++ b/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoSink.java
@@ -60,7 +60,6 @@ import static org.apache.maven.doxia.util.HtmlTools.escapeHTML;
* </pre>
*
* @author ltheussl
- * @version $Id$
* @since 1.1
*/
public class FoSink
@@ -208,13 +207,17 @@ public class FoSink
startPageSequence( "0", null, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void head()
{
head( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void head_()
{
writeEOL();
@@ -226,13 +229,17 @@ public class FoSink
writeStartTag( BLOCK_TAG, "doc.header.title" );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void title()
{
title( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void title_()
{
writeEndTag( BLOCK_TAG );
@@ -245,13 +252,17 @@ public class FoSink
writeStartTag( BLOCK_TAG, "doc.header.author" );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void author()
{
author( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void author_()
{
writeEndTag( BLOCK_TAG );
@@ -264,13 +275,17 @@ public class FoSink
writeStartTag( BLOCK_TAG, "doc.header.date" );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void date()
{
date( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void date_()
{
writeEndTag( BLOCK_TAG );
@@ -283,13 +298,17 @@ public class FoSink
// noop
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void body()
{
body( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void body_()
{
writeEOL();
@@ -304,13 +323,17 @@ public class FoSink
//
// -----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle()
{
// nop
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle_()
{
// nop
@@ -356,121 +379,161 @@ public class FoSink
onSectionTitle_();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section1()
{
section( SECTION_LEVEL_1, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle1()
{
sectionTitle( SECTION_LEVEL_1, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle1_()
{
sectionTitle_( SECTION_LEVEL_1 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section1_()
{
section_( SECTION_LEVEL_1 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section2()
{
section( SECTION_LEVEL_2, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle2()
{
sectionTitle( SECTION_LEVEL_2, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle2_()
{
sectionTitle_( SECTION_LEVEL_2 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section2_()
{
section_( SECTION_LEVEL_2 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section3()
{
section( SECTION_LEVEL_3, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle3()
{
sectionTitle( SECTION_LEVEL_3, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle3_()
{
sectionTitle_( SECTION_LEVEL_3 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section3_()
{
section_( SECTION_LEVEL_3 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section4()
{
section( SECTION_LEVEL_4, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle4()
{
sectionTitle( SECTION_LEVEL_4, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle4_()
{
sectionTitle_( SECTION_LEVEL_4 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section4_()
{
section_( SECTION_LEVEL_4 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section5()
{
section( SECTION_LEVEL_5, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle5()
{
sectionTitle( SECTION_LEVEL_5, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle5_()
{
sectionTitle_( SECTION_LEVEL_5 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section5_()
{
section_( SECTION_LEVEL_5 );
@@ -570,13 +633,17 @@ public class FoSink
writeStartTag( LIST_BLOCK_TAG, "list" );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void list()
{
list( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void list_()
{
writeEndTag( LIST_BLOCK_TAG );
@@ -598,13 +665,17 @@ public class FoSink
writeStartTag( BLOCK_TAG );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void listItem()
{
listItem( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void listItem_()
{
writeEndTag( BLOCK_TAG );
@@ -629,7 +700,9 @@ public class FoSink
numberedList( numbering, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void numberedList_()
{
this.listStack.pop();
@@ -660,13 +733,17 @@ public class FoSink
writeStartTag( BLOCK_TAG );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void numberedListItem()
{
numberedListItem( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void numberedListItem_()
{
writeEndTag( BLOCK_TAG );
@@ -684,13 +761,17 @@ public class FoSink
writeStartTag( BLOCK_TAG, "dl" );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definitionList()
{
definitionList( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definitionList_()
{
writeEndTag( BLOCK_TAG );
@@ -703,13 +784,17 @@ public class FoSink
// nop
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definitionListItem()
{
definitionListItem( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definitionListItem_()
{
// nop
@@ -721,13 +806,17 @@ public class FoSink
writeStartTag( BLOCK_TAG, "dt" );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definedTerm()
{
definedTerm( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definedTerm_()
{
writeEndTag( BLOCK_TAG );
@@ -741,13 +830,17 @@ public class FoSink
writeStartTag( BLOCK_TAG, "dd" );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definition()
{
definition( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definition_()
{
writeEndTag( BLOCK_TAG );
@@ -762,13 +855,17 @@ public class FoSink
writeStartTag( BLOCK_TAG, "figure.display" );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void figure()
{
figure( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void figure_()
{
this.inFigure = false;
@@ -817,20 +914,26 @@ public class FoSink
writeStartTag( BLOCK_TAG, "figure.caption" );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void figureCaption()
{
figureCaption( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void figureCaption_()
{
writeEndTag( BLOCK_TAG );
writeEOL();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void paragraph()
{
paragraph( null );
@@ -850,14 +953,20 @@ public class FoSink
writeStartTag( BLOCK_TAG, atts );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void paragraph_()
{
writeEndTag( BLOCK_TAG );
writeEOL();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @param attributes a {@link org.apache.maven.doxia.sink.SinkEventAttributes} object.
+ */
public void verbatim( SinkEventAttributes attributes )
{
this.verbatim = true;
@@ -886,7 +995,9 @@ public class FoSink
verbatim( boxed ? SinkEventAttributeSet.BOXED : null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void verbatim_()
{
this.verbatim = false;
@@ -905,13 +1016,17 @@ public class FoSink
writeEOL();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void horizontalRule()
{
horizontalRule( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void pageBreak()
{
writeEmptyTag( BLOCK_TAG, "break-before", "page" );
@@ -931,13 +1046,17 @@ public class FoSink
writeStartTag( TABLE_TAG, "table.layout" );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void table()
{
table( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void table_()
{
String content = this.tableContentWriterStack.removeLast().toString();
@@ -983,7 +1102,9 @@ public class FoSink
writeStartTag( TABLE_BODY_TAG );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableRows_()
{
this.tableGridStack.removeLast();
@@ -1002,13 +1123,17 @@ public class FoSink
this.cellCountStack.addLast( 0 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableRow()
{
tableRow( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableRow_()
{
writeEndTag( TABLE_ROW_TAG );
@@ -1021,7 +1146,9 @@ public class FoSink
tableCell( false, attributes );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableCell()
{
tableCell( (SinkEventAttributes) null );
@@ -1040,7 +1167,9 @@ public class FoSink
tableCell( true, attributes );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableHeaderCell()
{
tableHeaderCell( (SinkEventAttributes) null );
@@ -1118,7 +1247,9 @@ public class FoSink
writeEOL();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableCell_()
{
writeEndTag( BLOCK_TAG );
@@ -1133,7 +1264,9 @@ public class FoSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableHeaderCell_()
{
tableCell_();
@@ -1153,13 +1286,17 @@ public class FoSink
// table-footer doesn't work because it has to be declared before table-body.
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableCaption()
{
tableCaption( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableCaption_()
{
if ( !this.tableCaptionXMLWriterStack.isEmpty() && this.tableCaptionXMLWriterStack.getLast() != null )
@@ -1200,7 +1337,9 @@ public class FoSink
anchor( name, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void anchor_()
{
writeEndTag( INLINE_TAG );
@@ -1250,14 +1389,18 @@ public class FoSink
link( name, null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void link_()
{
writeEndTag( INLINE_TAG );
writeEndTag( BASIC_LINK_TAG );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void inline()
{
inline( null );
@@ -1294,7 +1437,9 @@ public class FoSink
inlineStack.push( tags );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void inline_()
{
for ( Tag tag: inlineStack.pop() )
@@ -1303,37 +1448,49 @@ public class FoSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void italic()
{
inline( SinkEventAttributeSet.Semantics.ITALIC );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void italic_()
{
inline_();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void bold()
{
inline( SinkEventAttributeSet.Semantics.BOLD );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void bold_()
{
inline_();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void monospaced()
{
inline( SinkEventAttributeSet.Semantics.CODE );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void monospaced_()
{
inline_();
@@ -1347,13 +1504,17 @@ public class FoSink
writeSimpleTag( BLOCK_TAG );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void lineBreak()
{
lineBreak( null );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void nonBreakingSpace()
{
write( " " );
@@ -1377,13 +1538,17 @@ public class FoSink
write( text );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void flush()
{
out.flush();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void close()
{
out.close();
@@ -1736,7 +1901,11 @@ public class FoSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @param t a {@link javax.swing.text.html.HTML.Tag} object.
+ */
protected void writeEndTag( Tag t )
{
if ( this.tableCaptionXMLWriterStack.isEmpty() )
@@ -1856,7 +2025,9 @@ public class FoSink
warnMessages.put( key, set );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected void init()
{
super.init();
@@ -1878,4 +2049,4 @@ public class FoSink
this.inFigure = false;
this.warnMessages = null;
}
-}
\ No newline at end of file
+}
diff --git a/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoSinkFactory.java b/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoSinkFactory.java
index 6ed0363..940a46f 100644
--- a/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoSinkFactory.java
+++ b/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoSinkFactory.java
@@ -30,7 +30,6 @@ import org.codehaus.plexus.component.annotations.Component;
* FO implementation of the Sink factory.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.1
*/
@Component( role = SinkFactory.class, hint = "fo" )
diff --git a/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoUtils.java b/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoUtils.java
index c60c5f0..055be1c 100644
--- a/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoUtils.java
+++ b/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoUtils.java
@@ -48,7 +48,6 @@ import org.codehaus.plexus.util.StringUtils;
* <code>FO Sink</code> utilities.
*
* @author ltheussl
- * @version $Id$
* @since 1.1
*/
public class FoUtils
diff --git a/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/NumberedListItem.java b/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/NumberedListItem.java
index 3d01263..793a8d2 100644
--- a/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/NumberedListItem.java
+++ b/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/NumberedListItem.java
@@ -25,7 +25,6 @@ import org.apache.maven.doxia.sink.Sink;
* Used to count the position in a numbered list.
*
* @author ltheussl
- * @version $Id$
* @since 1.1
*/
public class NumberedListItem
diff --git a/doxia-modules/doxia-module-fo/src/test/java/org/apache/maven/doxia/module/fo/FoAggregateSinkTest.java b/doxia-modules/doxia-module-fo/src/test/java/org/apache/maven/doxia/module/fo/FoAggregateSinkTest.java
index d87e0fc..4ed6c6c 100644
--- a/doxia-modules/doxia-module-fo/src/test/java/org/apache/maven/doxia/module/fo/FoAggregateSinkTest.java
+++ b/doxia-modules/doxia-module-fo/src/test/java/org/apache/maven/doxia/module/fo/FoAggregateSinkTest.java
@@ -26,7 +26,6 @@ import org.codehaus.plexus.util.WriterFactory;
import org.junit.Before;
import org.junit.Test;
import org.xml.sax.SAXParseException;
-import org.xmlunit.matchers.CompareMatcher;
import javax.xml.transform.TransformerException;
import java.io.File;
@@ -42,7 +41,6 @@ import static org.xmlunit.matchers.CompareMatcher.isIdenticalTo;
* Test FoAggregateSink.
*
* @author ltheussl
- * @version $Id$
*/
public class FoAggregateSinkTest
{
diff --git a/doxia-modules/doxia-module-fo/src/test/java/org/apache/maven/doxia/module/fo/FoConfigurationTest.java b/doxia-modules/doxia-module-fo/src/test/java/org/apache/maven/doxia/module/fo/FoConfigurationTest.java
index cc8b689..464dac8 100644
--- a/doxia-modules/doxia-module-fo/src/test/java/org/apache/maven/doxia/module/fo/FoConfigurationTest.java
+++ b/doxia-modules/doxia-module-fo/src/test/java/org/apache/maven/doxia/module/fo/FoConfigurationTest.java
@@ -28,8 +28,6 @@ import static org.junit.Assert.*;
/**
* FoConfiguration tests.
- *
- * @version $Id$
*/
public class FoConfigurationTest
{
diff --git a/doxia-modules/doxia-module-fo/src/test/java/org/apache/maven/doxia/module/fo/FoSinkTest.java b/doxia-modules/doxia-module-fo/src/test/java/org/apache/maven/doxia/module/fo/FoSinkTest.java
index 9166362..fc22d6f 100644
--- a/doxia-modules/doxia-module-fo/src/test/java/org/apache/maven/doxia/module/fo/FoSinkTest.java
+++ b/doxia-modules/doxia-module-fo/src/test/java/org/apache/maven/doxia/module/fo/FoSinkTest.java
@@ -36,8 +36,6 @@ import static org.apache.maven.doxia.util.HtmlTools.escapeHTML;
/**
* <code>FO Sink</code> Test case.
- *
- * @version $Id$
*/
public class FoSinkTest
extends AbstractSinkTest
diff --git a/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextFont.java b/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextFont.java
index 75f0eac..a945870 100644
--- a/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextFont.java
+++ b/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextFont.java
@@ -31,9 +31,7 @@ import com.lowagie.text.pdf.BaseFont;
* <code>iText</code> wrapper object for font.
*
* @see com.lowagie.text.Font
- *
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class ITextFont
{
diff --git a/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextHeader.java b/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextHeader.java
index 2ab31da..c015a28 100644
--- a/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextHeader.java
+++ b/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextHeader.java
@@ -28,7 +28,6 @@ import java.util.Date;
* Header object containing meta-informations.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class ITextHeader
{
diff --git a/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextSink.java b/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextSink.java
index 92771c0..357d5e5 100644
--- a/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextSink.java
+++ b/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextSink.java
@@ -68,9 +68,7 @@ import org.codehaus.plexus.util.xml.XMLWriter;
* </ul>
*
* @see <a href="http://www.lowagie.com/iText/tutorial/ch07.html">http://www.lowagie.com/iText/tutorial/ch07.html</a>
- *
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class ITextSink
extends AbstractXmlSink
@@ -193,7 +191,9 @@ public class ITextSink
// Document
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void close()
{
IOUtil.close( writer );
@@ -201,7 +201,9 @@ public class ITextSink
init();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void flush()
{
if ( getLog().isWarnEnabled() && this.warnMessages != null )
@@ -222,13 +224,17 @@ public class ITextSink
// Header
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void head_()
{
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void head()
{
//init(); // why? this causes DOXIA-413
@@ -236,37 +242,49 @@ public class ITextSink
actionContext.setAction( SinkActionContext.HEAD );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void author_()
{
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void author()
{
actionContext.setAction( SinkActionContext.AUTHOR );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void date_()
{
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void date()
{
actionContext.setAction( SinkActionContext.DATE );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void title_()
{
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void title()
{
actionContext.setAction( SinkActionContext.TITLE );
@@ -276,7 +294,9 @@ public class ITextSink
// Body
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void body_()
{
if ( writeStart )
@@ -289,7 +309,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void body()
{
if ( writeStart )
@@ -345,19 +367,25 @@ public class ITextSink
// Sections
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle()
{
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle_()
{
actionContext.setAction( SinkActionContext.SECTION_TITLE );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section1_()
{
writeEndElement(); // ElementTags.SECTION
@@ -368,7 +396,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section1()
{
numberDepth++;
@@ -384,7 +414,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.SECTION_1 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle1_()
{
writeEndElement(); // ElementTags.TITLE
@@ -395,7 +427,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle1()
{
font.setSize( ITextFont.getSectionFontSize( 1 ) );
@@ -415,7 +449,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.SECTION_TITLE_1 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section2_()
{
writeEndElement(); // ElementTags.SECTION
@@ -426,7 +462,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section2()
{
numberDepth++;
@@ -442,7 +480,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.SECTION_2 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle2_()
{
writeEndElement(); // ElementTags.TITLE
@@ -453,7 +493,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle2()
{
font.setSize( ITextFont.getSectionFontSize( 2 ) );
@@ -473,7 +515,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.SECTION_TITLE_2 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section3_()
{
writeEndElement(); // ElementTags.SECTION
@@ -484,7 +528,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section3()
{
numberDepth++;
@@ -500,7 +546,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.SECTION_3 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle3_()
{
writeEndElement(); // ElementTags.TITLE
@@ -511,7 +559,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle3()
{
font.setSize( ITextFont.getSectionFontSize( 3 ) );
@@ -531,7 +581,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.SECTION_TITLE_3 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section4_()
{
writeEndElement(); // ElementTags.SECTION
@@ -542,7 +594,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section4()
{
numberDepth++;
@@ -558,7 +612,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.SECTION_4 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle4_()
{
writeEndElement(); // ElementTags.TITLE
@@ -569,7 +625,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle4()
{
font.setSize( ITextFont.getSectionFontSize( 4 ) );
@@ -589,7 +647,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.SECTION_TITLE_4 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section5_()
{
writeEndElement(); // ElementTags.SECTION
@@ -600,7 +660,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void section5()
{
numberDepth++;
@@ -616,7 +678,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.SECTION_5 );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle5_()
{
writeEndElement(); // ElementTags.TITLE
@@ -627,7 +691,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void sectionTitle5()
{
font.setSize( ITextFont.getSectionFontSize( 5 ) );
@@ -651,7 +717,9 @@ public class ITextSink
// Paragraph
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void paragraph_()
{
// Special case
@@ -667,7 +735,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void paragraph()
{
// Special case
@@ -689,7 +759,9 @@ public class ITextSink
// Lists
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void list_()
{
writeEndElement(); // ElementTags.LIST
@@ -699,7 +771,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void list()
{
writeStartElement( ElementTags.CHUNK );
@@ -717,7 +791,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.LIST );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void listItem_()
{
writeEndElement(); // ElementTags.LISTITEM
@@ -725,7 +801,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void listItem()
{
writeStartElement( ElementTags.LISTITEM );
@@ -734,7 +812,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.LIST_ITEM );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void numberedList_()
{
writeEndElement(); // ElementTags.LIST
@@ -790,7 +870,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.NUMBERED_LIST );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void numberedListItem_()
{
writeEndElement(); // ElementTags.LISTITEM
@@ -798,7 +880,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void numberedListItem()
{
writeStartElement( ElementTags.LISTITEM );
@@ -807,13 +891,17 @@ public class ITextSink
actionContext.setAction( SinkActionContext.NUMBERED_LIST_ITEM );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definitionList_()
{
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definitionList()
{
lineBreak();
@@ -821,7 +909,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.DEFINITION_LIST );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definedTerm_()
{
font.setSize( ITextFont.DEFAULT_FONT_SIZE );
@@ -834,7 +924,9 @@ public class ITextSink
lineBreak();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definedTerm()
{
font.setSize( ITextFont.DEFAULT_FONT_SIZE + 2 );
@@ -851,7 +943,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.DEFINED_TERM );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definition_()
{
writeEndElement(); // ElementTags.CHUNK
@@ -861,7 +955,9 @@ public class ITextSink
lineBreak();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definition()
{
writeStartElement( ElementTags.CHUNK );
@@ -889,13 +985,17 @@ public class ITextSink
actionContext.setAction( SinkActionContext.DEFINITION );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definitionListItem_()
{
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definitionListItem()
{
actionContext.setAction( SinkActionContext.DEFINITION_LIST_ITEM );
@@ -905,7 +1005,9 @@ public class ITextSink
// Tables
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void table_()
{
if ( tableCaptionXMLWriter != null )
@@ -934,7 +1036,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void table()
{
writeStartElement( ElementTags.CHUNK );
@@ -960,13 +1064,17 @@ public class ITextSink
actionContext.setAction( SinkActionContext.TABLE );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableCaption_()
{
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableCaption()
{
tableCaptionWriter = new StringWriter();
@@ -974,7 +1082,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.TABLE_CAPTION );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableCell_()
{
writeEndElement(); // ElementTags.CELL
@@ -982,7 +1092,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableCell()
{
writeStartElement( ElementTags.CELL );
@@ -1001,7 +1113,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.TABLE_CELL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableHeaderCell_()
{
writeEndElement(); // ElementTags.CELL
@@ -1009,7 +1123,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableHeaderCell()
{
writeStartElement( ElementTags.CELL );
@@ -1032,7 +1148,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.TABLE_HEADER_CELL );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableRow_()
{
writeEndElement(); // ElementTags.ROW
@@ -1040,7 +1158,9 @@ public class ITextSink
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableRow()
{
writeStartElement( ElementTags.ROW );
@@ -1048,7 +1168,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.TABLE_ROW );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void tableRows_()
{
//writeEndElement(); // ElementTags.TABLE
@@ -1069,7 +1191,9 @@ public class ITextSink
// Verbatim
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void verbatim_()
{
writeEndElement(); // ElementTags.CELL
@@ -1122,7 +1246,9 @@ public class ITextSink
// Figures
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void figure_()
{
writeEndElement(); // ElementTags.IMAGE
@@ -1134,7 +1260,9 @@ public class ITextSink
figureDefined = false;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void figure()
{
figureDefined = true;
@@ -1152,13 +1280,17 @@ public class ITextSink
actionContext.setAction( SinkActionContext.FIGURE );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void figureCaption_()
{
actionContext.release();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void figureCaption()
{
actionContext.setAction( SinkActionContext.FIGURE_CAPTION );
@@ -1274,7 +1406,9 @@ public class ITextSink
// Fonts
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void inline()
{
inline( null );
@@ -1311,7 +1445,9 @@ public class ITextSink
inlineStack.push( tags );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void inline_()
{
for ( String tag: inlineStack.pop() )
@@ -1331,37 +1467,49 @@ public class ITextSink
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void bold_()
{
inline_();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void bold()
{
inline( SinkEventAttributeSet.Semantics.BOLD );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void italic_()
{
inline_();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void italic()
{
inline( SinkEventAttributeSet.Semantics.ITALIC );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void monospaced_()
{
inline_();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void monospaced()
{
inline( SinkEventAttributeSet.Semantics.CODE );
@@ -1371,7 +1519,9 @@ public class ITextSink
// Links
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void link_()
{
writeEndElement(); // ElementTags.ANCHOR
@@ -1409,7 +1559,9 @@ public class ITextSink
actionContext.setAction( SinkActionContext.LINK );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void anchor_()
{
if ( !anchorDefined )
@@ -1464,7 +1616,9 @@ public class ITextSink
// Misc
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void lineBreak()
{
// Special case for the header
@@ -1479,20 +1633,26 @@ public class ITextSink
writeEndElement();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void nonBreakingSpace()
{
write( " " );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void pageBreak()
{
writeStartElement( ElementTags.NEWPAGE );
writeEndElement();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void horizontalRule()
{
writeStartElement( ElementTags.PARAGRAPH );
@@ -1647,7 +1807,9 @@ public class ITextSink
logMessage( "unknownEvent", msg );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected void init()
{
super.init();
@@ -1734,9 +1896,9 @@ public class ITextSink
}
/**
- * Convenience method to write a String
+ * {@inheritDoc}
*
- * @param aString
+ * Convenience method to write a String
*/
protected void write( String aString )
{
diff --git a/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextSinkFactory.java b/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextSinkFactory.java
index 948c386..1f4f680 100644
--- a/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextSinkFactory.java
+++ b/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextSinkFactory.java
@@ -32,7 +32,6 @@ import org.codehaus.plexus.util.xml.PrettyPrintXMLWriter;
* IText implementation of the Sink factory.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
* @since 1.0
*/
@Component( role = SinkFactory.class, hint = "itext" )
diff --git a/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextUtil.java b/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextUtil.java
index c82e0d8..7a0f2e4 100644
--- a/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextUtil.java
+++ b/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextUtil.java
@@ -35,7 +35,6 @@ import java.util.Locale;
* A set of util methods for the <code>iText</code> framework
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class ITextUtil
{
diff --git a/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/SinkActionContext.java b/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/SinkActionContext.java
index 7d7f1d7..4ae0228 100644
--- a/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/SinkActionContext.java
+++ b/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/SinkActionContext.java
@@ -25,7 +25,6 @@ import java.util.Stack;
* <p>SinkActionContext class.</p>
*
* @author Jason van Zyl
- * @version $Id$
*/
public class SinkActionContext
{
diff --git a/doxia-modules/doxia-module-itext/src/test/java/org/apache/maven/doxia/module/itext/ITextSinkTestCase.java b/doxia-modules/doxia-module-itext/src/test/java/org/apache/maven/doxia/module/itext/ITextSinkTestCase.java
index 533962f..ead71dd 100644
--- a/doxia-modules/doxia-module-itext/src/test/java/org/apache/maven/doxia/module/itext/ITextSinkTestCase.java
+++ b/doxia-modules/doxia-module-itext/src/test/java/org/apache/maven/doxia/module/itext/ITextSinkTestCase.java
@@ -35,7 +35,6 @@ import org.apache.maven.doxia.sink.impl.SinkTestDocument;
* <code>iText Sink</code> Test case.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class ITextSinkTestCase
extends AbstractModuleTest
diff --git a/doxia-modules/doxia-module-itext/src/test/java/org/apache/maven/doxia/module/itext/ITextUtilTest.java b/doxia-modules/doxia-module-itext/src/test/java/org/apache/maven/doxia/module/itext/ITextUtilTest.java
index 83013b9..50c4ae2 100644
--- a/doxia-modules/doxia-module-itext/src/test/java/org/apache/maven/doxia/module/itext/ITextUtilTest.java
+++ b/doxia-modules/doxia-module-itext/src/test/java/org/apache/maven/doxia/module/itext/ITextUtilTest.java
@@ -29,7 +29,6 @@ import static org.junit.Assert.assertTrue;
/**
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
- * @version $Id$
*/
public class ITextUtilTest
{
diff --git a/doxia-modules/doxia-module-latex/src/main/java/org/apache/maven/doxia/module/latex/LatexSink.java b/doxia-modules/doxia-module-latex/src/main/java/org/apache/maven/doxia/module/latex/LatexSink.java
index 86ea862..db13728 100644
--- a/doxia-modules/doxia-module-latex/src/main/java/org/apache/maven/doxia/module/latex/LatexSink.java
+++ b/doxia-modules/doxia-module-latex/src/main/java/org/apache/maven/doxia/module/latex/LatexSink.java
@@ -42,7 +42,6 @@ import java.util.Stack;
* <br>
* <b>Note</b>: The encoding used is UTF-8.
*
- * @version $Id$
* @since 1.0
*/
public class LatexSink
@@ -535,9 +534,7 @@ public class LatexSink
markup( EOL + "\\item " );
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
public void numberedList( int numbering )
{
numberedList( numbering, null );
@@ -656,7 +653,9 @@ public class LatexSink
markup( "}] " );
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definitionListItem()
{
definitionListItem( null );
@@ -668,13 +667,17 @@ public class LatexSink
// nop
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void definitionListItem_()
{
// nop
}
... 3635 lines suppressed ...