Author: ltheussl
Date: Tue Jun 3 05:25:07 2008
New Revision: 662767
URL: http://svn.apache.org/viewvc?rev=662767&view=rev
Log:
Javadocs and formatting
Modified:
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroNotFoundException.java
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/module/site/manager/SiteModuleNotFoundException.java
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/XhtmlBaseParser.java
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserNotFoundException.java
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/PipelineSink.java
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/SinkUtils.java
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineSource.java
Modified:
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java?rev=662767&r1=662766&r2=662767&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java
(original)
+++
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java
Tue Jun 3 05:25:07 2008
@@ -45,9 +45,9 @@
* @param source A reader that provides the source document.
* @param parserId Identifier for the parser to use.
* @param sink A sink that consumes the Doxia events.
- * @throws ParserNotFoundException if no parser could be found
- * for the given id.
- * @throws ParseException if the model could not be parsed.
+ * @throws org.apache.maven.doxia.parser.manager.ParserNotFoundException
+ * if no parser could be found for the given id.
+ * @throws org.apache.maven.doxia.parser.ParseException if the model could
not be parsed.
*/
void parse( Reader source, String parserId, Sink sink )
throws ParserNotFoundException, ParseException;
@@ -57,8 +57,8 @@
*
* @param parserId Identifier for the parser to use.
* @return the parser defining by parserId.
- * @throws ParserNotFoundException if no parser could be found
- * for the given id.
+ * @throws org.apache.maven.doxia.parser.manager.ParserNotFoundException
+ * if no parser could be found for the given id.
*/
Parser getParser( String parserId )
throws ParserNotFoundException;
Modified:
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java?rev=662767&r1=662766&r2=662767&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java
(original)
+++
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java
Tue Jun 3 05:25:07 2008
@@ -22,6 +22,7 @@
import org.apache.maven.doxia.sink.Sink;
import java.util.Iterator;
+import org.apache.maven.doxia.sink.SinkEventAttributeSet;
/**
* A simple macro that prints out the key and value of some supplied
parameters.
@@ -37,7 +38,7 @@
/** [EMAIL PROTECTED] */
public void execute( Sink sink, MacroRequest request )
{
- sink.verbatim( true );
+ sink.verbatim( SinkEventAttributeSet.BOXED );
sink.text( "echo" + EOL );
Modified:
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroNotFoundException.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroNotFoundException.java?rev=662767&r1=662766&r2=662767&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroNotFoundException.java
(original)
+++
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroNotFoundException.java
Tue Jun 3 05:25:07 2008
@@ -30,6 +30,9 @@
public class MacroNotFoundException
extends Exception
{
+ /** serialVersionUID */
+ static final long serialVersionUID = 295967936746221567L;
+
/**
* Construct a new MacroNotFoundException with the specified detail
message.
*
Modified:
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java?rev=662767&r1=662766&r2=662767&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java
(original)
+++
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java
Tue Jun 3 05:25:07 2008
@@ -31,6 +31,7 @@
import java.net.URL;
import java.util.HashMap;
import java.util.Map;
+import org.apache.maven.doxia.sink.SinkEventAttributeSet;
/**
* A macro that prints out the content of a file or a URL.
@@ -123,7 +124,7 @@
if ( verbatim )
{
- sink.verbatim( true );
+ sink.verbatim( SinkEventAttributeSet.BOXED );
sink.text( snippet.toString() );
Modified:
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/module/site/manager/SiteModuleNotFoundException.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/module/site/manager/SiteModuleNotFoundException.java?rev=662767&r1=662766&r2=662767&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/module/site/manager/SiteModuleNotFoundException.java
(original)
+++
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/module/site/manager/SiteModuleNotFoundException.java
Tue Jun 3 05:25:07 2008
@@ -30,6 +30,9 @@
public class SiteModuleNotFoundException
extends Exception
{
+ /** serialVersionUID */
+ static final long serialVersionUID = 295967936746221567L;
+
/**
* Construct a new SiteModuleNotFoundException with the
* specified detail message.
Modified:
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java?rev=662767&r1=662766&r2=662767&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java
(original)
+++
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java
Tue Jun 3 05:25:07 2008
@@ -118,8 +118,8 @@
*
* @param parser A parser.
* @param sink the sink to receive the events.
- * @throws XmlPullParserException if there's a problem parsing the model
- * @throws MacroExecutionException if there's a problem executing a macro
+ * @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if
there's a problem parsing the model
+ * @throws org.apache.maven.doxia.macro.MacroExecutionException if there's
a problem executing a macro
*/
private void parseXml( XmlPullParser parser, Sink sink )
throws XmlPullParserException, MacroExecutionException
@@ -169,8 +169,8 @@
*
* @param parser A parser.
* @param sink the sink to receive the events.
- * @throws XmlPullParserException if there's a problem parsing the model
- * @throws MacroExecutionException if there's a problem executing a macro
+ * @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if
there's a problem parsing the model
+ * @throws org.apache.maven.doxia.macro.MacroExecutionException if there's
a problem executing a macro
*/
protected abstract void handleStartTag( XmlPullParser parser, Sink sink )
throws XmlPullParserException, MacroExecutionException;
@@ -180,8 +180,8 @@
*
* @param parser A parser.
* @param sink the sink to receive the events.
- * @throws XmlPullParserException if there's a problem parsing the model
- * @throws MacroExecutionException if there's a problem executing a macro
+ * @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if
there's a problem parsing the model
+ * @throws org.apache.maven.doxia.macro.MacroExecutionException if there's
a problem executing a macro
*/
protected abstract void handleEndTag( XmlPullParser parser, Sink sink )
throws XmlPullParserException, MacroExecutionException;
@@ -191,7 +191,7 @@
*
* @param parser A parser.
* @param sink the sink to receive the events.
- * @throws XmlPullParserException if there's a problem parsing the model
+ * @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if
there's a problem parsing the model
*/
protected abstract void handleText( XmlPullParser parser, Sink sink )
throws XmlPullParserException;
@@ -201,7 +201,7 @@
*
* @param parser A parser.
* @param sink the sink to receive the events.
- * @throws XmlPullParserException if there's a problem parsing the model
+ * @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if
there's a problem parsing the model
*/
protected abstract void handleCdsect( XmlPullParser parser, Sink sink )
throws XmlPullParserException;
@@ -211,7 +211,7 @@
*
* @param parser A parser.
* @param sink the sink to receive the events.
- * @throws XmlPullParserException if there's a problem parsing the model
+ * @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if
there's a problem parsing the model
*/
protected abstract void handleComment( XmlPullParser parser, Sink sink )
throws XmlPullParserException;
@@ -221,7 +221,7 @@
*
* @param parser A parser.
* @param sink the sink to receive the events.
- * @throws XmlPullParserException if there's a problem parsing the model
+ * @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if
there's a problem parsing the model
*/
protected abstract void handleEntity( XmlPullParser parser, Sink sink )
throws XmlPullParserException;
Modified:
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/XhtmlBaseParser.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/XhtmlBaseParser.java?rev=662767&r1=662766&r2=662767&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/XhtmlBaseParser.java
(original)
+++
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/XhtmlBaseParser.java
Tue Jun 3 05:25:07 2008
@@ -818,7 +818,7 @@
/**
* Checks if the given id is a valid Doxia id and if not, returns a
transformed one.
*
- * @param The id to validate.
+ * @param id The id to validate.
* @return A transformed id or the original id if it was already valid.
* @see DoxiaUtils#encodeId(String)
*/
Modified:
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserNotFoundException.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserNotFoundException.java?rev=662767&r1=662766&r2=662767&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserNotFoundException.java
(original)
+++
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserNotFoundException.java
Tue Jun 3 05:25:07 2008
@@ -30,6 +30,9 @@
public class ParserNotFoundException
extends Exception
{
+ /** serialVersionUID */
+ static final long serialVersionUID = 295967936746221567L;
+
/**
* Construct a new ParserNotFoundException with the specified detail
message.
*
Modified:
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/PipelineSink.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/PipelineSink.java?rev=662767&r1=662766&r2=662767&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/PipelineSink.java
(original)
+++
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/PipelineSink.java
Tue Jun 3 05:25:07 2008
@@ -22,10 +22,13 @@
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
+
import java.util.List;
import java.util.Iterator;
/**
+ * May be used to invoke the same method on a List of Sinks.
+ *
* @author <a href="mailto:[EMAIL PROTECTED]">Trygve Laugstøl</a>
* @version $Id$
*/
@@ -34,16 +37,35 @@
{
private List pipeline;
+ /**
+ * Constructs a PipelineSink for a given List of Sinks.
+ *
+ * @param pipeline A List of Sinks.
+ */
public PipelineSink( List pipeline )
{
this.pipeline = pipeline;
}
+ /**
+ * Add a Sink to the List of Sinks.
+ *
+ * @param sink the Sink to add.
+ */
public void addSink( Sink sink )
{
pipeline.add( sink );
}
+ /**
+ * Invoke a Method on this PipelineSink.
+ *
+ * @param proxy the proxy instance that the method was invoked on. Unused.
+ * @param method the Method to invoke.
+ * @param args an array of arguments to the Method.
+ * @return always returns null.
+ * @throws java.lang.Throwable the Exception to throw from the Method
invocation.
+ */
public Object invoke( Object proxy, Method method, Object[] args )
throws Throwable
{
@@ -57,6 +79,12 @@
return null;
}
+ /**
+ * Returns an instance of a PipelineSink as a Sink.
+ *
+ * @param pipeline A List of Sinks.
+ * @return
+ */
public static Sink newInstance( List pipeline )
{
return (Sink) Proxy.newProxyInstance(
PipelineSink.class.getClassLoader(),
Modified:
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/SinkUtils.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/SinkUtils.java?rev=662767&r1=662766&r2=662767&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/SinkUtils.java
(original)
+++
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/SinkUtils.java
Tue Jun 3 05:25:07 2008
@@ -27,7 +27,6 @@
import javax.swing.text.MutableAttributeSet;
import org.apache.maven.doxia.markup.Markup;
-import org.apache.maven.doxia.sink.SinkEventAttributeSet;
/**
* Collection of common utility methods for sinks.
Modified:
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java?rev=662767&r1=662766&r2=662767&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java
(original)
+++
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java
Tue Jun 3 05:25:07 2008
@@ -99,7 +99,7 @@
}
catch ( IOException e )
{
- throw new ParseException( e );
+ throw new ParseException( e, lineNumber, 0 );
}
lastLine = line;
Modified:
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineSource.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineSource.java?rev=662767&r1=662766&r2=662767&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineSource.java
(original)
+++
maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineSource.java
Tue Jun 3 05:25:07 2008
@@ -31,7 +31,7 @@
{
/**
* @return the next line. <code>null</code> if we reached the end.
- * @throws ParseException on I/O error
+ * @throws org.apache.maven.doxia.parser.ParseException on I/O error
*/
String getNextLine() throws ParseException;
@@ -46,7 +46,7 @@
int getLineNumber();
/**
- * @throws IllegalStateException if the ungetLine/unget is called more than
+ * @throws java.lang.IllegalStateException if the ungetLine/unget is
called more than
* one time without calling getNextLine()
*/
void ungetLine() throws IllegalStateException;
@@ -54,7 +54,7 @@
/**
* @param s some text to push back to the parser
- * @throws IllegalStateException if the ungetLine/unget is called more than
+ * @throws java.lang.IllegalStateException if the ungetLine/unget is
called more than
* one time without calling getNextLine()
*/
void unget( String s ) throws IllegalStateException;
