aspose file tools*
The moose likes Java in General and the fly likes @param in javadocs Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Java » Java in General
Bookmark "@param in javadocs" Watch "@param in javadocs" New topic
Author

@param in javadocs

kamba
Greenhorn

Joined: Jan 06, 2003
Posts: 2
Hello,
I'm trying to use the @param function in javadocs and I keep getting a warning message " arrayOfIntegers is not a parameter name ".
I am a little confused as to why javadocs is not seeing my declarations.
Here is what my code is saying:
int arrayOfIntegers[] = new int[100];
and here is my @param statement:
@param arrayOfIntegers - An array of Integers to be created
I must be missing something very simple but I just can't figure it out. I was just wondering if you could not use @param for arrays?
Any help would be greatly appreciated.
Thanks,
kamba.
Herb Schildt
Author
Ranch Hand

Joined: Oct 01, 2003
Posts: 239
Kamba:
@param is used to document a parameter. For example,

Here, str is a parameter to meth(). @param is not for documenting local variables.


For my latest books on Java, including my Java Programming Cookbook, see HerbSchildt.com
kamba
Greenhorn

Joined: Jan 06, 2003
Posts: 2
Thanks for the help. I see where my mistake was, I java the javadocs working now.
Thanks,
Kamba
Ernest Friedman-Hill
author and iconoclast
Marshal

Joined: Jul 08, 2003
Posts: 24183
    
  34

Kamba,
Welcome to JavaRanch!
We don't have many rules here at the ranch, but we do have our naming policy, which requires that your display name include both a first and last name. Please head over here and fix yours right away. Thanks, pardner -- see you around the Ranch!


[Jess in Action][AskingGoodQuestions]
 
jQuery in Action, 2nd edition
 
subject: @param in javadocs