diff --git a/jxr/src/main/org/apache/maven/jxr/JxrBean.java b/jxr/src/main/org/apache/maven/jxr/JxrBean.java index 26a22e65..af231be6 100644 --- a/jxr/src/main/org/apache/maven/jxr/JxrBean.java +++ b/jxr/src/main/org/apache/maven/jxr/JxrBean.java @@ -36,29 +36,37 @@ import java.util.Locale; */ public class JxrBean { - /* - * See the doc comments for the corresponding getter/setter methods - */ + /** List of source directories to be cross-referenced. */ private List sourceDirs; + /** The destination directory for jxr output. */ private String destDir; + /** The locale. */ private Locale locale; + /** The inputEncoding. */ private String inputEncoding; + /** The outputEncoding. */ private String outputEncoding; + /** Used to cross-reference with javadoc pages. */ private String javadocDir; + /** Used by DirectoryIndexer. */ private String windowTitle; + /** Used by DirectoryIndexer. */ private String docTitle; + /** Used by DirectoryIndexer. */ private String bottom; + /** Where the navigation templates are located. */ private String templateDir; + /** Used for logging. */ private final Log log = LogFactory.getLog( JxrBean.class ); /** @@ -71,6 +79,7 @@ public class JxrBean /** * Starts the cross-referencing and indexing. + * @throws JxrException JxrException */ public void xref() throws JxrException @@ -119,7 +128,6 @@ public class JxrBean /** * Sets a single source directory to be cross-referenced. - * * @param sourceDir The source directory to be cross-referenced. */ public void setSourceDir( String sourceDir ) @@ -133,7 +141,6 @@ public class JxrBean /** * Adds a directory to the list of those to be cross-referenced. - * * @param sourceDir The source directory to be cross-referenced. */ public void addSourceDir( String sourceDir ) @@ -144,44 +151,52 @@ public class JxrBean /** * DestDir is the directory in which jxr will write its output - * - * @param destDir the destination directory for jxr output + * @param newDestDir the destination directory for jxr output */ - public void setDestDir( String destDir ) + public void setDestDir( String newDestDir ) { - this.destDir = destDir; + this.destDir = newDestDir; } /** * see setDestDir(String) + * @return destDir */ public String getDestDir() { return destDir; } + /** + * Returns the locale. + * @return the locale. + */ public Locale getLocale() { return locale; } - public void setLocale( Locale locale ) + /** + *Sets the locale. + * @param newLocale the locale. + */ + public void setLocale( Locale newLocale ) { - this.locale = locale; + this.locale = newLocale; } /** * InputEncoding is the encoding of source files. - * - * @param inputEncoding encoding of source files + * @param newInputEncoding encoding of source files */ - public void setInputEncoding( String inputEncoding ) + public void setInputEncoding( String newInputEncoding ) { - this.inputEncoding = inputEncoding; + this.inputEncoding = newInputEncoding; } /** * see setInputEncoding(String) + * @return inputEncoding */ public String getInputEncoding() { @@ -191,16 +206,16 @@ public class JxrBean /** * OutputEncoding is the encoding of output files. - * - * @param outputEncoding encoding of output files + * @param newOutputEncoding encoding of output files */ - public void setOutputEncoding( String outputEncoding ) + public void setOutputEncoding( String newOutputEncoding ) { - this.outputEncoding = outputEncoding; + this.outputEncoding = newOutputEncoding; } /** * see setOutputEncoding(String) + * @return outputEncoding */ public String getOutputEncoding() { @@ -214,15 +229,16 @@ public class JxrBean * * If null, no javadoc link will be added. * - * @param javadocDir The root directory containing javadocs + * @param newJavadocDir The root directory containing javadocs */ - public void setJavadocDir( String javadocDir ) + public void setJavadocDir( String newJavadocDir ) { - this.javadocDir = javadocDir; + this.javadocDir = newJavadocDir; } /** * see setJavadocDir(String) + * @return javadocDir */ public String getJavadocDir() { @@ -231,18 +247,17 @@ public class JxrBean /** * see DirectoryIndexer - * - * @param windowTitle used by DirectoryIndexer + * @param newWindowTitle used by DirectoryIndexer * @see DirectoryIndexer#setWindowTitle(String) setWindowTitle(String) */ - public void setWindowTitle( String windowTitle ) + public void setWindowTitle( String newWindowTitle ) { - this.windowTitle = windowTitle; + this.windowTitle = newWindowTitle; } /** * see DirectoryIndexer - * + * @return windowTitle * @see DirectoryIndexer#setWindowTitle(String) setWindowTitle(String) */ public String getWindowTitle() @@ -252,18 +267,17 @@ public class JxrBean /** * see DirectoryIndexer - * - * @param docTitle used by DirectoryIndexer + * @param newDocTitle used by DirectoryIndexer * @see DirectoryIndexer#setDocTitle(String) setDocTitle(String) */ - public void setDocTitle( String docTitle ) + public void setDocTitle( String newDocTitle ) { - this.docTitle = docTitle; + this.docTitle = newDocTitle; } /** * see DirectoryIndexer - * + * @return docTitle * @see DirectoryIndexer#setDocTitle(String) setDocTitle(String) */ public String getDocTitle() @@ -273,18 +287,17 @@ public class JxrBean /** * see DirectoryIndexer - * - * @param bottom used by DirectoryIndexer + * @param newBottom used by DirectoryIndexer * @see DirectoryIndexer#setBottom(String) setBottom(String) */ - public void setBottom( String bottom ) + public void setBottom( String newBottom ) { - this.bottom = bottom; + this.bottom = newBottom; } /** * see DirectoryIndexer - * + * @return bottom * @see DirectoryIndexer#setBottom(String) setBottom(String) */ public String getBottom() @@ -294,16 +307,16 @@ public class JxrBean /** * TemplateDir is where the navigation templates are located - * - * @param templateDir the template directory + * @param newTemplateDir the template directory */ - public void setTemplateDir( String templateDir ) + public void setTemplateDir( String newTemplateDir ) { - this.templateDir = templateDir; + this.templateDir = newTemplateDir; } /** * see setTemplateDir(String) + * @return templateDir */ public String getTemplateDir() { diff --git a/jxr/src/main/org/apache/maven/jxr/package.html b/jxr/src/main/org/apache/maven/jxr/package.html new file mode 100644 index 00000000..ba3862cb --- /dev/null +++ b/jxr/src/main/org/apache/maven/jxr/package.html @@ -0,0 +1,22 @@ + + + +

A bean to interact with the maven JXR code.

+ + \ No newline at end of file diff --git a/jxr/src/test/org/apache/maven/jxr/JxrBeanTest.java b/jxr/src/test/org/apache/maven/jxr/JxrBeanTest.java index 06e8eb3c..e2efa14d 100644 --- a/jxr/src/test/org/apache/maven/jxr/JxrBeanTest.java +++ b/jxr/src/test/org/apache/maven/jxr/JxrBeanTest.java @@ -1,13 +1,35 @@ package org.apache.maven.jxr; +/* ==================================================================== + * Copyright 2001-2004 The Apache Software Foundation. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ==================================================================== + */ + import junit.framework.TestCase; + /** A test class for JxrBean. */ public class JxrBeanTest extends TestCase { + /** A JxrBean. */ private JxrBean jxrBean; + /** Setup. + * @throws Exception Exception + */ protected void setUp() throws Exception { @@ -24,6 +46,9 @@ public class JxrBeanTest jxrBean.setBottom( "copyright" ); } + /** testXref. + * @throws Exception Exception + */ public void testXref() throws Exception { diff --git a/jxr/src/test/org/apache/maven/jxr/package-info.java b/jxr/src/test/org/apache/maven/jxr/package-info.java deleted file mode 100644 index 1e533d9d..00000000 --- a/jxr/src/test/org/apache/maven/jxr/package-info.java +++ /dev/null @@ -1 +0,0 @@ -package org.apache.maven.jxr; \ No newline at end of file diff --git a/jxr/src/test/org/apache/maven/jxr/package.html b/jxr/src/test/org/apache/maven/jxr/package.html new file mode 100644 index 00000000..13fdde0e --- /dev/null +++ b/jxr/src/test/org/apache/maven/jxr/package.html @@ -0,0 +1,22 @@ + + + +

Test class for JXRBean.

+ + \ No newline at end of file