jsdoc-user

[Jsdoc-user] Reference 'static' members with @link and @see tags

[Adam R. <ad...@pr...>]

Hi,

I seem to have come up against some limitations in using the @link  
and @see tags.

Firstly I don't seem to be able to link to 'static' methods with  
these tags, for example:

function foo() {}

/**
  * @see #baz
  */
foo.bar = function() {
	// do something
};

foo.baz = function() {
	// do something else
}

Secondly, I can't link to a class constant variable such as:

/**
  * @final
  * @type String
  */
foo.MY_CONST = "my constant value";

Is there a way to reference these members with jsdoc?

Kind regards
Adam

Re: [Jsdoc-user] Reference 'static' members with @link and @see tags

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

On Thu, Dec 01, 2005 at 10:38:08PM +1300, Adam Ratcliffe wrote:
> I seem to have come up against some limitations in using the @link  
> and @see tags.
> 
> Firstly I don't seem to be able to link to 'static' methods with  
> these tags, for example:
> 
> function foo() {}
> 
> /**
>  * @see #baz
>  */
> foo.bar = function() {
> 	// do something
> };
> 
> foo.baz = function() {
> 	// do something else
> }
> 
> Secondly, I can't link to a class constant variable such as:
> 
> /**
>  * @final
>  * @type String
>  */
> foo.MY_CONST = "my constant value";
> 
> Is there a way to reference these members with jsdoc?

Sorry for taking so long to respond to this. Both of these problems are
unfortunate side-effects of a recent fix that was made to linking of
static members. It will be fixed in the next release of JSDoc, hopefully
within a week from now. Thanks for reporting this.

Gabriel

Re: [Jsdoc-user] Reference 'static' members with @link and @see tags

[Adam R. <ad...@pr...>]

Hi Gabriel

Looking forward to the new release :)

Cheers
Adam



On 8 Dec, 2005, at 8:35 AM, Gabriel Reid wrote:

> On Thu, Dec 01, 2005 at 10:38:08PM +1300, Adam Ratcliffe wrote:
>> I seem to have come up against some limitations in using the @link
>> and @see tags.
>>
>> Firstly I don't seem to be able to link to 'static' methods with
>> these tags, for example:
>>
>> function foo() {}
>>
>> /**
>>  * @see #baz
>>  */
>> foo.bar = function() {
>> 	// do something
>> };
>>
>> foo.baz = function() {
>> 	// do something else
>> }
>>
>> Secondly, I can't link to a class constant variable such as:
>>
>> /**
>>  * @final
>>  * @type String
>>  */
>> foo.MY_CONST = "my constant value";
>>
>> Is there a way to reference these members with jsdoc?
>
> Sorry for taking so long to respond to this. Both of these problems  
> are
> unfortunate side-effects of a recent fix that was made to linking of
> static members. It will be fixed in the next release of JSDoc,  
> hopefully
> within a week from now. Thanks for reporting this.
>
> Gabriel
>
>
> -------------------------------------------------------
> This SF.net email is sponsored by: Splunk Inc. Do you grep through  
> log files
> for problems?  Stop!  Download the new AJAX search engine that makes
> searching your log files as easy as surfing the  web.  DOWNLOAD  
> SPLUNK!
> http://ads.osdn.com/?ad_id=7637&alloc_id=16865&op=click
> _______________________________________________
> Jsdoc-user mailing list
> Jsd...@li...
> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>
>

Re: [Jsdoc-user] Reference 'static' members with @link and @see tags

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

On Thu, Dec 01, 2005 at 10:38:08PM +1300, Adam Ratcliffe wrote:
> Hi,
> 
> I seem to have come up against some limitations in using the @link  
> and @see tags.

This issue has been resolved in the newly-released version 1.9.7 of
JSDoc.

Gabriel