swallowzhang / jsdoc-toolkit

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

Can't seem to link to a constructor explicitly #243

Open GoogleCodeExporter opened 8 years ago

GoogleCodeExporter commented 8 years ago
I'd like to be able to link directly to the constructor definition for a class. 
However, if I use: {@link 
MyClass} it links to the class definition, and if I use {@link 
MyClass#constructor} it simply doesn't 
work.

Original issue reported on code.google.com by jwmetrocat@gmail.com on 26 Aug 2009 at 4:50

GoogleCodeExporter commented 8 years ago
I not sure what your wanting, the two are referentially the same. And as such, 
{@link 
MyClass} take you to the Class where the Constructor is. Can you provide a 
reference to as why you would need this or why you are unable to use the class 
symbol for your link?

Original comment by abyss...@gmail.com on 3 Jul 2010 at 3:23

GoogleCodeExporter commented 8 years ago
[deleted comment]
GoogleCodeExporter commented 8 years ago
For the record, while all the class information is on the page, I do recognise 
a need to link directly to the constructor definition part of the page, versus 
the default of just going to the top of the class page. This is specifically an 
issue with the JSDoc 2 template.

Original comment by micmath on 3 Jul 2010 at 10:51

GoogleCodeExporter commented 8 years ago
The use case I have seen is when you want to reference the parameters of the 
constructor, which is lower down on the page in most templates. E.g.:

/** @param {mixed} ...    Other optional parameters, see {@link 
MyClass#constructor} for details */

Original comment by nick.rab...@gmail.com on 4 Jul 2010 at 11:51