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:25:51 UTC
svn commit: r746982 - in
/maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt:
AptParser.java AptReaderSource.java AptSink.java AptSiteModule.java
AptSource.java
Author: vsiveton
Date: Mon Feb 23 12:25:50 2009
New Revision: 746982
URL: http://svn.apache.org/viewvc?rev=746982&view=rev
Log:
o fix javadoc using javadoc:fix
Modified:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptReaderSource.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSiteModule.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSource.java
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java?rev=746982&r1=746981&r2=746982&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java Mon Feb 23 12:25:50 2009
@@ -247,7 +247,7 @@
/**
* Parse the next line of the Apt source document.
*
- * @throws AptParseException if something goes wrong.
+ * @throws org.apache.maven.doxia.module.apt.AptParseException if something goes wrong.
*/
protected void nextLine()
throws AptParseException
@@ -262,7 +262,7 @@
* @param begin offset.
* @param end offset.
* @param sink the sink to receive the events.
- * @throws AptParseException if something goes wrong.
+ * @throws org.apache.maven.doxia.module.apt.AptParseException if something goes wrong.
*/
protected void doTraverseText( String text, int begin, int end, Sink sink )
throws AptParseException
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptReaderSource.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptReaderSource.java?rev=746982&r1=746981&r2=746982&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptReaderSource.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptReaderSource.java Mon Feb 23 12:25:50 2009
@@ -25,7 +25,11 @@
import org.codehaus.plexus.util.IOUtil;
-/** Reader for apt source documents. */
+/**
+ * Reader for apt source documents.
+ *
+ * @version $Id$
+ */
public class AptReaderSource
implements AptSource
{
@@ -92,7 +96,9 @@
return lineNumber;
}
- /** Closes the reader associated with this AptReaderSource. */
+ /**
+ * Closes the reader associated with this AptReaderSource.
+ */
public void close()
{
IOUtil.close( reader );
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java?rev=746982&r1=746981&r2=746982&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java Mon Feb 23 12:25:50 2009
@@ -878,11 +878,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-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSiteModule.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSiteModule.java?rev=746982&r1=746981&r2=746982&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSiteModule.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSiteModule.java Mon Feb 23 12:25:50 2009
@@ -22,6 +22,8 @@
import org.apache.maven.doxia.module.site.AbstractSiteModule;
/**
+ * <p>AptSiteModule class.</p>
+ *
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @version $Id$
* @since 1.0
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSource.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSource.java?rev=746982&r1=746981&r2=746982&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSource.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSource.java Mon Feb 23 12:25:50 2009
@@ -19,14 +19,18 @@
* under the License.
*/
-/** An interface to read apt source documents. */
+/**
+ * An interface to read apt source documents.
+ *
+ * @version $Id$
+ */
public interface AptSource
{
/**
* Returns a line of the apt source document.
*
* @return a line of the apt source.
- * @throws AptParseException if the document can't be parsed.
+ * @throws org.apache.maven.doxia.module.apt.AptParseException if the document can't be parsed.
*/
String getNextLine()
throws AptParseException;