Hi Marco,

You are right. But where can I find information about the order of such
parameter settings? I use Eclipse. After I type the @ and Ctrl-space, I get
a context menu with a list of paramaters such as @reture, @see etc. I wonder
there  should be something like @comments.

Regards

Thomas




Marco Huber wrote:
> 
> Hi Thomas,
> 
> I think you don't use the javadoc correctly.
> 
> You comment must be followed by the @param tags:
> 
> /**
>   * My comments: This function sets ...
>   *
>   * @param i Percentage
>   */
> 
> See also http://java.sun.com/j2se/javadoc/writingdoccomments/
> 
> Regards
> Marco
> 
> thomas2004 wrote:
>> A class looks as follow:
>> 
>> /**
>>  * 
>>  * @author Thomas
>>  * 
>>  */
>> public class PriceIncrease {
>>      /** Logger for this class and subclasses */
>>      protected final Log logger = LogFactory.getLog(getClass());
>> 
>>      private int percentage;
>>      
>>      /**
>>       * 
>>       * @param i Percentage
>>          * My comments: This function sets ...
>>       */
>>      public void setPercentage(int i) {
>>              percentage = i;
>>              logger.info("Percentage set to " + i);
>>      }
>> ...
>> }
>> 
>> After I used maven site, the JavaDocs are generated. But as I open this
>> class in javadocs, I see the followings:
>> 
>> setPercentage
>> public void setPercentage(int i)Parameters:
>> i - Percentage
>> 
>> I can't see the text of MyComments, why?
>> 
>> 
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: [EMAIL PROTECTED]
> For additional commands, e-mail: [EMAIL PROTECTED]
> 
> 
> 

-- 
View this message in context: 
http://www.nabble.com/A-question-about-maven-site-and-the-created-JavaDocs-tp18525606p18528256.html
Sent from the Maven - Users mailing list archive at Nabble.com.


---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to