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 lt...@apache.org on 2007/12/16 21:05:22 UTC
svn commit: r604683 - in
/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser:
ImageBlock.java TextParser.java
Author: ltheussl
Date: Sun Dec 16 12:05:22 2007
New Revision: 604683
URL: http://svn.apache.org/viewvc?rev=604683&view=rev
Log:
[DOXIA-192] checkstyle fixes, javadocs
Submitted by: Juan F. Codagnone, Christian Nardi
Modified:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ImageBlock.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TextParser.java
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ImageBlock.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ImageBlock.java?rev=604683&r1=604682&r2=604683&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ImageBlock.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ImageBlock.java Sun Dec 16 12:05:22 2007
@@ -52,19 +52,21 @@
/**
* @see Block#traverse(org.apache.maven.doxia.sink.Sink)
+ * @param sink the sink that travers
*/
public final void traverse( final Sink sink )
{
sink.figure();
sink.figureGraphics( reference );
sink.figure_();
-
}
/**
* @see Object#equals(Object)
+ * @param obj the reference object with which to compare.
+ * @return <code>true</code> if this object is the same as the obj
+ * argument; <code>false</code> otherwise.
*/
-
public final boolean equals( final Object obj )
{
boolean ret = false;
@@ -84,6 +86,7 @@
/**
* @see Object#hashCode()
+ * @return a hash code value for this object.
*/
public final int hashCode()
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TextParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TextParser.java?rev=604683&r1=604682&r2=604683&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TextParser.java (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TextParser.java Sun Dec 16 12:05:22 2007
@@ -113,9 +113,9 @@
/**
* Parses the url
- * @param line
- * @param ret
- * @param urlMatcher
+ * @param line the line to parse
+ * @param ret where the results live
+ * @param urlMatcher url matcher
*/
private void parseUrl( final String line, final List ret,
final Matcher urlMatcher )
@@ -136,9 +136,10 @@
}
/**
- * @param line
- * @param ret
- * @param anchorMatcher
+ * Parses the anchor
+ * @param line the line to parse
+ * @param ret where the results live
+ * @param anchorMatcher anchor matcher
*/
private void parseAnchor( final String line, final List ret,
final Matcher anchorMatcher )
@@ -149,9 +150,10 @@
}
/**
- * @param line
- * @param ret
- * @param forcedLinkMatcher
+ * Parses the link
+ * @param line line to parse
+ * @param ret where the results live
+ * @param forcedLinkMatcher forced link matcher
*/
private void parseForcedLink( final String line, final List ret,
final Matcher forcedLinkMatcher )
@@ -198,6 +200,12 @@
}
}
+ /**
+ * Parses a wiki word
+ * @param line the line to parse
+ * @param ret where the results live
+ * @param wikiMatcher wiki matcher
+ */
private void parseWiki( final String line, final List ret,
final Matcher wikiMatcher )
{
@@ -215,6 +223,12 @@
}
+ /**
+ * Parses a link
+ * @param line the line to parse
+ * @param ret where the results live
+ * @param linkMatcher link matcher
+ */
private void parseLink( final String line, final List ret,
final Matcher linkMatcher )
{
@@ -243,6 +257,11 @@
return startLikeWord( m, line ) && endLikeWord( m, line );
}
+ /**
+ * @param m matcher to test
+ * @param line line to test
+ * @return true if it is the beggining of a word
+ */
private boolean startLikeWord( final Matcher m, final String line )
{
final int start = m.start();
@@ -262,7 +281,12 @@
return ret;
}
-
+
+ /**
+ * @param m matcher to test
+ * @param line line to test
+ * @return true if it is the end of a word
+ */
private boolean endLikeWord( final Matcher m, final String line )
{
final int end = m.end();