jsdoc-user

[Jsdoc-user] Comments on variables

[<jc...@gm...>]

Hello there!

Is there some way to document our global variables?
For example:

var MyGlobalVariable =3D new Array();

I would like to have a description of some key variables in my project.

Thanx in advance

--=20
[]
J=FAlio C=E9sar K=F6del G.

Re: [Jsdoc-user] Comments on variables

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

Hi, 

On Wed, Feb 21, 2007 at 07:15:22PM -0200, Júlio César Ködel wrote:
> Is there some way to document our global variables?
> For example:
> 
> var MyGlobalVariable = new Array();
> 
> I would like to have a description of some key variables in my project.

No, this isn't currently possible with JSDoc.

Regards,

    Gabriel

Re: [Jsdoc-user] Comments on variables

[Michael M. <mi...@gm...>]

Hi J=FAlio,

You might be interested in looking at the JSDoc-2 project. Your =20
request would be possible using JSDoc-2 by simply adding the =20
following comment...

/**
  * MyGlobalVariable - A description of this variable.
  */
var MyGlobalVariable =3D new Array();

The only catch is that JSDoc-2 is still in development. The first =20
beta release is imminent; perhaps you will help us with the testing?

Regards,
Michael


On 25 Feb 2007, at 14:13, Gabriel Reid wrote:

> Hi,
>
> On Wed, Feb 21, 2007 at 07:15:22PM -0200, J=FAlio C=E9sar K=F6del =
wrote:
>> Is there some way to document our global variables?
>> For example:
>>
>> var MyGlobalVariable =3D new Array();
>>
>> I would like to have a description of some key variables in my =20
>> project.
>
> No, this isn't currently possible with JSDoc.
>
> Regards,
>
>     Gabriel
>
> ----------------------------------------------------------------------=20=

> ---
> Take Surveys. Earn Cash. Influence the Future of IT
> Join SourceForge.net's Techsay panel and you'll get the chance to =20
> share your
> opinions on IT & business topics through brief surveys-and earn cash
> http://www.techsay.com/default.php?=20
> page=3Djoin.php&p=3Dsourceforge&CID=3DDEVDEV
> _______________________________________________
> Jsdoc-user mailing list
> Jsd...@li...
> https://lists.sourceforge.net/lists/listinfo/jsdoc-user