jvanzyl 2002/11/24 12:47:53
Modified: src/java/org/apache/maven/app Maven.java
Log:
o correcting checkstyle violoations.
Revision Changes Path
1.140 +51 -21 jakarta-turbine-maven/src/java/org/apache/maven/app/Maven.java
Index: Maven.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/app/Maven.java,v
retrieving revision 1.139
retrieving revision 1.140
diff -u -r1.139 -r1.140
--- Maven.java 24 Nov 2002 19:00:37 -0000 1.139
+++ Maven.java 24 Nov 2002 20:47:53 -0000 1.140
@@ -239,9 +239,10 @@
return ( this.projectBuildFile != null );
}
- /** Retrieve the maven <code>project</code>.
+ /**
+ * Get the project.
*
- * @return The project descriptor.
+ * @param project The Maven project.
*/
public void setProject( Project project )
{
@@ -266,9 +267,10 @@
return antProject;
}
- /** Retrieve the Ant project.
+ /**
+ * Set the Ant project.
*
- * @return The ant project.
+ * @param antProject The ant project.
*/
private void setAntProject( GrantProject antProject )
{
@@ -376,7 +378,11 @@
}
}
- /** Set the context. */
+ /**
+ * Set the context.
+ *
+ * @param jellyContext Maven jelly context.
+ */
public void setContext( MavenJellyContext jellyContext )
{
this.jellyContext = jellyContext;
@@ -424,6 +430,8 @@
/**
* Set the project verifier.
+ *
+ * @param projectVerifier Maven project verifier.
*/
public void setProjectVerifier( ProjectVerifier projectVerifier )
{
@@ -432,6 +440,8 @@
/**
* Get the project verifier.
+ *
+ * @return Maven project verifier.
*/
public ProjectVerifier getProjectVerifier()
{
@@ -440,6 +450,8 @@
/**
* Get the plugin manager.
+ *
+ * @return Maven plugin manager.
*/
public PluginManager getPluginManager()
{
@@ -448,6 +460,8 @@
/**
* Set the emacsMode flag.
+ *
+ * @param emacsMode Emacs output mode.
*/
public void setEmacsMode( boolean emacsMode )
{
@@ -456,20 +470,16 @@
/**
* Get the emacsMode flag.
+ *
+ * @return Emacs output mode.
*/
public boolean getEmacsMode()
{
return emacsMode;
}
- /** Retrieve a property.
- *
- * @param name the property name to retrieve
- * @return The value of the property or <code>null</code>
- * if the property has not been set.
- */
-
- /** Retrieve all property names.
+ /**
+ * Retrieve all property names.
*
* @return an Iterator over the current property names in this context
*/
@@ -491,6 +501,9 @@
/**
* Get a variable from the jelly context.
+ *
+ * @param key Key for object to retrieve from maven jelly context.
+ * @return Object from the maven jelly context.
*/
public Object getVariable( String key )
{
@@ -501,7 +514,10 @@
// I M P L E M E N T A T I O N
// ------------------------------------------------------------
- /** Initialize Jelly.
+ /**
+ * Initialize Jelly.
+ *
+ * @throws Exception If an error occurs during the jelly initialization.
*/
public void initializeJelly()
throws Exception
@@ -524,7 +540,8 @@
}
- /** Initialize the core <code>jeez</code> Jelly tag library.
+ /**
+ * Initialize the core <code>jeez</code> Jelly tag library.
*/
private void initializeTagLibs()
{
@@ -537,7 +554,9 @@
AntTagLibrary.setProject( getContext(), getAntProject() );
}
- /** Initialize Ant. */
+ /**
+ * Initialize Ant.
+ */
private void initializeAnt()
{
setAntProject( new GrantProject() );
@@ -589,8 +608,13 @@
loadProjectBuildFile();
}
- /** Return an InputStream found in the classpath. Used
+ /**
+ * Return an InputStream found in the classpath. Used
* specifically to find resources stored in the maven.jar
+ *
+ * @param name Name of the resource to find.
+ * @throws Exception If an error occurs while trying to retreive the
+ * named resource.
*/
private InputStream getResourceAsStream( String name )
throws Exception
@@ -688,7 +712,8 @@
* @throws Exception if there is an error loading
* the project's maven.xml script.
*/
- private void loadProjectBuildFile() throws Exception
+ private void loadProjectBuildFile()
+ throws Exception
{
File projectBuildFile = getProjectBuildFile();
@@ -709,7 +734,8 @@
* @throws Exception If an exception occurs while
* running a goal.
*/
- private void runGoals( List goalNames ) throws UnknownGoalException, Exception
+ private void runGoals( List goalNames )
+ throws UnknownGoalException, Exception
{
if ( goalNames.isEmpty() )
{
@@ -764,7 +790,11 @@
// The only thing using this now is the dvsl bean and xdoc base project
// task. Get rid of this when the jsl stuff is finished. jvz.
- /** Get the Maven instance. */
+ /**
+ * Get the Maven instance.
+ *
+ * @return The current Maven instance.
+ */
public static Maven getInstance()
{
return (Maven) INSTANCES.peek();
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
