Author: vsiveton
Date: Wed Feb 25 13:55:23 2009
New Revision: 747780
URL: http://svn.apache.org/viewvc?rev=747780&view=rev
Log:
o fixed @since due to a bug in javadoc:fix
Modified:
maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/BookDoxia.java
maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/latex/LatexBookSink.java
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/ParseException.java
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractSink.java
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractTextSink.java
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractXmlSink.java
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSink.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextSink.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiParser.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSink.java
Modified: maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/BookDoxia.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/BookDoxia.java?rev=747780&r1=747779&r2=747780&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/BookDoxia.java
(original)
+++ maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/BookDoxia.java
Wed Feb 25 13:55:23 2009
@@ -71,6 +71,7 @@
* @param inputEncoding the input encoding when processing {@link files}.
* @param outputEncoding the output encoding when writing files in {@link ouputDirectory}.
* @throws org.apache.maven.doxia.book.BookDoxiaException if the model cannot be loaded.
+ * @since 1.1
*/
void renderBook( BookModel book, String bookRendererId, List files, File outputDirectory,
Locale locale,
String inputEncoding, String outputEncoding )
Modified: maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/latex/LatexBookSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/latex/LatexBookSink.java?rev=747780&r1=747779&r2=747780&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/latex/LatexBookSink.java
(original)
+++ maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/latex/LatexBookSink.java
Wed Feb 25 13:55:23 2009
@@ -110,6 +110,8 @@
/**
* Writes the default LaTeX commands and preamble in the main book file.
+ *
+ * @since 1.1
*/
public void defaultBookPreamble()
{
Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java?rev=747780&r1=747779&r2=747780&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java
Wed Feb 25 13:55:23 2009
@@ -104,6 +104,7 @@
* @param string A string that provides the source input.
* @param sink A sink that consumes the Doxia events.
* @throws org.apache.maven.doxia.parser.ParseException if the string could not be parsed.
+ * @since 1.1
*/
public void parse( String string, Sink sink )
throws ParseException
Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/ParseException.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/ParseException.java?rev=747780&r1=747779&r2=747780&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/ParseException.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/ParseException.java
Wed Feb 25 13:55:23 2009
@@ -79,6 +79,7 @@
* This can later be retrieved by the getLineNumber() method.
* @param column The column number where the parsing failed.
* This can later be retrieved by the getColumnNumber() method.
+ * @since 1.1
*/
public ParseException( String message, int line, int column )
{
@@ -97,6 +98,7 @@
* This can later be retrieved by the getLineNumber() method.
* @param column The column number where the parsing failed.
* This can later be retrieved by the getColumnNumber() method.
+ * @since 1.1
*/
public ParseException( String message, Exception e, int line, int column )
{
@@ -126,6 +128,7 @@
* This can later be retrieved by the getLineNumber() method.
* @param column The column number where the parsing failed.
* This can later be retrieved by the getColumnNumber() method.
+ * @since 1.1
*/
public ParseException( Exception e, int line, int column )
{
@@ -181,6 +184,7 @@
* This can later be retrieved by the getLineNumber() method.
* @param column The column number where the parsing failed.
* This can later be retrieved by the getColumnNumber() method.
+ * @since 1.1
*/
public ParseException( Exception e, String message, String file, int line, int column
)
{
Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractSink.java?rev=747780&r1=747779&r2=747780&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractSink.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractSink.java
Wed Feb 25 13:55:23 2009
@@ -47,7 +47,6 @@
* If no logger has been configured, a new SystemStreamLog is returned.
*
* @return Log
- * @since 1.1
*/
protected Log getLog()
{
Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractTextSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractTextSink.java?rev=747780&r1=747779&r2=747780&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractTextSink.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractTextSink.java
Wed Feb 25 13:55:23 2009
@@ -26,7 +26,6 @@
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @version $Id$
- * @since 1.1
*/
public abstract class AbstractTextSink
extends SinkAdapter
Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractXmlSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractXmlSink.java?rev=747780&r1=747779&r2=747780&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractXmlSink.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractXmlSink.java
Wed Feb 25 13:55:23 2009
@@ -130,6 +130,8 @@
/**
* Writes a system EOL.
+ *
+ * @since 1.1
*/
protected void writeEOL()
{
Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java?rev=747780&r1=747779&r2=747780&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
Wed Feb 25 13:55:23 2009
@@ -116,6 +116,7 @@
* @param text The String to escape, may be null.
* @param xmlMode set to <code>false</code> to replace non-ascii characters.
* @return The escaped text or the empty string if text == null.
+ * @since 1.1
*/
public static final String escapeHTML( String text, boolean xmlMode )
{
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSink.java?rev=747780&r1=747779&r2=747780&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSink.java
(original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSink.java
Wed Feb 25 13:55:23 2009
@@ -186,6 +186,7 @@
* @param languageId language identifier for the root element as defined by
* <a href="ftp://ftp.isi.edu/in-notes/bcp/bcp47.txt">IETF BCP 47</a>, Tags
for the Identification of Languages;
* in addition, the empty string may be specified.
+ * @since 1.1
*/
protected DocBookSink( Writer writer, String encoding, String languageId )
{
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextSink.java?rev=747780&r1=747779&r2=747780&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextSink.java
(original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextSink.java
Wed Feb 25 13:55:23 2009
@@ -104,6 +104,8 @@
private String tableCaption = null;
/**
+ * <p>Constructor for ITextSink.</p>
+ *
* @param writer
*/
protected ITextSink( Writer writer )
@@ -112,8 +114,11 @@
}
/**
+ * <p>Constructor for ITextSink.</p>
+ *
* @param writer
* @param encoding
+ * @since 1.1
*/
protected ITextSink( Writer writer, String encoding )
{
@@ -124,6 +129,8 @@
}
/**
+ * <p>Constructor for ITextSink.</p>
+ *
* @param xmlWriter
*/
protected ITextSink( PrettyPrintXMLWriter xmlWriter )
@@ -1658,11 +1665,9 @@
}
/**
- * Unkown events just log a warning message but are ignored otherwise.
+ * {@inheritDoc}
*
- * @param name The name of the event.
- * @param requiredParams not used.
- * @param attributes not used.
+ * Unkown events just log a warning message but are ignored otherwise.
* @see org.apache.maven.doxia.sink.Sink#unknown(String,Object[],SinkEventAttributes)
*/
public void unknown( String name, Object[] requiredParams, SinkEventAttributes attributes
)
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiParser.java?rev=747780&r1=747779&r2=747780&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiParser.java
(original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiParser.java
Wed Feb 25 13:55:23 2009
@@ -192,6 +192,7 @@
* @param blocks blocks to parse
* @param source source to parse
* @return a title for a page
+ * @since 1.1
*/
public final String getTitle( final List blocks, final ByLineSource source )
{
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSink.java?rev=747780&r1=747779&r2=747780&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSink.java
(original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocSink.java
Wed Feb 25 13:55:23 2009
@@ -77,6 +77,7 @@
* @param writer not null writer to write the result.
* @param encoding the encoding used, that should be written to the generated HTML content
* if not <code>null</code>.
+ * @since 1.1
*/
protected XdocSink( Writer writer, String encoding )
{
@@ -93,6 +94,7 @@
* @param languageId language identifier for the root element as defined by
* <a href="ftp://ftp.isi.edu/in-notes/bcp/bcp47.txt">IETF BCP 47</a>, Tags
for the Identification of Languages;
* in addition, the empty string may be specified.
+ * @since 1.1
*/
protected XdocSink( Writer writer, String encoding, String languageId )
{
|