jsdoc-user

[Jsdoc-user] Indicating a getter that might throw?

[Mook <moo...@gm...>]

Hi,

I've noticed that lots of things available for documenting methods are
not available for properties (e.g., @see).  But that's usually
workable...

Except now I have a getter that can throw.  So, | var a = foo.bar |
can throw... Is there a way for me to document that?  @throws seems to
be one of those things not available for properties.

Thanks, and thanks for actually writing jsdoc :)

(P.S. Mozilla now also has a new syntax for getters/setters in object
initializers... It's not supported in JSDoc, but at least that's
supported; see
http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Guide:Creating_New_Objects:Defining_Getters_and_Setters
)

Sample code:

function a() {}
/**
 * Test
 * @throws Error foo
 */
a.prototype.__defineGetter__("b", function(){});

-- 
Mook
mook dot moz plus stuff at gmail

Re: [Jsdoc-user] Indicating a getter that might throw?

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

> I've noticed that lots of things available for documenting methods are
> not available for properties (e.g., @see).  But that's usually
> workable...
> 
> Except now I have a getter that can throw.  So, | var a = foo.bar |
> can throw... Is there a way for me to document that?  @throws seems to
> be one of those things not available for properties.

Could you register this as a feature request on the SourceForge project
page (sourceforge.net/projects/jsdoc)?  This kind of construction should be 
pretty simple to add, but I don't have time to do it right away and I
don't want to forget. As you'll notice, there are already quite a few
pending feature requests; it is my intention to take care of a large
number of these eventually, but I'm sorry to say it's not going to happen 
terribly quickly.

Regards,

    Gabriel