Author: hboutemy
Date: Sat Sep 6 10:34:46 2008
New Revision: 692692
URL: http://svn.apache.org/viewvc?rev=692692&view=rev
Log:
improved javadoc and fixed typos
Modified:
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/DirectoryIndexer.java
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JXR.java
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JxrException.java
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/JavaFile.java
Modified:
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/DirectoryIndexer.java
URL:
http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/DirectoryIndexer.java?rev=692692&r1=692691&r2=692692&view=diff
==============================================================================
---
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/DirectoryIndexer.java
(original)
+++
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/DirectoryIndexer.java
Sat Sep 6 10:34:46 2008
@@ -40,20 +40,22 @@
/**
* This class creates the navigational pages for jxr's cross-referenced source
- * files. The navigation is inspired by javadoc, so it should have a familiar
feel.
+ * files. The navigation is inspired by javadoc, so it should have a familiar
feel.
*
* Creates the following files:
* <ul>
- * <li>index.html main index containing the frameset</li>
- * <li>overview-frame.html list of the project's packages (top
left)</li>
- * <li>allclasses-frame.html list of all classes in the project
(bottom left)</li>
- * <li>overview-summary.html top-level listing of the project's packages (main
frame)</li>
+ * <li><code>index.html</code> main index containing the
frameset</li>
+ * <li><code>overview-frame.html</code> list of the project's packages
(top left)</li>
+ * <li><code>allclasses-frame.html</code> list of all classes in the project
(bottom left)</li>
+ * <li><code>overview-summary.html</code> top-level listing of the project's
packages (main frame)</li>
*
- * <ul>
+ * <li>
* Package specific:
- * <li>package-summary.html listing of all classes in this package (main
frame)</li>
- * <li>package-frame.html listing of all classes in this package (bottom
left)</li>
+ * <ul>
+ * <li><code>package-summary.html</code> listing of all classes in this
package (main frame)</li>
+ * <li><code>package-frame.html</code> listing of all classes in this
package (bottom left)</li>
* </ul>
+ * </li>
* </ul>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Fabrice Bellingard </a>
@@ -258,7 +260,7 @@
File templateDirFile = new File( getTemplateDir() );
if ( templateDirFile.isAbsolute() )
{
- // the property has been overriden: need to use a
FileResourceLoader
+ // the property has been overridden: need to use a
FileResourceLoader
engine.setProperty( "resource.loader", "file" );
engine.setProperty( "file.resource.loader.class",
"org.apache.velocity.runtime.resource.loader.FileResourceLoader" );
Modified: maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JXR.java
URL:
http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JXR.java?rev=692692&r1=692691&r2=692692&view=diff
==============================================================================
--- maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JXR.java
(original)
+++ maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JXR.java Sat
Sep 6 10:34:46 2008
@@ -322,7 +322,7 @@
* Given a source file transform it into HTML and write it to the
* destination (dest) file.
*
- * @param source The jave source file
+ * @param source The java source file
* @param dest The directory to put the HTML into
* @throws IOException Thrown if the transform can't happen for some
reason.
*/
@@ -340,14 +340,14 @@
* Creates a relative link from one directory to another.
*
* Example:
- * given /foo/bar/baz/oink
- * and /foo/bar/schmoo
+ * given <code>/foo/bar/baz/oink</code>
+ * and <code>/foo/bar/schmoo</code>
*
- * this method will return a string of "../../schmoo/"
+ * this method will return a string of <code>"../../schmoo/"</code>
*
* @param fromDir The directory from which the link is relative.
* @param toDir The directory into which the link points.
- * @return a string of format "../../schmoo/"
+ * @return a String of format <code>"../../schmoo/"</code>
* @throws java.io.IOException If a problem is encountered while
navigating through the directories.
*/
private static String getRelativeLink( String fromDir, String toDir )
Modified:
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java
URL:
http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java?rev=692692&r1=692691&r2=692692&view=diff
==============================================================================
---
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java
(original)
+++
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JavaCodeTransform.java
Sat Sep 6 10:34:46 2008
@@ -98,42 +98,42 @@
public static final boolean LINE_NUMBERS = true;
/**
- * start comment delimeter
+ * start comment delimiter
*/
public static final String COMMENT_START = "<em class=\"jxr_comment\">";
/**
- * end comment delimeter
+ * end comment delimiter
*/
public static final String COMMENT_END = "</em>";
/**
- * start javadoc comment delimeter
+ * start javadoc comment delimiter
*/
public static final String JAVADOC_COMMENT_START = "<em
class=\"jxr_javadoccomment\">";
/**
- * end javadoc comment delimeter
+ * end javadoc comment delimiter
*/
public static final String JAVADOC_COMMENT_END = "</em>";
/**
- * start String delimeter
+ * start String delimiter
*/
public static final String STRING_START = "<span class=\"jxr_string\">";
/**
- * end String delimeter
+ * end String delimiter
*/
public static final String STRING_END = "</span>";
/**
- * start reserved word delimeter
+ * start reserved word delimiter
*/
public static final String RESERVED_WORD_START = "<strong
class=\"jxr_keyword\">";
/**
- * end reserved word delimeter
+ * end reserved word delimiter
*/
public static final String RESERVED_WORD_END = "</strong>";
@@ -164,7 +164,7 @@
private Hashtable reservedWords = new Hashtable();
/**
- * flag set to true when a multi line comment is started
+ * flag set to true when a multi-line comment is started
*/
private boolean inMultiLineComment = false;
@@ -179,7 +179,7 @@
private String currentFilename = null;
/**
- * The current CVS revision of the currently transformed documnt
+ * The current CVS revision of the currently transformed document
*/
private String revision = null;
@@ -189,12 +189,12 @@
private String sourcefile = null;
/**
- * The currently being written destfile
+ * The currently being written destination file
*/
private String destfile = null;
/**
- * The virtual source directory that is being read from: src/java
+ * The virtual source directory that is being read from:
<code>src/java</code>
*/
private String sourcedir = null;
@@ -597,7 +597,7 @@
}
/**
- * The current dest file being written
+ * The current destination file being written
*
* @return destination file name
*/
@@ -817,7 +817,7 @@
/**
* Filter inline comments from a line and formats them properly. One
problem
* we'll have to solve here: comments contained in a string should be
- * ignored... this is also true of the multiline comments. So, we could
+ * ignored... this is also true of the multi-line comments. So, we could
* either ignore the problem, or implement a function called something like
* isInsideString(line, index) where index points to some point in the line
* that we need to check... started doing this function below.
@@ -911,7 +911,6 @@
return "";
}
StringBuffer buf = new StringBuffer();
- Hashtable usedReservedWords = new Hashtable();
int i = 0;
char ch;
StringBuffer temp = new StringBuffer();
@@ -956,7 +955,7 @@
}
/**
- * Replace... I made it use a stringBuffer... hope it still works :)
+ * Replace... I made it use a <code>StringBuffer</code>... hope it still
works :)
*
* @param line String
* @param oldString String
@@ -985,7 +984,7 @@
*/
private final boolean isInsideString( String line, int position )
{
- if ( line.indexOf( "\"" ) < 0 )
+ if ( line.indexOf( '"' ) < 0 )
{
return false;
}
@@ -994,12 +993,12 @@
String right = line.substring( position );
int leftCount = 0;
int rightCount = 0;
- while ( ( index = left.indexOf( "\"" ) ) > -1 )
+ while ( ( index = left.indexOf( '"' ) ) > -1 )
{
leftCount++;
left = left.substring( index + 1 );
}
- while ( ( index = right.indexOf( "\"" ) ) > -1 )
+ while ( ( index = right.indexOf( '"' ) ) > -1 )
{
rightCount++;
right = right.substring( index + 1 );
@@ -1218,13 +1217,13 @@
for ( int j = 0; j < packages.length; ++j )
{
- //get the package from teh PackageManager because this will
hold
+ //get the package from the PackageManager because this will
hold
//the version with the classes also.
PackageType currentImport = packageManager.getPackageType(
packages[j] );
//the package here might in fact be null because it wasn't
parsed out
- //this might be something that is either not included or os
part
+ //this might be something that is either not included or is
part
//of another package and wasn't parsed out.
if ( currentImport == null )
@@ -1333,7 +1332,7 @@
/**
* <p>Given the name of a package... get the number of
* subdirectories/subpackages there would be. </p>
- * <p>EX: org.apache.maven == 3 </p>
+ * <p>EX: <code>org.apache.maven == 3</code> </p>
*
* @param packageName String
* @return int
@@ -1350,7 +1349,7 @@
while ( true )
{
- index = packageName.indexOf( ".", index );
+ index = packageName.indexOf( '.', index );
if ( index == -1 )
{
@@ -1361,7 +1360,7 @@
}
//need to increment this by one
- count = ++count;
+ ++count;
return count;
}
Modified:
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JxrException.java
URL:
http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JxrException.java?rev=692692&r1=692691&r2=692692&view=diff
==============================================================================
---
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JxrException.java
(original)
+++
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/JxrException.java
Sat Sep 6 10:34:46 2008
@@ -20,7 +20,7 @@
*/
/**
- * Exception occuring in JXR.
+ * Exception occurring in JXR.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Brett Porter</a>
* @version $Id$
Modified:
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/JavaFile.java
URL:
http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/JavaFile.java?rev=692692&r1=692691&r2=692692&view=diff
==============================================================================
---
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/JavaFile.java
(original)
+++
maven/jxr/trunk/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/JavaFile.java
Sat Sep 6 10:34:46 2008
@@ -24,7 +24,7 @@
import java.util.Vector;
/**
- * Interface for objects which wish to provide metainfo about a JavaFile.
+ * Interface for objects which wish to provide meta-info about a JavaFile.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Kevin A. Burton</a>
* @version $Id$
