You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by sk...@apache.org on 2008/06/25 19:49:21 UTC
svn commit: r671613 - in
/myfaces/myfaces-build-tools/trunk/maven2-plugins/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder:
BuildMetaDataMojo.java MakeConfigMojo.java
Author: skitching
Date: Wed Jun 25 10:49:20 2008
New Revision: 671613
URL: http://svn.apache.org/viewvc?rev=671613&view=rev
Log:
Make javadoc xhtml-compatible. It appears that the maven mojo documentation report requires javadoc on some fields and methods to be not just valid javadoc but actually valid xhtml. Without this, "mvn site" fails.
Modified:
myfaces/myfaces-build-tools/trunk/maven2-plugins/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/BuildMetaDataMojo.java
myfaces/myfaces-build-tools/trunk/maven2-plugins/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/MakeConfigMojo.java
Modified: myfaces/myfaces-build-tools/trunk/maven2-plugins/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/BuildMetaDataMojo.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/trunk/maven2-plugins/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/BuildMetaDataMojo.java?rev=671613&r1=671612&r2=671613&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/trunk/maven2-plugins/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/BuildMetaDataMojo.java (original)
+++ myfaces/myfaces-build-tools/trunk/maven2-plugins/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/BuildMetaDataMojo.java Wed Jun 25 10:49:20 2008
@@ -47,10 +47,11 @@
* purposes:
* <ul>
* <li>It is needed if other projects then use the maven-builder-plugin to
- * create subclasses of the jsf classes in this project.
+ * create subclasses of the jsf classes in this project.</li>
* <li>It is good documentation (more precise than the tld and faces-config.xml
- * files).
+ * files).</li>
* </ul>
+ * </p>
* <p>
* Note that the generated file contains all the metadata needed by this
* project, including a copy of all the metadata from other projects that
@@ -58,6 +59,7 @@
* just the generated metadata as input, without needing to load other
* projects. Each entry in the metadata is labelled with a "modelId"
* property that indicates where it originally came from.
+ * </p>
*
* @requiresDependencyResolution compile
* @goal build-metadata
@@ -79,6 +81,7 @@
* This mojo registers the specified directory with Maven as a resource dir. The
* maven-resources-plugin will then read the files from this dir and copy them
* into the "central" target directory from which the jarfile is built.
+ * </p>
*
* @parameter expression="${project.build.directory}/myfaces-builder-plugin/main/resources"
*/
@@ -97,13 +100,14 @@
* <p>
* This value <i>must</i> be unique for each project. If not specified,
* then it defaults to the artifactId of the current maven project.
+ * </p>
* <p>
* In later phases, goals are passed the complete metadata model which
* mixes items discovered here with items imported from metadata in
* other projects. The modelId is used to figure out which of the
* items should be processed (ie which ones are associated with this
* project) and which should be ignored.
- * <p>
+ * </p>
*
* @parameter expression="${project.artifactId}"
*/
@@ -114,18 +118,21 @@
* <p>
* This allows a project that inherits metadata from some other project to force
* copies of the Tag classes to be created in a namespace of its own choosing.
+ * </p>
* <p>
* This is used in particular to create copies of the Tag classes in myfaces-impl
* within other projects so that they can be used as base classes for other tags
* within that project. The original tag present in the myfaces-impl.jar cannot
* be used as a base because that would prevent the derived project from running
* with other JSF implementations.
+ * </p>
* <p>
* The child project first defines this (and replacePackagePrefixTagTo); as the
* inherited metadata is merged the tagClass attribute is modified. Then during
* the tag class generation goal, the modelId of the inherited project is included
* in the list of modelIds to process. That causes the tag classes to be generated
* again - but this time in a different package.
+ * </p>
*
* @parameter
*/
@@ -135,6 +142,7 @@
* Replace the package prefix
* <p>
* See replacePackagePrefixTagTo.
+ * </p>
*
* @parameter
*/
@@ -146,10 +154,12 @@
* When two different models define exactly the same item (ie the "class" attribute
* for two items is the same) then the one from the model that is merged first is
* used, and the later one is ignored.
+ * </p>
* <p>
* This property allows the order of merging to be controlled; models are merged in
* the order specified in this list. Any models whose ids are not in this list are
* then merged in an undefined order at the end.
+ * </p>
* <p>
* Setting this property is not normally necessary; typically models inherited from
* dependencies define different model items (ie have no overlap). However consider
@@ -161,8 +171,10 @@
* ensure that project B's metadata is loaded first; this can possibly hide any new
* features (or bugfixes) from the new release of A, but also ensures that classes
* in C which extend classes in B do not declare features that B does not support.
+ * </p>
* <p>
* This property is only needed in rare situations; normally it can be omitted.
+ * </p>
*
* @parameter
*/
@@ -175,8 +187,10 @@
* merge all the data into the model for this project. If this property is set,
* then metadata found in dependencies is only merged if the modelId matches one
* in this list.
+ * </p>
* <p>
* Note that by default, a project's modelId is the same as the artifactId.
+ * </p>
*
* @parameter
*/
@@ -188,24 +202,29 @@
* This file is always loaded first, before any metadata from dependencies is
* loaded, and before scanning of the source directories for the current
* project is done.
+ * </p>
* <p>
* The specified filename is relative to the current working directory.
+ * </p>
* <p>
* Normally, this option is not used and any models that this project extends
* are simply automatically detected via scanning of the maven dependencies and
* loaded from the dependency jarfile. However there are a couple of situations
* where it is useful to specify an explicit metadata file to load instead.
+ * </p>
* <p>
* One example is when a project extends components in a project which was not
* built with the myfaces-builder-plugin (or where myfaces-builder-plugin
* support is only in a not-yet-released version). In this case, a metadata file
* can be created by hand (or generated from the unreleased trunk version) and
* explicitly loaded via this property.
+ * </p>
* <p>
* A second example is when it is necessary to add some custom model definitions to
* the model to be built, eg to override buggy or missing metadata in a project
* that this project extends. Of course this is hopefully not needed; it would be
* better to get a bugfix release of the parent project out instead!
+ * </p>
*
* @parameter
*/
Modified: myfaces/myfaces-build-tools/trunk/maven2-plugins/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/MakeConfigMojo.java
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/trunk/maven2-plugins/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/MakeConfigMojo.java?rev=671613&r1=671612&r2=671613&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/trunk/maven2-plugins/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/MakeConfigMojo.java (original)
+++ myfaces/myfaces-build-tools/trunk/maven2-plugins/myfaces-builder-plugin/src/main/java/org/apache/myfaces/buildtools/maven2/plugin/builder/MakeConfigMojo.java Wed Jun 25 10:49:20 2008
@@ -57,24 +57,27 @@
* velocity template file and generate a single output file. The template is
* passed the full metadata model object, and can select from the model whatever
* data it wants.
+ * </p>
* <p>
* The execution can be configured with:
* <ul>
- * <li>The name of the input template to be executed
- * <li>The name of the output file to be created
+ * <li>The name of the input template to be executed</li>
+ * <li>The name of the output file to be created</li>
* <li>Any number of variables which are accessable from the template
- * (string values only)
+ * (string values only)</li>
* </ul>
+ * </p>
* <p>
* The executed template has the following variables available to it:
* <ul>
- * <li>model: the full metadata model for this project
- * <li>modelIds: specifies which items from the model should be processed
- * <li>baseContent: the full text of the contents of the "xmlBaseFile" (if any)
- * <li>utils: an instance of MyfacesUtils that provides static helper methods
+ * <li>model: the full metadata model for this project</li>
+ * <li>modelIds: specifies which items from the model should be processed</li>
+ * <li>baseContent: the full text of the contents of the "xmlBaseFile" (if any)</li>
+ * <li>utils: an instance of MyfacesUtils that provides static helper methods</li>
* <li>and whatever (name,value) pairs were configured via the "params" property
- * of this mojo.
+ * of this mojo.</li>
* </ul>
+ * </p>
*
* @requiresDependencyResolution compile
* @goal make-config
@@ -121,14 +124,17 @@
* <p>
* If not defined, then this defaults to a list containing just one string whose
* value is the same as the current maven project's artifactId.
+ * </p>
* <p>
* The complete metadata model is passed to the velocity template. This contains
* data about not just the model items defined in the calling project, but also
* about items imported from other projects. Each item in the model is
* labelled with a "model id" indicating which project it was defined by.
+ * </p>
* <p>
* This list of model ids is also passed to the template. The template can
* then use that data to select the relevant items from the full model.
+ * </p>
*
* @parameter
*/
@@ -150,14 +156,17 @@
* automatically generated. All content beneath the root element of the specified
* file (but not the root element itself) is placed into a Velocity variable
* named "baseContent" that the template can reference.
+ * </p>
* <p>
* The template can do whatever it wants with this variable, but it is expected
* that the template will simply output this immediately after writing the
* root element of the output xml file.
* file.
+ * </p>
* <p>
* Note that any attributes or namespaces defined on the root element of the
* xmlBaseFile are ignored.
+ * </p>
*
* @parameter expression="src/main/conf/META-INF/faces-config-base.xml"
*/
@@ -183,6 +192,7 @@
* <p>
* The metadata model is loaded, and the specified template is executed with
* any template output being written to the specified output file.
+ * </p>
*/
public void execute() throws MojoExecutionException
{