• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

@param in javadocs

 
kamba
Greenhorn
Posts: 2
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 253
6
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Kamba:
@param is used to document a parameter. For example,

Here, str is a parameter to meth(). @param is not for documenting local variables.
 
kamba
Greenhorn
Posts: 2
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Pie
Posts: 24212
35
Chrome Eclipse IDE Mac OS X
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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!
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic