Author: dennisl
Date: Tue May 8 13:34:05 2007
New Revision: 536317
URL: http://svn.apache.org/viewvc?view=rev&rev=536317
Log:
o Improve documentation.
Modified:
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaCleanMojo.java
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaModuleMojo.java
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaMojo.java
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaProjectMojo.java
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaWorkspaceMojo.java
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/provide-deployment-descriptor-file.apt
maven/plugins/trunk/maven-idea-plugin/src/site/apt/library.apt
maven/plugins/trunk/maven-idea-plugin/src/site/fml/faq.fml
maven/plugins/trunk/maven-idea-plugin/src/site/site.xml
Modified:
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaCleanMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaCleanMojo.java?view=diff&rev=536317&r1=536316&r2=536317
==============================================================================
---
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaCleanMojo.java
(original)
+++
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaCleanMojo.java
Tue May 8 13:34:05 2007
@@ -28,7 +28,7 @@
import java.io.File;
/**
- * Plugin to remove existing idea files on the project
+ * Removes all existing IDEA files for the project.
*
* @goal clean
* @author Edwin Punzalan
Modified:
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaModuleMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaModuleMojo.java?view=diff&rev=536317&r1=536316&r2=536317
==============================================================================
---
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaModuleMojo.java
(original)
+++
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaModuleMojo.java
Tue May 8 13:34:05 2007
@@ -50,7 +50,7 @@
import java.util.regex.Pattern;
/**
- * Creates the module (*.iml) files for IntelliJ IDEA.
+ * Creates the module files (*.iml) for IntelliJ IDEA.
*
* @author Edwin Punzalan
* @goal module
@@ -81,7 +81,7 @@
private boolean linkModules;
/**
- * Specify the location of the deployment descriptor file, if one is
provided
+ * Specify the location of the deployment descriptor file, if one is
provided.
*
* @parameter expression="${deploymentDescriptorFile}"
*/
@@ -95,28 +95,28 @@
private boolean useFullNames;
/**
- * Enables/disables the downloading of source attachments. Defaults to
false.
+ * Enables/disables the downloading of source attachments.
*
* @parameter expression="${downloadSources}" default-value="false"
*/
private boolean downloadSources;
/**
- * Enables/disables the downloading of javadoc attachements. Defaults to
false.
+ * Enables/disables the downloading of javadoc attachments.
*
* @parameter expression="${downloadJavadocs}" default-value="false"
*/
private boolean downloadJavadocs;
/**
- * Sets the classifier string attached to an artifact source archive name
+ * Sets the classifier string attached to an artifact source archive name.
*
* @parameter expression="${sourceClassifier}" default-value="sources"
*/
private String sourceClassifier;
/**
- * Sets the classifier string attached to an artifact javadoc archive name
+ * Sets the classifier string attached to an artifact javadoc archive name.
*
* @parameter expression="${javadocClassifier}" default-value="javadoc"
*/
@@ -169,16 +169,17 @@
private static Map attemptedDownloads = new HashMap();
/**
- * Tell IntelliJ IDEA that this module is an IntelliJ IDEA Plugin
+ * Tell IntelliJ IDEA that this module is an IntelliJ IDEA Plugin.
*
* @parameter default-value="false"
*/
private boolean ideaPlugin;
/**
- * Specify the version of idea to use. This is needed to identify the
default formatting of
- * project-jdk-name used by idea. Currently supports 4.x and 5.x. <p/>
This will only be used
- * when parameter jdkName is not set.
+ * Specify the version of IDEA to target. This is needed to identify the
default formatting of
+ * project-jdk-name used by IDEA. Currently supports 4.x and 5.x.
+ * <p/>
+ * This will only be used when parameter jdkName is not set.
*
* @parameter expression="${ideaVersion}" default-value="5.x"
*/
Modified:
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaMojo.java?view=diff&rev=536317&r1=536316&r2=536317
==============================================================================
---
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaMojo.java
(original)
+++
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaMojo.java
Tue May 8 13:34:05 2007
@@ -59,7 +59,7 @@
private boolean linkModules;
/**
- * Specify the location of the deployment descriptor file, if one is
provided
+ * Specify the location of the deployment descriptor file, if one is
provided.
*
* @parameter expression="${deploymentDescriptorFile}"
*/
@@ -73,28 +73,28 @@
private boolean useFullNames;
/**
- * Enables/disables the downloading of source attachments. Defaults to
false.
+ * Enables/disables the downloading of source attachments.
*
* @parameter expression="${downloadSources}" default-value="false"
*/
private boolean downloadSources;
/**
- * Enables/disables the downloading of javadoc attachements. Defaults to
false.
+ * Enables/disables the downloading of javadoc attachments.
*
* @parameter expression="${downloadJavadocs}" default-value="false"
*/
private boolean downloadJavadocs;
/**
- * Sets the classifier string attached to an artifact source archive name
+ * Sets the classifier string attached to an artifact source archive name.
*
* @parameter expression="${sourceClassifier}" default-value="sources"
*/
private String sourceClassifier;
/**
- * Sets the classifier string attached to an artifact javadoc archive name
+ * Sets the classifier string attached to an artifact javadoc archive name.
*
* @parameter expression="${javadocClassifier}" default-value="javadoc"
*/
@@ -110,7 +110,7 @@
/**
* Specify the version of the JDK to use for the project for the purpose of
- * enabled assertions and 5.0 language features.
+ * enabled assertions and Java 5.0 language features.
* The default value is the specification version of the executing JVM.
*
* @parameter expression="${jdkLevel}"
@@ -150,8 +150,8 @@
/**
* Specify the resource pattern in wildcard format, for example
"?*.xml;?*.properties".
* Currently supports 4.x and 5.x.
- * The default value is any file without a java extension ("!?*.java").
* Because IDEA doesn't distinguish between source and resources
directories, this is needed.
+ * The default value corresponds to any file without a java extension.
* Please note that the default value includes package.html files as it's
not possible to exclude those.
*
* @parameter expression="${wildcardResourcePatterns}"
default-value="!?*.java"
@@ -159,13 +159,12 @@
private String wildcardResourcePatterns;
/**
- * Specify the version of idea to use. This is needed to identify the
default formatting of
- * project-jdk-name used by idea. Currently supports 4.x and 5.x.
+ * Specify the version of IDEA to target. This is needed to identify the
default formatting of
+ * project-jdk-name used by IDEA. Currently supports 4.x and 5.x.
* <p/>
* This will only be used when parameter jdkName is not set.
*
- * @parameter expression="${ideaVersion}"
- * default-value="5.x"
+ * @parameter expression="${ideaVersion}" default-value="5.x"
*/
private String ideaVersion;
@@ -178,7 +177,7 @@
private boolean dependenciesAsLibraries;
/**
- * Tell IntelliJ IDEA that this module is an IntelliJ IDEA Plugin
+ * Tell IntelliJ IDEA that this module is an IntelliJ IDEA Plugin.
*
* @parameter default-value="false"
*/
Modified:
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaProjectMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaProjectMojo.java?view=diff&rev=536317&r1=536316&r2=536317
==============================================================================
---
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaProjectMojo.java
(original)
+++
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaProjectMojo.java
Tue May 8 13:34:05 2007
@@ -38,7 +38,7 @@
import java.util.StringTokenizer;
/**
- * Creates the Project files (*.ipr) for IntelliJ IDEA.
+ * Creates the project file (*.ipr) for IntelliJ IDEA.
*
* @author Edwin Punzalan
* @goal project
@@ -57,7 +57,7 @@
/**
* Specify the version of the JDK to use for the project for the purpose of
- * enabled assertions and 5.0 language features.
+ * enabled assertions and Java 5.0 language features.
* The default value is the specification version of the executing JVM.
*
* @parameter expression="${jdkLevel}"
@@ -68,8 +68,8 @@
/**
* Specify the resource pattern in wildcard format, for example
"?*.xml;?*.properties".
* Currently supports 4.x and 5.x.
- * The default value is any file without a java extension ("!?*.java").
* Because IDEA doesn't distinguish between source and resources
directories, this is needed.
+ * The default value corresponds to any file without a java extension.
* Please note that the default value includes package.html files as it's
not possible to exclude those.
*
* @parameter expression="${wildcardResourcePatterns}"
default-value="!?*.java"
@@ -77,13 +77,12 @@
private String wildcardResourcePatterns;
/**
- * Specify the version of idea to use. This is needed to identify the
default formatting of
- * project-jdk-name used by idea. Currently supports 4.x and 5.x.
+ * Specify the version of IDEA to target. This is needed to identify the
default formatting of
+ * project-jdk-name used by IDEA. Currently supports 4.x and 5.x.
* <p/>
* This will only be used when parameter jdkName is not set.
*
- * @parameter expression="${ideaVersion}"
- * default-value="5.x"
+ * @parameter expression="${ideaVersion}" default-value="5.x"
*/
private String ideaVersion;
Modified:
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaWorkspaceMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaWorkspaceMojo.java?view=diff&rev=536317&r1=536316&r2=536317
==============================================================================
---
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaWorkspaceMojo.java
(original)
+++
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaWorkspaceMojo.java
Tue May 8 13:34:05 2007
@@ -28,7 +28,7 @@
import java.io.IOException;
/**
- * Creates workspace files (*.iws) for IntelliJ Idea
+ * Creates workspace file (*.iws) for IntelliJ IDEA.
*
* @author Edwin Punzalan
* @goal workspace
Modified:
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/provide-deployment-descriptor-file.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/provide-deployment-descriptor-file.apt?view=diff&rev=536317&r1=536316&r2=536317
==============================================================================
---
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/provide-deployment-descriptor-file.apt
(original)
+++
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/provide-deployment-descriptor-file.apt
Tue May 8 13:34:05 2007
@@ -37,9 +37,8 @@
[]
In cases where you want to provide your own descriptor files or if the
- descriptor files are located somewhere else, you can use the following:
-
- In the command-line:
+ descriptor files are located somewhere else, you can use the following on the
+ command-line:
+-----
mvn idea:idea -DdeploymentDescriptorFile=src/webapp/WEB-INF/web.xml
Modified: maven/plugins/trunk/maven-idea-plugin/src/site/apt/library.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/site/apt/library.apt?view=diff&rev=536317&r1=536316&r2=536317
==============================================================================
--- maven/plugins/trunk/maven-idea-plugin/src/site/apt/library.apt (original)
+++ maven/plugins/trunk/maven-idea-plugin/src/site/apt/library.apt Tue May 8
13:34:05 2007
@@ -1,5 +1,5 @@
------
- Libraries
+ Defining Libraries
------
Edwin Punzalan
------
@@ -24,7 +24,7 @@
~~ under the License.
-Using the Maven IDEA Plugin's <<<Libraries>>> Parameter
+Defining Libraries Using the <<<Libraries>>> Parameter
You can control the libraries that are generated by
<<<maven-idea-plugin>>> with the use of the <<<library>>>
Modified: maven/plugins/trunk/maven-idea-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/site/fml/faq.fml?view=diff&rev=536317&r1=536316&r2=536317
==============================================================================
--- maven/plugins/trunk/maven-idea-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-idea-plugin/src/site/fml/faq.fml Tue May 8
13:34:05 2007
@@ -26,11 +26,11 @@
</answer>
</faq>
<faq id="multi-project-handling">
- <question>How does the IDEA plugin work on multi-projects</question>
+ <question>How does the IDEA plugin work on multi-projects?</question>
<answer>
<p>
- Maven IDEA Plugin, by default, creates the project files (*.ipr) and
- the workspace files (*.iws) from where the root pom is located. Then
+ Maven IDEA Plugin, by default, creates the project file (*.ipr) and
+ the workspace file (*.iws) from where the root pom is located. Then
module files (*.iml) are created for each of the projects inside the
reactor.
</p>
Modified: maven/plugins/trunk/maven-idea-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/site/site.xml?view=diff&rev=536317&r1=536316&r2=536317
==============================================================================
--- maven/plugins/trunk/maven-idea-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-idea-plugin/src/site/site.xml Tue May 8 13:34:05
2007
@@ -28,7 +28,7 @@
<item name="FAQ" href="faq.html"/>
</menu>
<menu name="Configuration">
- <item name="Library Definition" href="library.html"/>
+ <item name="Defining Libraries" href="library.html"/>
</menu>
<menu name="Examples">
