directory-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Felix Knecht <fel...@apache.org>
Subject Re: Javadocs fixing/creating
Date Mon, 07 Jun 2010 09:00:34 GMT
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

> Yes, sure, we can use this guy. But I would rather expect that we
> manually add the missing Javadoc, assuming that the generated reports
> tell us which ones are missing.
> 
> My fear is that we consider a missing header as a non issue, as the mavn
> plugin will 'fix it'...
> 
> Also it may create some burden as you will have some more file to commit.

We can add just the configuration to the pom.xml/build section like
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <configuration>
          <defaultAuthor>&lt;a
href="mailto:dev@directory.apache.org\"&gt;Apache Directory
Project&lt;/a&gt;</defaultAuthor>
          <fixTags>author,param,return,throws</fixTags>
          <level>private</level>
          <force>true</force>
        </configuration>
      </plugin>

This will not be executed when running a simple mvn clean install. One
still will need to run mvn javadoc:fix from CLI, but you don't need to
have all the relevant properties to set.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.15 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAkwMtTIACgkQ2lZVCB08qHEZkgCg8HbdNR6iQwo0ExWs5FDimsCC
QYAAn1g0TAvQ35LkQY1iAo11wPDrd78N
=d0C9
-----END PGP SIGNATURE-----

Mime
View raw message