Author: vsiveton Date: Sat Aug 18 11:30:54 2007 New Revision: 567311 URL: http://svn.apache.org/viewvc?view=rev&rev=567311 Log: o fixed javadoc
Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/AbstractMacro.java maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/Macro.java maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroRequest.java maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/DefaultMacroManager.java maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroManager.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/parser/manager/DefaultParserManager.java maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserManager.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/test/java/org/apache/maven/doxia/parser/AbstractParserTestCase.java maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/sink/AbstractSinkTestCase.java Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/AbstractMacro.java URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/AbstractMacro.java?view=diff&rev=567311&r1=567310&r2=567311 ============================================================================== --- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/AbstractMacro.java (original) +++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/AbstractMacro.java Sat Aug 18 11:30:54 2007 @@ -20,10 +20,14 @@ */ /** + * Abstract base class to execute <code>Macro</code>. + * * @author <a href="mailto:[EMAIL PROTECTED]">Jason van Zyl</a> - * @version $Id:AbstractMacro.java 348605 2005-11-24 12:02:44 +1100 (Thu, 24 Nov 2005) brett $ + * @version $Id$ + * @since 1.0 */ public abstract class AbstractMacro implements Macro { + // nop } Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/Macro.java URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/Macro.java?view=diff&rev=567311&r1=567310&r2=567311 ============================================================================== --- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/Macro.java (original) +++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/Macro.java Sat Aug 18 11:30:54 2007 @@ -25,7 +25,8 @@ * Base interface of a macro. * * @author <a href="mailto:[EMAIL PROTECTED]">Jason van Zyl</a> - * @version $Id:Macro.java 348605 2005-11-24 12:02:44 +1100 (Thu, 24 Nov 2005) brett $ + * @version $Id$ + * @since 1.0 */ public interface Macro { @@ -42,5 +43,4 @@ */ void execute( Sink sink, MacroRequest request ) throws MacroExecutionException; - } Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroRequest.java URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroRequest.java?view=diff&rev=567311&r1=567310&r2=567311 ============================================================================== --- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroRequest.java (original) +++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroRequest.java Sat Aug 18 11:30:54 2007 @@ -24,7 +24,8 @@ /** * @author <a href="mailto:[EMAIL PROTECTED]">Jason van Zyl</a> - * @version $Id:MacroRequest.java 348605 2005-11-24 12:02:44 +1100 (Thu, 24 Nov 2005) brett $ + * @version $Id$ + * @since 1.0 */ public class MacroRequest { Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/DefaultMacroManager.java URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/DefaultMacroManager.java?view=diff&rev=567311&r1=567310&r2=567311 ============================================================================== --- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/DefaultMacroManager.java (original) +++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/DefaultMacroManager.java Sat Aug 18 11:30:54 2007 @@ -24,8 +24,11 @@ import java.util.Map; /** + * Default implementation of <code>MacroManager</code> + * * @author <a href="mailto:[EMAIL PROTECTED]">Jason van Zyl</a> - * @version $Id:DefaultMacroManager.java 348605 2005-11-24 12:02:44 +1100 (Thu, 24 Nov 2005) brett $ + * @version $Id$ + * @since 1.0 * @plexus.component */ public class DefaultMacroManager Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroManager.java URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroManager.java?view=diff&rev=567311&r1=567310&r2=567311 ============================================================================== --- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroManager.java (original) +++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroManager.java Sat Aug 18 11:30:54 2007 @@ -25,7 +25,8 @@ * Handles MacroManager lookups. * * @author <a href="mailto:[EMAIL PROTECTED]">Jason van Zyl</a> - * @version $Id:MacroManager.java 348605 2005-11-24 12:02:44 +1100 (Thu, 24 Nov 2005) brett $ + * @version $Id$ + * @since 1.0 */ public interface MacroManager { 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?view=diff&rev=567311&r1=567310&r2=567311 ============================================================================== --- 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 Sat Aug 18 11:30:54 2007 @@ -24,7 +24,8 @@ * does not exist or could not be found. * * @author <a href="mailto:[EMAIL PROTECTED]">Jason van Zyl</a> - * @version $Id:MacroNotFoundException.java 348605 2005-11-24 12:02:44 +1100 (Thu, 24 Nov 2005) brett $ + * @version $Id$ + * @since 1.0 */ public class MacroNotFoundException extends Exception Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java?view=diff&rev=567311&r1=567310&r2=567311 ============================================================================== --- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java (original) +++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java Sat Aug 18 11:30:54 2007 @@ -24,10 +24,11 @@ import java.util.Map; /** - * Simple implementation of the ParserManager interface. + * Simple implementation of the <code>ParserManager</code> interface. * * @author <a href="mailto:[EMAIL PROTECTED]">Jason van Zyl</a> - * @version $Id:DefaultParserManager.java 348605 2005-11-24 12:02:44 +1100 (Thu, 24 Nov 2005) brett $ + * @version $Id$ + * @since 1.0 * @plexus.component */ public class DefaultParserManager Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserManager.java URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserManager.java?view=diff&rev=567311&r1=567310&r2=567311 ============================================================================== --- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserManager.java (original) +++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserManager.java Sat Aug 18 11:30:54 2007 @@ -25,7 +25,8 @@ * Handles parser lookups. * * @author <a href="mailto:[EMAIL PROTECTED]">Jason van Zyl</a> - * @version $Id:ParserManager.java 348605 2005-11-24 12:02:44 +1100 (Thu, 24 Nov 2005) brett $ + * @version $Id$ + * @since 1.0 */ public interface ParserManager { 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?view=diff&rev=567311&r1=567310&r2=567311 ============================================================================== --- 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 Sat Aug 18 11:30:54 2007 @@ -24,7 +24,8 @@ * does not exist or could not be found. * * @author <a href="mailto:[EMAIL PROTECTED]">Jason van Zyl</a> - * @version $Id:ParserNotFoundException.java 348605 2005-11-24 12:02:44 +1100 (Thu, 24 Nov 2005) brett $ + * @version $Id$ + * @since 1.0 */ public class ParserNotFoundException extends Exception Modified: maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/parser/AbstractParserTestCase.java URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/parser/AbstractParserTestCase.java?view=diff&rev=567311&r1=567310&r2=567311 ============================================================================== --- maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/parser/AbstractParserTestCase.java (original) +++ maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/parser/AbstractParserTestCase.java Sat Aug 18 11:30:54 2007 @@ -28,31 +28,32 @@ /** * Test the parsing of sample input files - * + * * @author <a href="mailto:[EMAIL PROTECTED]">Carlos Sanchez</a> * @author <a href="mailto:[EMAIL PROTECTED]">Emmanuel Venisse</a> - * @version $Id:AbstractParserTestCase.java 348605 2005-11-24 12:02:44 +1100 (Thu, 24 Nov 2005) brett $ + * @version $Id$ + * @since 1.0 */ public abstract class AbstractParserTestCase extends PlexusTestCase { /** * Parser to use to convert input to sink events - * + * * @return the parser to use */ protected abstract Parser getParser(); /** * Path of the model to test, relative to basedir - * + * * @return the relative path */ protected abstract String getDocument(); - + /** * Sink to write the output of the parsing - * + * * @return a SinkAdapter if not overridden */ protected Sink getSink() @@ -63,7 +64,7 @@ /** * Parse the model in the path specified by [EMAIL PROTECTED] #getDocument()}, * with parser from [EMAIL PROTECTED] #getParser()}, and output to sink from [EMAIL PROTECTED] #getSink()} - * + * * @throws Exception */ public void testParser() Modified: maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/sink/AbstractSinkTestCase.java URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/sink/AbstractSinkTestCase.java?view=diff&rev=567311&r1=567310&r2=567311 ============================================================================== --- maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/sink/AbstractSinkTestCase.java (original) +++ maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/sink/AbstractSinkTestCase.java Sat Aug 18 11:30:54 2007 @@ -31,7 +31,8 @@ /** * @author <a href="mailto:[EMAIL PROTECTED]">Jason van Zyl</a> - * @version $Id:AbstractSinkTestCase.java 348605 2005-11-24 12:02:44 +1100 (Thu, 24 Nov 2005) brett $ + * @version $Id$ + * @since 1.0 */ public abstract class AbstractSinkTestCase extends PlexusTestCase