You are viewing a plain text version of this content. The canonical link for it is here.
Posted to doxia-commits@maven.apache.org by vs...@apache.org on 2009/02/23 13:30:23 UTC
svn commit: r746987 - in
/maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo:
FoAggregateSink.java FoSink.java FoUtils.java NumberedListItem.java
Author: vsiveton
Date: Mon Feb 23 12:30:21 2009
New Revision: 746987
URL: http://svn.apache.org/viewvc?rev=746987&view=rev
Log:
o fix javadoc using javadoc:fix
Modified:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoAggregateSink.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoSink.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoUtils.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/NumberedListItem.java
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoAggregateSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoAggregateSink.java?rev=746987&r1=746986&r2=746987&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoAggregateSink.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoAggregateSink.java Mon Feb 23 12:30:21 2009
@@ -403,10 +403,9 @@
// ----------------------------------------------------------------------
/**
- * Writes a start tag, prepending EOL.
+ * {@inheritDoc}
*
- * @param tag The tag.
- * @param attributeId An id identifying the attribute set.
+ * Writes a start tag, prepending EOL.
*/
protected void writeStartTag( Tag tag, String attributeId )
{
@@ -417,11 +416,9 @@
}
/**
- * Writes a start tag, prepending EOL.
+ * {@inheritDoc}
*
- * @param tag The tag.
- * @param id An id to add.
- * @param name The name (value) of the id.
+ * Writes a start tag, prepending EOL.
*/
protected void writeStartTag( Tag tag, String id, String name )
{
@@ -432,9 +429,9 @@
}
/**
- * Writes an end tag, appending EOL.
+ * {@inheritDoc}
*
- * @param tag The tag.
+ * Writes an end tag, appending EOL.
*/
protected void writeEndTag( Tag tag )
{
@@ -445,10 +442,9 @@
}
/**
- * Writes a simple tag, appending EOL.
+ * {@inheritDoc}
*
- * @param tag The tag.
- * @param attributeId An id identifying the attribute set.
+ * Writes a simple tag, appending EOL.
*/
protected void writeEmptyTag( Tag tag, String attributeId )
{
@@ -459,9 +455,9 @@
}
/**
- * Writes a text, swallowing any exceptions.
+ * {@inheritDoc}
*
- * @param text The text to write.
+ * Writes a text, swallowing any exceptions.
*/
protected void write( String text )
{
@@ -472,9 +468,9 @@
}
/**
- * Writes a text, appending EOL.
+ * {@inheritDoc}
*
- * @param text The text to write.
+ * Writes a text, appending EOL.
*/
protected void writeln( String text )
{
@@ -485,9 +481,9 @@
}
/**
- * Writes content, escaping special characters.
+ * {@inheritDoc}
*
- * @param text The text to write.
+ * Writes content, escaping special characters.
*/
protected void content( String text )
{
@@ -497,7 +493,9 @@
}
}
- /** Writes EOL. */
+ /**
+ * Writes EOL.
+ */
protected void newline()
{
if ( !ignoreText )
@@ -547,9 +545,9 @@
}
/**
- * Returns the current chapter number as a string.
+ * {@inheritDoc}
*
- * @return String
+ * Returns the current chapter number as a string.
*/
protected String getChapterString()
{
@@ -557,9 +555,9 @@
}
/**
- * Writes a 'xsl-region-before' block.
+ * {@inheritDoc}
*
- * @param headerText The text to write in the header, if null, nothing is written.
+ * Writes a 'xsl-region-before' block.
*/
protected void regionBefore( String headerText )
{
@@ -591,9 +589,9 @@
}
/**
- * Writes a 'xsl-region-after' block.
+ * {@inheritDoc}
*
- * @param footerText The text to write in the footer, if null, nothing is written.
+ * Writes a 'xsl-region-after' block.
*/
protected void regionAfter( String footerText )
{
@@ -610,10 +608,9 @@
}
/**
- * Writes a chapter heading.
+ * {@inheritDoc}
*
- * @param headerText The text to write in the header, if null, the current document title is written.
- * @param chapterNumber True if the chapter number should be written in front of the text.
+ * Writes a chapter heading.
*/
protected void chapterHeading( String headerText, boolean chapterNumber )
{
@@ -720,6 +717,8 @@
}
/**
+ * {@inheritDoc}
+ *
* Writes a fo:bookmark-tree. The DocumentModel has to contain a DocumentTOC for this to work.
*/
protected void pdfBookmarks()
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoSink.java?rev=746987&r1=746986&r2=746987&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoSink.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoSink.java Mon Feb 23 12:30:21 2009
@@ -1041,11 +1041,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 )
@@ -1210,9 +1208,9 @@
}
/**
- * Writes a text, swallowing any exceptions.
+ * {@inheritDoc}
*
- * @param text The text to write.
+ * Writes a text, swallowing any exceptions.
*/
protected void write( String text )
{
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoUtils.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoUtils.java?rev=746987&r1=746986&r2=746987&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoUtils.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoUtils.java Mon Feb 23 12:30:21 2009
@@ -58,7 +58,7 @@
* @param pdf the target PDF file.
* @param resourceDir The base directory for relative path resolution.
* If null, defaults to the parent directory of fo.
- * @throws TransformerException In case of a conversion problem.
+ * @throws javax.xml.transform.TransformerException In case of a conversion problem.
*/
public static void convertFO2PDF( File fo, File pdf, String resourceDir )
throws TransformerException
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/NumberedListItem.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/NumberedListItem.java?rev=746987&r1=746986&r2=746987&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/NumberedListItem.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/NumberedListItem.java Mon Feb 23 12:30:21 2009
@@ -114,7 +114,9 @@
return format;
}
- /** Increase the current count by 1. */
+ /**
+ * Increase the current count by 1.
+ */
public void next()
{
count++;