mryozo16 / jsdoc-toolkit

Automatically exported from code.google.com/p/jsdoc-toolkit
0 stars 0 forks source link

Method no longer documented after upgrade to 2.0.beta2.2 #120

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago
What steps will reproduce the problem?
1. Run the attached Filter.js file through the latest version of the beta
(2.0beta2.2)
2. Look for the "create" method in the LABKEY.Filter namespace
3. It does not appear.

What is the expected output? What do you see instead?
I'd expect to see the "create" method documented on LABKEY.Filter, as it
used to appear on 2.0preview_1

What version of the product are you using? On what operating system?
2.0beta2.2 on WinXP

Please provide any additional information below.

Original issue reported on code.google.com by ekaynel...@gmail.com on 8 Apr 2008 at 4:55

Attachments:

GoogleCodeExporter commented 8 years ago
Checked the docs, and it does say: "The doc comment containing the @lends tag 
must
immediately precede an object literal in your code." (@scope is a synonym for 
@lends)

So you should write:

return
/** @scope LABKEY.Filter.prototype */ {
    // yada yada
}

That said, it should be possible for me to tweak things so that your original 
example
also works. I'll add that to the backlog for the next release.

Original comment by micmath on 8 Apr 2008 at 8:12

GoogleCodeExporter commented 8 years ago
Just confirmed that your instructions work perfectly.  Thank you!

I did indeed overlook the caution in the docs because the behavior used to 
work. 
Going forward, I do not consider it a high pri to accommodate both ways of 
including
the @scope comment.   I would consider my code buggy, not yours.

Original comment by ekaynel...@gmail.com on 8 Apr 2008 at 8:51

GoogleCodeExporter commented 8 years ago

Original comment by micmath on 8 Apr 2008 at 9:27