jsdoc-user

[Jsdoc-user] JSDoc w/ Prototype's Class.create

[Noah S. <ns...@op...>]

Hello List,
I'm trying to use JSDoc with Prototype's Class.create, but I'm not
having any luck. I always get told "Nothing to document, exiting."  I
found another post about the scope tag, but it doesn't seem to help.

Here is my test file:

/**
 * My class
 * @class MyClass
 */
var MyClass = Class.create(
/** @scope MyClass */
{
	/**
	 * @constructor
	 * @param foo
	 */
	initialize: function(foo) {
		// do something
		this.foo = foo;
	},
	
	/**
	 * @return foo
	 */
	getFoo: function() {
		return this.foo;
	}
} );

Is there anything I can do to make this work or is this style simply
not supported? Any plans to support it? We're pretty dependent on
prototype's class support.

Cheers,
noah

Re: [Jsdoc-user] JSDoc w/ Prototype's Class.create

[Gabriel R. <gab...@gm...>]

Hi Noah,

> I'm trying to use JSDoc with Prototype's Class.create, but I'm not
> having any luck. I always get told "Nothing to document, exiting."  I
> found another post about the scope tag, but it doesn't seem to help.
>
> Here is my test file:
>
>  ...
>
> Is there anything I can do to make this work or is this style simply
> not supported? Any plans to support it? We're pretty dependent on
> prototype's class support.

No, this isn't currently suppported, and I'd say that there aren't any
plans to support it; JSDoc isn't really being actively maintained
anymore. The good news is that there is the JsDoc Toolkit
(http://www.jsdoc.info), which supports this and much more.

Regards,

Gabriel