Author: ltheussl
Date: Thu Aug 16 08:01:27 2007
New Revision: 566741
URL: http://svn.apache.org/viewvc?view=rev&rev=566741
Log:
Fix javadoc warnings
Modified:
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/module/site/manager/SiteModuleNotFoundException.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/parser/manager/ParserNotFoundException.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-core/src/test/java/org/apache/maven/doxia/module/AbstractIdentityTest.java
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=566741&r1=566740&r2=566741
==============================================================================
---
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
Thu Aug 16 08:01:27 2007
@@ -41,8 +41,8 @@
}
/**
- * Constructs a new MacroNotFoundException with the specified cause
- * and a detail message of (cause == null ? null : cause.toString() ).
+ * Constructs a new MacroNotFoundException with the specified cause.
+ * The error message is (cause == null ? null : cause.toString() ).
*
* @param cause the cause. This can be retrieved later by the
* Throwable.getCause() method. (A null value is permitted, and indicates
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?view=diff&rev=566741&r1=566740&r2=566741
==============================================================================
---
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
Thu Aug 16 08:01:27 2007
@@ -43,8 +43,8 @@
}
/**
- * Constructs a new SiteModuleNotFoundException with the specified cause
- * and a detail message of (cause == null ? null : cause.toString() ).
+ * Constructs a new SiteModuleNotFoundException with the specified cause.
+ * The error message is (cause == null ? null : cause.toString() ).
*
* @param cause the cause. This can be retrieved later by the
* Throwable.getCause() method. (A null value is permitted, and indicates
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?view=diff&rev=566741&r1=566740&r2=566741
==============================================================================
---
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
Thu Aug 16 08:01:27 2007
@@ -64,7 +64,7 @@
}
/**
- * Constructs a new exception with the specified cause and a detail
message of
+ * Constructs a new exception with the specified cause. The error message
is
* (cause == null ? null : cause.toString() ).
*
* @param e the cause. This can be retrieved later by the
Throwable.getCause() method.
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=566741&r1=566740&r2=566741
==============================================================================
---
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
Thu Aug 16 08:01:27 2007
@@ -41,8 +41,8 @@
}
/**
- * Constructs a new exception with the specified cause and a detail
- * message of (cause == null ? null : cause.toString() ).
+ * Constructs a new exception with the specified cause. The error
+ * message is (cause == null ? null : cause.toString() ).
*
* @param cause the cause. This can be retrieved later by the
* Throwable.getCause() method. (A null value is permitted, and indicates
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?view=diff&rev=566741&r1=566740&r2=566741
==============================================================================
---
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
Thu Aug 16 08:01:27 2007
@@ -39,36 +39,36 @@
implements XmlMarkup
{
/**
- * Starts a Tag, for instance:
+ * Starts a Tag. For instance:
* <pre>
* <tag>
* </pre>
*
* @param t a non null tag
- * @see #writeStartTag(Tag, MutableAttributeSet)
+ * @see #writeStartTag(javax.swing.text.html.HTML.Tag,
javax.swing.text.MutableAttributeSet)
*/
- protected void writeStartTag ( Tag t )
+ protected void writeStartTag( Tag t )
{
writeStartTag ( t, null );
}
/**
- * Starts a Tag with attributes, for instance:
+ * Starts a Tag with attributes. For instance:
* <pre>
* <tag attName="attValue">
* </pre>
*
* @param t a non null tag
* @param att a set of attributes
- * @see #writeStartTag(Tag, MutableAttributeSet, boolean)
+ * @see #writeStartTag(javax.swing.text.html.HTML.Tag,
javax.swing.text.MutableAttributeSet, boolean)
*/
- protected void writeStartTag ( Tag t, MutableAttributeSet att )
+ protected void writeStartTag( Tag t, MutableAttributeSet att )
{
writeStartTag ( t, att, false );
}
/**
- * Starts a Tag with attributes, for instance:
+ * Starts a Tag with attributes. For instance:
* <pre>
* <tag attName="attValue">
* </pre>
@@ -125,7 +125,7 @@
}
/**
- * Ends a Tag, for instance:
+ * Ends a Tag. For instance:
* <pre>
* </tag>
* </pre>
@@ -146,13 +146,13 @@
}
/**
- * Starts a simple Tag, for instance:
+ * Starts a simple Tag. For instance:
* <pre>
* <tag />
* </pre>
*
* @param t a non null tag
- * @see #writeSimpleTag(Tag, MutableAttributeSet)
+ * @see #writeSimpleTag(javax.swing.text.html.HTML.Tag,
javax.swing.text.MutableAttributeSet)
*/
protected void writeSimpleTag( Tag t )
{
@@ -160,16 +160,16 @@
}
/**
- * Starts a simple Tag with attributes, for instance:
+ * Starts a simple Tag with attributes. For instance:
* <pre>
* <tag attName="attValue" />
* </pre>
*
* @param t a non null tag
* @param att a set of attributes
- * @see #writeStartTag(Tag, MutableAttributeSet, boolean)
+ * @see #writeStartTag(javax.swing.text.html.HTML.Tag,
javax.swing.text.MutableAttributeSet, boolean)
*/
- protected void writeSimpleTag ( Tag t, MutableAttributeSet att )
+ protected void writeSimpleTag( Tag t, MutableAttributeSet att )
{
writeStartTag ( t, att, true );
}
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?view=diff&rev=566741&r1=566740&r2=566741
==============================================================================
---
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
Thu Aug 16 08:01:27 2007
@@ -33,7 +33,7 @@
public class HtmlTools
{
/**
- * Escape special characters in a text in HTML:
+ * Escape special characters in a text in HTML.
*
* <pre>
* < becomes <code>&</code>lt;
@@ -166,7 +166,7 @@
}
/**
- * Replace all characters in a text
+ * Replace all characters in a text.
*
* <pre>
* HtmlTools.encodeFragment( null ) = null
@@ -187,8 +187,11 @@
}
/**
+ * Construct a valid id.
+ * <p>
* According to the <a
href="http://www.w3.org/TR/html4/types.html#type-name";>
* HTML 4.01 specification section 6.2 SGML basic types</a>:
+ * </p>
* <p>
* <i>ID and NAME tokens must begin with a letter ([A-Za-z]) and may be
* followed by any number of letters, digits ([0-9]), hyphens ("-"),
Modified:
maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/module/AbstractIdentityTest.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/module/AbstractIdentityTest.java?view=diff&rev=566741&r1=566740&r2=566741
==============================================================================
---
maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/module/AbstractIdentityTest.java
(original)
+++
maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/module/AbstractIdentityTest.java
Thu Aug 16 08:01:27 2007
@@ -60,9 +60,9 @@
/**
- * Pipes a full model generated by [EMAIL PROTECTED] SinkTestDocument}
through
- * a Sink (generated by [EMAIL PROTECTED] #createSink(Writer)}) and a
Parser
- * (generated by [EMAIL PROTECTED] #createParser()}) and checks if the
result
+ * Pipes a full model generated by [EMAIL PROTECTED] SinkTestDocument}
through
+ * a Sink (generated by [EMAIL PROTECTED] #createSink(Writer)}) and a
Parser
+ * (generated by [EMAIL PROTECTED] #createParser()}) and checks if the
result
* is the same as the original model. Currently, this doesn't actually
* assert anything, but the two generated output files, expected.txt
* and actual.txt can be compared for differences.
