Re: svn commit: r1297284 [1/2] - in /xmlgraphics/fop/trunk: ./ src/codegen/unicode/java/org/apache/fop/complexscripts/bidi/ src/java/org/apache/fop/afp/util/ src/java/org/apache/fop/complexscripts/bidi/ src/java/org/apache/fop/complexscripts/fonts/ src/jav...

[Vincent Hennebert <vh...@gmail.com>]

Hi Glenn,

On 05/03/12 23:29, gadams wrote:
> Author: gadams
> Date: Mon Mar  5 23:29:29 2012
> New Revision: 1297284
<snip/>
> Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/complexscripts/bidi/BidiConstants.java
> URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/complexscripts/bidi/BidiConstants.java?rev=1297284&r1=1297283&r2=1297284&view=diff
> ==============================================================================
> --- xmlgraphics/fop/trunk/src/java/org/apache/fop/complexscripts/bidi/BidiConstants.java (original)
> +++ xmlgraphics/fop/trunk/src/java/org/apache/fop/complexscripts/bidi/BidiConstants.java Mon Mar  5 23:29:29 2012
> @@ -21,8 +21,9 @@ package org.apache.fop.complexscripts.bi
>  
>  
>  /**
> - * Constants used for bidirectional processing.
> - * @author Glenn Adams
> + * <p>Constants used for bidirectional processing.</p>

The first sentence of a Javadoc comment should not be enclosed in <p>
tags, even if there are other paragraphs that follow. This is not a big
deal, but it’s just non-standard Java practice.


> + *
> + * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
>   */

I think I would have preferred this to be in a non-Javadoc comment after
the license header, as I don’t think this kind of information is
relevant in a Javadoc, but again it doesn’t matter too much.

<snip/>

Vincent