From f2c1d4cc6753317745ab2012f74563f60c9a073c Mon Sep 17 00:00:00 2001 From: ltheussl Date: Wed, 14 Sep 2005 18:02:45 +0000 Subject: [PATCH] Fix javadocs git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@280897 13f79535-47bb-0310-9956-ffa450edef68 --- .../apache/maven/DependencyDescriberBean.java | 10 +++++----- .../org/apache/maven/xdoc/XdocTagLibrary.java | 2 +- .../org/apache/maven/xdoc/util/ScmUtil.java | 17 ++++++++++------- 3 files changed, 16 insertions(+), 13 deletions(-) diff --git a/xdoc/src/main/org/apache/maven/DependencyDescriberBean.java b/xdoc/src/main/org/apache/maven/DependencyDescriberBean.java index 50ceef48..3f53f0d8 100644 --- a/xdoc/src/main/org/apache/maven/DependencyDescriberBean.java +++ b/xdoc/src/main/org/apache/maven/DependencyDescriberBean.java @@ -40,13 +40,13 @@ public class DependencyDescriberBean { //~ Instance fields ------------------------------------------------ - /** dependencies list */ + /** Dependencies list. */ private List dependencies = new ArrayList(); - /** for debug output */ + /** For debug output. */ private Log log = LogFactory.getLog(DependencyDescriberBean.class); - /** project reference */ + /** Project reference. */ private Project project; //~ Methods -------------------------------------------------------- @@ -64,8 +64,8 @@ public class DependencyDescriberBean } /** - * Project provides context/session related information. e.g where - * maven repo local is + * Project provides context/session related information, e.g where + * maven repo local is. * * @param projectValue project to scan */ diff --git a/xdoc/src/main/org/apache/maven/xdoc/XdocTagLibrary.java b/xdoc/src/main/org/apache/maven/xdoc/XdocTagLibrary.java index 237418ba..d2999895 100644 --- a/xdoc/src/main/org/apache/maven/xdoc/XdocTagLibrary.java +++ b/xdoc/src/main/org/apache/maven/xdoc/XdocTagLibrary.java @@ -28,7 +28,7 @@ import org.apache.commons.jelly.TagLibrary; public class XdocTagLibrary extends TagLibrary { /** - * Create an instance of the {@link MavenTagLibrary}, registering related + * Create an instance of the MavenTagLibrary, registering related * tag libraries */ public XdocTagLibrary() diff --git a/xdoc/src/main/org/apache/maven/xdoc/util/ScmUtil.java b/xdoc/src/main/org/apache/maven/xdoc/util/ScmUtil.java index 9559b02e..d21aecaa 100644 --- a/xdoc/src/main/org/apache/maven/xdoc/util/ScmUtil.java +++ b/xdoc/src/main/org/apache/maven/xdoc/util/ScmUtil.java @@ -35,7 +35,7 @@ public final class ScmUtil { /** - * Get the SCM type + * Get the SCM type. * * @param scmConnection the scm connection to analyse. * @return the scm type : cvs, svn , ... @@ -66,7 +66,8 @@ public final class ScmUtil } /** - * Get cvs server. Used in xdocs/src/plugin-resources/templates/cvs-usage.xml + * Get cvs server. Used in + * xdocs/src/plugin-resources/templates/cvs-usage.xml. * * @param conn six token connection string * @return CVS module. @@ -90,7 +91,7 @@ public final class ScmUtil } /** - * Get cvs root. Used in xdocs/src/plugin-resources/templates/cvs-usage.xml + * Get cvs root. Used in xdocs/src/plugin-resources/templates/cvs-usage.xml. * * @param conn six token connection string * @param username username override if non-empty. @@ -118,7 +119,8 @@ public final class ScmUtil } /** - * Get cvs module. Used in xdocs/src/plugin-resources/templates/cvs-usage.xml + * Get cvs module. Used in + * xdocs/src/plugin-resources/templates/cvs-usage.xml. * * @param conn six token connection string * @return CVS module. @@ -140,10 +142,10 @@ public final class ScmUtil } /** - * Splits an SCM string into parts + * Splits an SCM string into parts. * * @param connection - * @return + * @return A string array of SCM parts */ public String[] splitSCMConnection(String connection) { @@ -181,7 +183,8 @@ public final class ScmUtil } /** - * Converts a tokenizer to an array of strings FIXME: This should be in a string util class + * Converts a tokenizer to an array of strings FIXME: This should be in a + * string util class. * * @param tok * @return String[]