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 *
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
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 name | +Allows HTML | +Limited Elements | +Contained in JAR | +
---|---|---|---|
plugin.xml | +no | +no | +yes | +
plugin-help.xml | +no | +yes | +yes | +
plugin-enhanced.xml | +no | +yes | +no (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])