@param MUST be followed by ONE space
Status: Alpha
Brought to you by:
altumano
Steps to Reproduce:
- In a comment for a function, add a description for
the parameters. Separate the @param tag with at least
two spaces from the name of the parameters name. Eg:
@param p_sector business sector
@param p_sector2 business sector2
@param p_sector3 business sector3
Actual Results:
- The first parameter gets the wrong description. The
output looks like the following text:
"Parameters:
p_sector - business sector2
p_sector2 - business sector2
p_sector3 - business sector3"
Expected Results:
- correct description.
Build Date & Platform:
- V. 0.6.5, Win 2000, java version "1.3.1_01"
Logged In: YES
user_id=86901
There are also some related issues:
1) if some actual parameters are not decribed in the comment
using @param, they will receive wrong comments (from other
params)
2) input:
@param param_required decription of param_required
@param param decription of param
produces output:
param_required - decription of param_required
param - required decription of param_required
Logged In: YES
user_id=86901
Fix scheduled for release 0.x.x
Logged In: YES
user_id=86901
Fix scheduled for release 0.6.6