vmassol 02/05/27 14:23:32
Modified: src/java/org/apache/maven/project Project.java
Log:
some checkstyle corrections (still a few there ...)
Revision Changes Path
1.18 +36 -17
jakarta-turbine-maven/src/java/org/apache/maven/project/Project.java
Index: Project.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/project/Project.java,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- Project.java 25 Apr 2002 15:51:28 -0000 1.17
+++ Project.java 27 May 2002 21:23:32 -0000 1.18
@@ -3,7 +3,7 @@
/* ====================================================================
* The Apache Software License, Version 1.1
*
- * Copyright (c) 2002 The Apache Software Foundation. All rights
+ * Copyright (c) 2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -52,6 +52,8 @@
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
+ *
+ * ====================================================================
*/
import java.util.ArrayList;
@@ -61,7 +63,8 @@
/**
* @author <a href="mailto:[EMAIL PROTECTED]">Jason van Zyl</a>
- * @version $Id: Project.java,v 1.17 2002/04/25 15:51:28 jvanzyl Exp $
+ * @author <a href="[EMAIL PROTECTED]">Vincent Massol</a>
+ * @version $Id: Project.java,v 1.18 2002/05/27 21:23:32 vmassol Exp $
*/
public class Project
extends BaseObject
@@ -192,8 +195,10 @@
}
/**
- * Set the site address where the documentation
- * lives.
+ * Set the site address where the documentation lives.
+ *
+ * @param siteAddress the hostname of the web server that hosts the
+ * project's web site (ex: "jakarta.apache.org")
*/
public void setSiteAddress(String siteAddress)
{
@@ -201,7 +206,7 @@
}
/**
- * Get the site address.
+ * @return the site address
*/
public String getSiteAddress()
{
@@ -211,6 +216,10 @@
/**
* Set the site directory where the documentation
* lives.
+ *
+ * @param siteDirectory the directory on the web server where the public
+ * web site for this project resides
+ * (ex: "/www/jakarta.apache.org/turbine/maven/")
*/
public void setSiteDirectory(String siteDirectory)
{
@@ -218,7 +227,7 @@
}
/**
- * Get the site directory.
+ * @return the site directory
*/
public String getSiteDirectory()
{
@@ -227,6 +236,10 @@
/**
* Set the distribution directory.
+ *
+ * @param distributionDirectory the directory on the web server where the
+ * final distributions will be published
+ * (ex: "/www/jakarta.apache.org/builds/jakarta-turbine-maven/")
*/
public void setDistributionDirectory(String distributionDirectory)
{
@@ -234,7 +247,7 @@
}
/**
- * Get the distribution directory.
+ * @return the distribution directory
*/
public String getDistributionDirectory()
{
@@ -252,9 +265,7 @@
}
/**
- * Return the dependencies for this project.
- *
- * @return List of dependencies
+ * @return the dependencies for this project
*/
public List getDependencies()
{
@@ -263,6 +274,8 @@
/**
* Sets the build attribute of the Project object
+ *
+ * @param build the build environment of a project
*/
public void setBuild(Build build)
{
@@ -270,7 +283,7 @@
}
/**
- * Gets the build attribute of the Project object
+ * @return the build attribute of the Project object
*/
public Build getBuild()
{
@@ -338,7 +351,9 @@
}
/**
- * Sets the url attribute of the Project object
+ * Sets the url attribute of the Project object.
+ *
+ * @param url the URL to the organization's home page
*/
public void setUrl(String url)
{
@@ -346,7 +361,7 @@
}
/**
- * Gets the url attribute of the Project object
+ * @return the URL to the organization's home page
*/
public String getUrl()
{
@@ -354,7 +369,9 @@
}
/**
- * Sets the cvsWebUrl attribute of the Project object
+ * Sets the cvsWebUrl attribute of the Project object.
+ *
+ * @param cvsWebUrl the URL to the project's browsable CVS repository
*/
public void setCvsWebUrl(String cvsWebUrl)
{
@@ -362,7 +379,7 @@
}
/**
- * Gets the cvsWebUrl attribute of the Project object
+ * @return the URL to the project's browsable CVS repository
*/
public String getCvsWebUrl()
{
@@ -370,7 +387,9 @@
}
/**
- * Sets the issueTrackingUrl attribute of the Project object
+ * Sets the issueTrackingUrl attribute of the Project object.
+ *
+ * @param issueTrackingUrl the URL to the project's issue tracking system
*/
public void setIssueTrackingUrl(String issueTrackingUrl)
{
@@ -378,7 +397,7 @@
}
/**
- * Gets the issueTrackingUrl attribute of the Project object
+ * @return the URL to the project's issue tracking system
*/
public String getIssueTrackingUrl()
{
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>