-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 On 06/07/10 10:20, Pierre-Arnaud Marcelot wrote: > Hi Felix, > > Sounds very interesting to have this done automatically. > > May I suggest that we add something like "TODO: Review and document me!" (or > something equivalent) in the template, to make sure the classes and > interfaces get well documented some day. > It would be easier to find javadocs with missing information.
I agree, but I haven't found yet where to override this to set a TODO ... > > Regards, > Pierre-Arnaud > > On 7 juin 2010, at 10:04, Felix Knecht wrote: > > Hi dev > > Are you aware of > http://maven.apache.org/plugins/maven-javadoc-plugin/fix-mojo.html? > > This will create (depending on the properties you set on CLI) missing > javadocs on in the source files. Properties can also be configured in > each project pom.xml. > > I suggest to fix at least ClassComments for now. Resulting is shown in > sample below. > > WDYT? > > Following will e.g. fix the ClassComment and add a missing @author tag: > > mvn javadoc:fix -DdefaultAuthor="<a > href=\"mailto:[email protected]\";>Apache Directory Project</a>" > -DfixTags="author" -DfixFieldComment=false -DfixMethodComment=false > -Dforce > > like > > Index: > ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/LdapAsyncConnection.java > =================================================================== > --- > ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/LdapAsyncConnection.java > (revision 952127) > +++ > ldap-client-api/src/main/java/org/apache/directory/ldap/client/api/LdapAsyncConnection.java > (working copy) > @@ -25,6 +25,11 @@ > import org.apache.directory.shared.ldap.name.DN; > > > +/** > + * <p>LdapAsyncConnection interface.</p> > + * > + * @author <a href="mailto:[email protected]";>Apache Directory > Project</a> > + */ > public interface LdapAsyncConnection extends LdapConnection > { > > @@ -184,4 +189,4 @@ > * @return > */ > LdapConnectionConfig getConfig(); > -} > \ No newline at end of file > +} -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.15 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iEYEARECAAYFAkwMrPkACgkQ2lZVCB08qHFcBwCfW9AROWbfgBe0GfOyOezNu4Ha vesAoKunRvq7R3Fy5PdBtFwHH+bjUAD9 =Zm6G -----END PGP SIGNATURE-----
