maven-plugins/javadoc/plugin.jelly

<?xml version="1.0"?>

<project 
  xmlns:ant="jelly:ant"
  xmlns:define="jelly:define"
  xmlns:doc="doc"
  xmlns:j="jelly:core" 
  xmlns:util="jelly:util">

  <goal name="maven-javadoc-plugin:register">
    <j:if test="${sourcesPresent}">
      <doc:registerReport 
        name="JavaDocs" 
        pluginName="maven-javadoc-plugin"
        link="apidocs/index"
        description="JavaDoc API documentation."/>
      <doc:registerReport 
        name="JavaDoc Report" 
        pluginName=""
        link="javadoc"
        description="Report on the generation of JavaDoc."/>
    </j:if>
  </goal>
  
  <goal name="maven-javadoc-plugin:deregister">
    <doc:deregisterReport name="JavaDocs"/>
    <doc:deregisterReport name="JavaDoc Report"/>
  </goal>

  <!-- ================================================================== -->
  <!-- J A V A D O C S                                                    -->
  <!-- ================================================================== -->

  <!-- Some aliases for ease of use and backward compat. -->
  <goal name="javadoc:generate" prereqs="maven-javadoc-plugin:report"/>
  <goal name="javadoc" prereqs="maven-javadoc-plugin:report"/>

  <goal name="maven-javadoc-plugin:report"
        prereqs="xdoc:init"
        description="Generate API documentation">

    <j:if test="${sourcesPresent == 'true'}">

      <ant:mkdir dir="${maven.javadoc.destdir}"/>
    
      <!-- Get the year to display in the Javadocs -->
      <ant:tstamp>
         <ant:format property="currentYear" pattern="yyyy"/>
      </ant:tstamp>
      <ant:tstamp>
        <j:choose>
          <j:when test="${pom.inceptionYear.equals(currentYear)}">
            <ant:format property="year" pattern="yyyy"/>
          </j:when>
          <j:otherwise>
            <ant:format property="year" pattern="${pom.inceptionYear}-yyyy"/>
          </j:otherwise>
        </j:choose>
      </ant:tstamp>

      <ant:property name="copyright"
        value="Copyright &amp;copy; ${year} ${pom.organization.name}. All Rights Reserved." />

      <ant:property name="title" value="${pom.name} ${pom.currentVersion} API"/>

      <j:choose>
        <j:when test="${maven.mode.online}"/>
        <j:otherwise>
          <j:set var="maven.javadoc.links" value=""/>
        </j:otherwise>
      </j:choose>

      <util:tokenize var="links" delim="," trim="true">${maven.javadoc.links}</util:tokenize>

      <j:forEach var="link" items="${links}">
        <ant:echo>Linking with API information from ${link.trim()} ...</ant:echo>
      </j:forEach>

      <j:set var="maxMemory" value="${maven.javadoc.maxmemory}" />

      <ant:mkdir dir="${maven.build.dir}/javadoc/" />
      <ant:record name="${maven.build.dir}/javadoc/report.txt" action="start" />

      <ant:javadoc
        sourcepathref="maven.compile.src.set"
        packagenames="${pom.package}.*"
        destdir="${maven.javadoc.destdir}"
        author="${maven.javadoc.author}"
        public="${maven.javadoc.public}"
        package="${maven.javadoc.package}" 
        private="${maven.javadoc.private}"
        version="${maven.javadoc.version}"
        use="${maven.javadoc.use}"
        windowtitle="${title}"
        doctitle="${title}"
        bottom="${copyright}"
        stylesheetfile="${maven.javadoc.stylesheet}"
        additionalparam="${maven.javadoc.additionalparam}">
        
        <j:if test="${context.getVariable('maven.javadoc.source') != null}">
          <ant:setProperty name="source" value="${maven.javadoc.source}" />
        </j:if>

        <j:forEach var="link" items="${links}">
          <ant:link href="${link.trim()}"/>
        </j:forEach>
        <ant:classpath>
          <ant:path refid="maven.dependency.classpath"/>
          <ant:path location="${maven.build.dest}"/>
        </ant:classpath>
      
        <j:if test="${maxMemory != null}">
          <ant:setProperty name="maxmemory" value="${maven.javadoc.maxmemory}" />
        </j:if>

        <j:forEach var="packageGroup" items="${pom.packageGroups}">
          <ant:group title="${packageGroup.title}" packages="${packageGroup.packages}"/>
        </j:forEach>
  
        <!-- allow custom doclets -->    
        <j:if test="${context.getVariable('maven.javadoc.doclet') != null}">
          <ant:setProperty name="doclet" value="${maven.javadoc.doclet}" />
        </j:if>
        <j:if test="${context.getVariable('maven.javadoc.docletpath') != null}">
          <ant:setProperty name="doclet" value="${maven.javadoc.docletpath}" />
        </j:if>
        
        <!-- allow custom tags -->    
        <util:tokenize var="listOfTags" delim=" ">${maven.javadoc.customtags}</util:tokenize>
        <j:forEach var="someTag" items="${listOfTags}">
          <j:set var="nameVar" value="${someTag}.name"/>
          <j:set var="name" value="${context.findVariable(nameVar)}"/>
          <j:set var="descriptionVar" value="${someTag}.description"/>
          <j:set var="description" value="${context.findVariable(descriptionVar)}"/>
          <j:set var="enabledVar" value="${someTag}.enabled"/>
          <j:set var="enabled" value="${context.findVariable(enabledVar)}"/>
          <j:set var="scopeVar" value="${someTag}.scope"/>
          <j:set var="scope" value="${context.findVariable(scopeVar)}"/>
          <ant:tag name="${name}" description="${description}"
               enabled="${enabled}" scope="${scope}"/>
        </j:forEach>

      </ant:javadoc>
      <ant:record name="${maven.build.dir}/javadoc/report.txt" action="stop" />

      <j:set var="genDocs" value="${pom.getPluginContext('maven-xdoc-plugin').getVariable('maven.gen.docs')}" />
      <doc:text-xdoc
        title="Javadoc Report"
        section="Javadoc Report"
        inputFile="${maven.build.dir}/javadoc/report.txt"
        output="${genDocs}/javadoc.xml"/>
    </j:if>

  </goal>

</project>