readyou / jsdoc-toolkit

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

members mistakenly recognized as static #266

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
What steps will reproduce the problem?
1. Save this code to test.js:

(function() {
    /**
     * @class yaddayadda
     * @name Test
     * @constructor
     */
    exports.Test = function() {
        /**
         * @name run
         * @methodOf Test
         */
    this.run = function() {
        };
    };
})();

2. run $ ./jsrun.sh -t=templates/jsdoc test.js

What is the expected output? What do you see instead?

I'd expect the Test.html to document "run" as method on Test that is *not* 
static. However, it 
declares it to be static. I don't know how to convince JSDoc that it is not 
static.

What version of the product are you using? On what operating system?

JSDoc Toolkit 2.3.2 on Mac OS X 10.6.1

Please provide any additional information below.

Original issue reported on code.google.com by szege...@gmail.com on 10 Nov 2009 at 11:20

GoogleCodeExporter commented 9 years ago
@methodOf Test
means static Test.run
whereas
@methodOf Test#
means instance someTest.run

Original comment by micmath on 12 Nov 2009 at 10:06

GoogleCodeExporter commented 9 years ago
Maybe you should document that in the wiki page for memberOf.
It's not clear that you can do this:
@memberOf Something#
or this:
@memberOf Something.
That would probably save a lot of time to users and yourself too.
It could even be documented in the Namepaths section.

Original comment by jbm...@gmail.com on 16 Nov 2009 at 4:27