Author: ltheussl
Date: Fri Jul 28 11:36:45 2006
New Revision: 426641
URL: http://svn.apache.org/viewvc?rev=426641&view=rev
Log:
Javadocs
Modified:
maven/maven-1/core/trunk/src/java/org/apache/maven/AbstractMavenComponent.java
maven/maven-1/core/trunk/src/java/org/apache/maven/MavenSession.java
maven/maven-1/core/trunk/src/java/org/apache/maven/MavenUtils.java
maven/maven-1/core/trunk/src/java/org/apache/maven/cli/App.java
Modified:
maven/maven-1/core/trunk/src/java/org/apache/maven/AbstractMavenComponent.java
URL:
http://svn.apache.org/viewvc/maven/maven-1/core/trunk/src/java/org/apache/maven/AbstractMavenComponent.java?rev=426641&r1=426640&r2=426641&view=diff
==============================================================================
---
maven/maven-1/core/trunk/src/java/org/apache/maven/AbstractMavenComponent.java
(original)
+++
maven/maven-1/core/trunk/src/java/org/apache/maven/AbstractMavenComponent.java
Fri Jul 28 11:36:45 2006
@@ -62,13 +62,26 @@
return project;
}
- /** @see MavenUtils#getMessage */
+ /**
+ * Retrieve a user message.
+ *
+ * @param messageId Id of message type to use.
+ * @return Message for the user's locale.
+ * @see MavenUtils#getMessage
+ */
public String getMessage( final String messageId )
{
return MavenUtils.getMessage( messageId );
}
- /** @see MavenUtils#getMessage */
+ /**
+ * Retrieve a user message.
+ *
+ * @param messageId Id of message type to use.
+ * @param variable Value to substitute for ${1} in the given message.
+ * @return Message for the user's locale.
+ * @see MavenUtils#getMessage
+ */
public String getMessage( final String messageId, final Object variable )
{
return MavenUtils.getMessage( messageId, variable );
Modified: maven/maven-1/core/trunk/src/java/org/apache/maven/MavenSession.java
URL:
http://svn.apache.org/viewvc/maven/maven-1/core/trunk/src/java/org/apache/maven/MavenSession.java?rev=426641&r1=426640&r2=426641&view=diff
==============================================================================
--- maven/maven-1/core/trunk/src/java/org/apache/maven/MavenSession.java
(original)
+++ maven/maven-1/core/trunk/src/java/org/apache/maven/MavenSession.java Fri
Jul 28 11:36:45 2006
@@ -208,7 +208,7 @@
/**
* Load the mavenSession project descriptor.
*
- * @throws Exception If there is an error while
+ * @throws MavenException If there is an error while
* reading the project descriptor.
*/
private void initializeRootProject()
@@ -264,18 +264,37 @@
pluginManager.attainGoals( project, goals );
}
+ /**
+ * Returns a plugin project for the given goal.
+ *
+ * @param goal a goal name
+ * @return Project
+ * @throws MavenException when anything goes wrong
+ */
public Project getPluginProjectFromGoal( String goal )
throws MavenException
{
return pluginManager.getPluginProjectFromGoal( goal );
}
+ /**
+ * Return the goals for the given project.
+ *
+ * @param project A project
+ * @return A set of goals
+ * @throws MavenException when anything goes wrong
+ */
public Set getProjectGoals( Project project )
throws MavenException
{
return pluginManager.getGoalNames( project );
}
+ /**
+ * Return the current list of plugins.
+ *
+ * @return Collection
+ */
public Collection getPluginList()
{
return pluginManager.getPluginList();
Modified: maven/maven-1/core/trunk/src/java/org/apache/maven/MavenUtils.java
URL:
http://svn.apache.org/viewvc/maven/maven-1/core/trunk/src/java/org/apache/maven/MavenUtils.java?rev=426641&r1=426640&r2=426641&view=diff
==============================================================================
--- maven/maven-1/core/trunk/src/java/org/apache/maven/MavenUtils.java
(original)
+++ maven/maven-1/core/trunk/src/java/org/apache/maven/MavenUtils.java Fri Jul
28 11:36:45 2006
@@ -628,6 +628,11 @@
return context;
}
+ /**
+ * Apply default settings.
+ *
+ * @param context Jelly context to apply the defaults.
+ */
private static void applyDefaults( MavenJellyContext context )
{
Properties defaultProperties = loadProperties( MavenUtils.class
Modified: maven/maven-1/core/trunk/src/java/org/apache/maven/cli/App.java
URL:
http://svn.apache.org/viewvc/maven/maven-1/core/trunk/src/java/org/apache/maven/cli/App.java?rev=426641&r1=426640&r2=426641&view=diff
==============================================================================
--- maven/maven-1/core/trunk/src/java/org/apache/maven/cli/App.java (original)
+++ maven/maven-1/core/trunk/src/java/org/apache/maven/cli/App.java Fri Jul 28
11:36:45 2006
@@ -726,7 +726,8 @@
}
/**
- * Display the plugin help if the option is present, then exit
+ * Display the plugin help if the option is present, then exit.
+ * @throws MavenException when anything goes wrong
*/
private void displayPluginHelp()
throws MavenException
@@ -788,7 +789,8 @@
}
/**
- * Display the project help if the option is present, then exit
+ * Display the project help if the option is present, then exit.
+ * @throws MavenException when anything goes wrong
*/
private void displayProjectHelp()
throws MavenException
@@ -1070,6 +1072,13 @@
displayGoals( pluginOnly, plugin, goals );
}
+ /**
+ * Display helpful information regarding all documented goals.
+ *
+ * @param pluginOnly show information for the given plugin only
+ * @param plugin plugin to show info for
+ * @param goals the set of goals
+ */
private void displayGoals( boolean pluginOnly, String plugin, Set goals )
{
Map map = new HashMap();
@@ -1159,6 +1168,12 @@
log.info( "" );
}
+ /**
+ * Display helpful information about the given goal.
+ *
+ * @param goalName goal to show info for
+ * @param goalDescription the description of the goal
+ */
private void displayGoal( String goalName, String goalDescription )
{
if ( "".equals( goalName ) )
@@ -1171,6 +1186,13 @@
log.info( msgPrefix + wrapConsoleMessage( goalDescription, WRAP_INDENT
+ 1, CONSOLE_WIDTH ) );
}
+ /**
+ * Display helpful information about the given default goal.
+ *
+ * @param goalName goal to show info for
+ * @param goalDescription the description of the goal
+ * @param newLine whether to append a newline
+ */
private void displayDefaultGoal( String goalName, String goalDescription,
boolean newLine )
{
if ( "".equals( goalName ) )
@@ -1269,6 +1291,14 @@
return buf.toString();
}
+ /**
+ * Reformat a message to display on the console.
+ *
+ * @param msg the message to display
+ * @param wrapIndent indent
+ * @param lineWidth line width
+ * @return String
+ */
private String wrapConsoleLine( String msg, int wrapIndent, int lineWidth )
{
int offset = lineWidth - wrapIndent;
