directory-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Felix Knecht <fe...@otego.com>
Subject Javadocs fixing/creating
Date Mon, 07 Jun 2010 08:04:07 GMT
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

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:dev@directory.apache.org\">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:dev@directory.apache.org">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/

iEYEARECAAYFAkwMp/cACgkQ2lZVCB08qHHBOQCg2C8KdvrQYnQBNcokhOkOh3Rx
fcIAmwY4a0Jlu/72qsk9WGr5usn6uh3P
=HbLW
-----END PGP SIGNATURE-----

Mime
View raw message