You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Stephen Colebourne (JIRA)" <ji...@apache.org> on 2017/05/08 13:47:04 UTC

[jira] [Created] (MJAVADOC-481) Java Update 121 allow-script-in-comments

Stephen Colebourne created MJAVADOC-481:
-------------------------------------------

             Summary: Java Update 121 allow-script-in-comments
                 Key: MJAVADOC-481
                 URL: https://issues.apache.org/jira/browse/MJAVADOC-481
             Project: Maven Javadoc Plugin
          Issue Type: Improvement
          Components: javadoc
    Affects Versions: 2.10.4
            Reporter: Stephen Colebourne


In its infinite wisdom, Oracle added a new command line flag in the standard doclet in JDK 8 update release 1.8.0_u121. By default, they now reject any script tags in headers and footers. An example use for these would be to add Google Analytics to the footer of each page of Javadoc. For example [see here|https://github.com/OpenGamma/Strata/blob/9712d78bec9f441024c30e9216e9b243fe679e2b/modules/pom.xml#L645] 

The rejection of scripts can be turned off using "--allow-script-in-comments" (note the double dash). The new flag can only be added to javadoc in 1.8.0u121 or later. If the flag is added to "additionalparam" and used on earlier releases of JDK 8, it will complain that it is an unrecognised flag.

Fortunately, it does seem that this works:

    <profile>
      <activation>
        <jdk>[1.8.0.121,]</jdk>
      </activation>
      <properties>
          <additionalparam>--allow-script-in-comments</additionalparam>
      </properties>
    </profile>

This needs to be exposed as a flag in Maven to provide an easy way to create a Maven pom.xml that is valid for all JDK 8 releases.

Thread complaining about the lack of release notes: http://mail.openjdk.java.net/pipermail/javadoc-dev/2017-January/thread.html
Issue in Gradle: https://github.com/gradle/gradle/issues/1393



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)