diff --git a/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginDescriptorFilesGenerator.java b/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginDescriptorFilesGenerator.java index f0c485b8..7a0d9335 100644 --- a/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginDescriptorFilesGenerator.java +++ b/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginDescriptorFilesGenerator.java @@ -52,7 +52,7 @@ * Serializes *
    *
  1. a standard Maven Plugin Descriptor XML file
  2. - *
  3. a descriptor containing a limited set of attributes for {@link PluginHelpGenerator}
  4. + *
  5. a descriptor containing a limited set of elements for {@link PluginHelpGenerator}
  6. *
  7. an enhanced descriptor containing HTML values for some elements (instead of plain text as for the other two) * for {@link PluginXdocGenerator}
  8. *
@@ -116,10 +116,10 @@ public void writeDescriptor(File destinationFile, PluginToolsRequest request, De final String additionalInfo; switch (type) { case LIMITED_FOR_HELP_MOJO: - additionalInfo = " (for help'mojo with additional elements)"; + additionalInfo = " (for help mojo with limited elements)"; break; case XHTML: - additionalInfo = " (enhanced XHTML version with additional elements (used for plugin:report))"; + additionalInfo = " (enhanced XHTML version (used for plugin:report))"; break; default: additionalInfo = ""; diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml index 008c1403..e62096ae 100644 --- a/src/site/xdoc/index.xml +++ b/src/site/xdoc/index.xml @@ -122,15 +122,43 @@ -

The plugin descriptor is first being generated in memory finally containing some values in HTML format before being persisted into three different formats. +

The plugin descriptor is first being generated in memory finally containing some values in HTML format before being persisted into three different XML files. The formats differ in

Javadoc tags are in general being resolved and replaced by their XHTML value before they end up in the according plugin descriptor attributes description and deprecated. Also javadoc code links via {@link} or @see are replaced by links to the according Javadoc pages if configured accordingly. + Plaintext is afterwards being generated out of the XHTML (where most XHTML element are just stripped and links are emitted inside angle brackets).

+ + + + + + + + + + + + + + + + + + + + + + + + + +
File nameAllows HTMLLimited ElementsContained in JAR
plugin.xmlnonoyes
plugin-help.xmlnoyesyes
plugin-enhanced.xmlnoyesno (volatile file)

diff --git a/src/site/xdoc/plugin-descriptors.mmd b/src/site/xdoc/plugin-descriptors.mmd index 5a78273b..8a5e0f35 100644 --- a/src/site/xdoc/plugin-descriptors.mmd +++ b/src/site/xdoc/plugin-descriptors.mmd @@ -8,8 +8,8 @@ flowchart LR P3 --> |populates| P4 subgraph output["Plugin Descriptors Serializations"] O1(["plugin.xml (plain text)"]) - O2(["plugin-help.xml (plain text)"]) - O3(["plugin-enhanced.xml (html)"]) + O2(["plugin-help.xml (plain text with extended elements)"]) + O3(["plugin-enhanced.xml (html, transient, not part of final JAR)"]) end subgraph generators["maven-plugin-tools-generators"] G1["PluginXdocGenerator"] --> |generates| R2([XDoc])