stephenc
/
maven-plugin-tools
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

o normalize date and comments 

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@685842 13f79535-47bb-0310-9956-ffa450edef68
master
Vincent Siveton 2008-08-14 10:43:01 +00:00
parent da57cba2a1
commit f178cd48a8
6 changed files with 32 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
maven-plugin-plugin/src/site/apt/examples/generate-descriptor.apt
View File

@ -3,7 +3,7 @@
------ ------
Maria Odea Ching Maria Odea Ching
------ ------
February 2008 2008-02-01
------ ------
~~ Licensed to the Apache Software Foundation (ASF) under one ~~ Licensed to the Apache Software Foundation (ASF) under one
@ -23,6 +23,9 @@
~~ specific language governing permissions and limitations ~~ specific language governing permissions and limitations
~~ under the License. ~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
Configuring Generation of Plugin Descriptor Configuring Generation of Plugin Descriptor
To configure the generation of the plugin descriptor, add the following to the project's POM: To configure the generation of the plugin descriptor, add the following to the project's POM:

5
maven-plugin-plugin/src/site/apt/examples/generate-help.apt
View File

@ -3,7 +3,7 @@
------ ------
Vincent Siveton Vincent Siveton
------ ------
January 2008 2008-01-01
------ ------
~~ Licensed to the Apache Software Foundation (ASF) under one ~~ Licensed to the Apache Software Foundation (ASF) under one
@ -23,6 +23,9 @@
~~ specific language governing permissions and limitations ~~ specific language governing permissions and limitations
~~ under the License. ~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
Configuring Generation of Help Mojo Configuring Generation of Help Mojo
To configure the generation of a <<<Help>>> Mojo, add the following to the project's POM: To configure the generation of a <<<Help>>> Mojo, add the following to the project's POM:

5
maven-plugin-plugin/src/site/apt/examples/generate-report.apt
View File

@ -3,7 +3,7 @@
------ ------
Vincent Siveton Vincent Siveton
------ ------
January 2008 2008-01-01
------ ------
~~ Licensed to the Apache Software Foundation (ASF) under one ~~ Licensed to the Apache Software Foundation (ASF) under one
@ -23,6 +23,9 @@
~~ specific language governing permissions and limitations ~~ specific language governing permissions and limitations
~~ under the License. ~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
Configuring Generation of Documentation Reports Configuring Generation of Documentation Reports
To configure the generation of the documentation reports, add the following to the project's POM: To configure the generation of the documentation reports, add the following to the project's POM:

5
maven-plugin-plugin/src/site/apt/index.apt
View File

@ -3,7 +3,7 @@
------ ------
Maria Odea Ching Maria Odea Ching
------ ------
January 2008 2008-01-01
------ ------
~~ Licensed to the Apache Software Foundation (ASF) under one ~~ Licensed to the Apache Software Foundation (ASF) under one
@ -23,6 +23,9 @@
~~ specific language governing permissions and limitations ~~ specific language governing permissions and limitations
~~ under the License. ~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
Maven Plugin Plugin Maven Plugin Plugin
The Maven Plugin Plugin is used to create a Maven plugin descriptor for any The Maven Plugin Plugin is used to create a Maven plugin descriptor for any

21
maven-plugin-plugin/src/site/apt/multiple-language-support.apt
View File

@ -3,9 +3,9 @@
--- ---
John Casey John Casey
--- ---
09-Feb-2005 2005-02-09
--- ---
~~ Licensed to the Apache Software Foundation (ASF) under one ~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file ~~ or more contributor license agreements. See the NOTICE file
~~ distributed with this work for additional information ~~ distributed with this work for additional information
@ -23,28 +23,31 @@
~~ specific language governing permissions and limitations ~~ specific language governing permissions and limitations
~~ under the License. ~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
<<THIS NEEDS REVISION AND CLEANING UP>> <<THIS NEEDS REVISION AND CLEANING UP>>
*Abstract *Abstract
The Plugin Plugin needs to be refactored in order to support multiple mojo The Plugin Plugin needs to be refactored in order to support multiple mojo
implementation languages. This document will detail the steps needed to implementation languages. This document will detail the steps needed to
add this functionality. add this functionality.
*Current Status *Current Status
The Plugin Plugin currently calls out to a set of generators in the The Plugin Plugin currently calls out to a set of generators in the
maven-plugin-tools library, which in turn uses QDox to generate various things maven-plugin-tools library, which in turn uses QDox to generate various things
based on annotations in the java source code. based on annotations in the java source code.
*Refactored Design *Refactored Design
The new design will have a generator-manager which is a component that the The new design will have a generator-manager which is a component that the
plugin mojos will lookup. This component will have access to a mapping of all plugin mojos will lookup. This component will have access to a mapping of all
generators and the language they're registered for. It'll iterate through the generators and the language they're registered for. It'll iterate through the
mappings, and extract mojo descriptors from all relevant scripts/sources using mappings, and extract mojo descriptors from all relevant scripts/sources using
each language's registered generator. Results from each generator will be each language's registered generator. Results from each generator will be
centrally aggregated by the generator-manager. After all generators have run, centrally aggregated by the generator-manager. After all generators have run,
the generator-manager will call another class (depending on what it's meant to the generator-manager will call another class (depending on what it's meant to
produce) to take all the aggregated mojo descriptors and produce a result produce) to take all the aggregated mojo descriptors and produce a result
(such as <<<plugin.xml>>> file for the project). (such as <<<plugin.xml>>> file for the project).

5
maven-plugin-plugin/src/site/apt/usage.apt
View File

@ -4,7 +4,7 @@
Maria Odea Ching Maria Odea Ching
Vincent Siveton Vincent Siveton
------ ------
January 2008 2008-01-01
------ ------
~~ Licensed to the Apache Software Foundation (ASF) under one ~~ Licensed to the Apache Software Foundation (ASF) under one
@ -24,6 +24,9 @@
~~ specific language governing permissions and limitations ~~ specific language governing permissions and limitations
~~ under the License. ~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
Usage Usage
The Plugin Plugin is generally used for Maven 2 plugins. Its goals are bound to different phases in the build life cycle. The Plugin Plugin is generally used for Maven 2 plugins. Its goals are bound to different phases in the build life cycle.