[BUILD-200] Introduce asciidoc for Javadoc Created: 16/Mar/15 Updated: 07/Jul/16 Resolved: 04/May/15 |
|
| Status: | Closed |
| Project: | Build |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | POMs 31 |
| Type: | New Feature | Priority: | Major |
| Reporter: | Magnolia International | Assignee: | Magnolia International |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Attachments: |
|
||||||||||||||||||||||||
| Issue Links: |
|
||||||||||||||||||||||||
| Template: |
|
||||||||||||||||||||||||
| Acceptance criteria: |
Empty
|
||||||||||||||||||||||||
| Description |
|
See
This is also related to |
| Comments |
| Comment by Magnolia International [ 16/Mar/15 ] |
|
This works neatly, but unfortunately is not lenient towards existing html-based javadocs. |
| Comment by Magnolia International [ 17/Mar/15 ] |
|
Suggestions by johncarl81 are very good. I'm thinking:
|
| Comment by Magnolia International [ 17/Mar/15 ] |
|
This script can be used, e.g: |
| Comment by Magnolia International [ 17/Mar/15 ] |
|
And we could apply this patch to enable projects to opt-out (I'd rather opt-in, but once more Maven's lack of the simplest boolean logic in properties doesn't make it possible) diff --git a/poms/super-pom/pom.xml b/poms/super-pom/pom.xml
index 5f79dca..fb0a5b8 100644
--- a/poms/super-pom/pom.xml
+++ b/poms/super-pom/pom.xml
@@ -57,6 +57,8 @@
to reconfigure said plugins.
-->
<skipTestJar>true</skipTestJar>
+ <!-- Set to empty to use the standard Javadoc Doclet -->
+ <javadocDocletClass>org.asciidoctor.Asciidoclet</javadocDocletClass>
</properties>
<build>
@@ -144,6 +146,12 @@
<configuration>
<detectOfflineLinks>false</detectOfflineLinks>
<detectLinks>false</detectLinks>
+ <doclet>${javadocDocletClass}</doclet>
+ <docletArtifact>
+ <groupId>org.asciidoctor</groupId>
+ <artifactId>asciidoclet</artifactId>
+ <version>1.5.2</version>
+ </docletArtifact>
</configuration>
</plugin>
<plugin>
|
| Comment by Magnolia International [ 18/Mar/15 ] |
|
Needs validation - do we all want this ? |
| Comment by Magnolia International [ 18/Mar/15 ] |
|
Alternative proposal: in projects, pick which one you want:
<properties>
<javadocDoclet>${standardDoclet}</javadocDoclet>
</properties>
or
<properties>
<javadocDoclet>${asciidocDoclet}</javadocDoclet>
</properties>
|
| Comment by Magnolia International [ 04/May/15 ] |
|
Default is kept to standard doclet. Projects can explicitely use either:
<properties>
<javadocDoclet>${standardDoclet}</javadocDoclet>
</properties>
or
<properties>
<javadocDoclet>${asciidocDoclet}</javadocDoclet>
</properties>
|