You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@creadur.apache.org by rd...@apache.org on 2009/02/28 10:00:51 UTC
svn commit: r748796 - in
/incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat:
annotation/ document/impl/guesser/ header/ report/xml/writer/
report/xml/writer/impl/base/
Author: rdonkin
Date: Sat Feb 28 09:00:51 2009
New Revision: 748796
URL: http://svn.apache.org/viewvc?rev=748796&view=rev
Log:
Cleared up some javadoc issues. RAT-38 https://issues.apache.org/jira/browse/RAT-38
Modified:
incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/annotation/AbstractLicenceAppender.java
incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/GuessUtils.java
incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/header/HeaderBean.java
incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java
incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/IXmlWriter.java
incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/impl/base/XmlWriter.java
Modified: incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/annotation/AbstractLicenceAppender.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/annotation/AbstractLicenceAppender.java?rev=748796&r1=748795&r2=748796&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/annotation/AbstractLicenceAppender.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/annotation/AbstractLicenceAppender.java Sat Feb 28 09:00:51 2009
@@ -102,7 +102,7 @@
* Detect the type of document.
*
* @param document
- * @return
+ * @return not null
* @TODO use existing mechanism to detect the type of a file and record it in the report output, thus we will not need this duplication here.
*/
protected int getType(File document) {
@@ -145,7 +145,7 @@
* for the given type of file.
*
* @param type the type of file, see the TYPE_* constants
- * @return
+ * @return not null
*/
protected String getFirstLine(int type) {
switch (type) {
@@ -166,7 +166,7 @@
* for the given type of file.
*
* @param type the type of file, see the TYPE_* constants
- * @return
+ * @return not null
*/
protected String getLastLine(int type) {
switch (type) {
@@ -188,7 +188,7 @@
*
* @param type the type of file, see the TYPE_* constants
* @param content the content for this line
- * @return
+ * @return not null
*/
protected String getLine(int type, String content) {
switch (type) {
Modified: incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/GuessUtils.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/GuessUtils.java?rev=748796&r1=748795&r2=748796&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/GuessUtils.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/document/impl/guesser/GuessUtils.java Sat Feb 28 09:00:51 2009
@@ -28,8 +28,8 @@
/**
* Converts name to upper case and strips any path.
- * @param name
- * @return
+ * @param name not null
+ * @return not null
*/
public static final String normalise(final String name) {
String result = name.toUpperCase(Locale.US);
Modified: incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/header/HeaderBean.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/header/HeaderBean.java?rev=748796&r1=748795&r2=748796&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/header/HeaderBean.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/header/HeaderBean.java Sat Feb 28 09:00:51 2009
@@ -46,7 +46,7 @@
/**
* Sets the header pattern to be matched.
- * @param <code>Patter</code>
+ * @param headerPattern <code>Patter</code>
* or null when no match is to be made
*/
public void setHeaderPattern(Pattern headerPattern) {
Modified: incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java?rev=748796&r1=748795&r2=748796&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java Sat Feb 28 09:00:51 2009
@@ -81,7 +81,7 @@
* </p>
* @param pattern <code>Pattern</code> to match
* @return true if the pattern matches,
- * false otherwise or if {@link #read()} has not been
+ * false otherwise or if {@link #read(Reader)} has not been
* called
*/
public boolean matches(Pattern pattern) {
Modified: incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/IXmlWriter.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/IXmlWriter.java?rev=748796&r1=748795&r2=748796&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/IXmlWriter.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/IXmlWriter.java Sat Feb 28 09:00:51 2009
@@ -59,8 +59,8 @@
* @return this object
* @throws InvalidXmlException if the name is not valid for an xml attribute
* or if a value for the attribute has already been written
- * @throws OperationNotAllowedException if called after {@link #content}
- * or {@link #closeElement() or before any call to {@link #openElement}
+ * @throws OperationNotAllowedException if called after {@link #content(CharSequence)}
+ * or {@link #closeElement()} or before any call to {@link #openElement(CharSequence)}
*/
public IXmlWriter attribute(CharSequence name, CharSequence value) throws IOException;
Modified: incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/impl/base/XmlWriter.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/impl/base/XmlWriter.java?rev=748796&r1=748795&r2=748796&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/impl/base/XmlWriter.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/report/xml/writer/impl/base/XmlWriter.java Sat Feb 28 09:00:51 2009
@@ -472,8 +472,8 @@
* @return this object
* @throws InvalidXmlException if the name is not valid for an xml attribute
* or if a value for the attribute has already been written
- * @throws OperationNotAllowedException if called after {@link #content}
- * or {@link #closeElement() or before any call to {@link #openElement}
+ * @throws OperationNotAllowedException if called after {@link #content(CharSequence)}
+ * or {@link #closeElement()} or before any call to {@link #openElement(CharSequence)}
*/
public IXmlWriter attribute(CharSequence name, CharSequence value) throws IOException {
if (elementNames.isEmpty()) {