'JSDoc - @link to a variable of the same module
I have this module
/**
...
@module utils/camera
*/
/**
* Default app images valid dimensions.
*
* @constant
* @type {Array<Dimension>}
* @default
* [
* {
* width: 1080,
* height: 1080,
* },
* ...
* ]
*/
export const DEFAULT_IMAGE_VALID_DIMENSIONS = [
{
width: 1080,
height: 1080,
},
...
];
export const CROPPERS = [
{
dimensions: DEFAULT_IMAGE_VALID_DIMENSIONS[0],
},
...
];
And I am trying to document the CROPPERS constant like this:
/**
* Default camera cropper configuration.
*
* @constant
* @type {Array<CropperConfiguration>}
* @default
* [
* {
* dimensions: {@link module:utils/camera#DEFAULT_IMAGE_VALID_DIMENSIONS|DEFAULT_IMAGE_VALID_DIMENSIONS[0]},
* ...
* },
* ...
* ]
*/
But the @link doesn't work. Is it possible to link a field to a constant of the same module?
Sources
This article follows the attribution requirements of Stack Overflow and is licensed under CC BY-SA 3.0.
Source: Stack Overflow
| Solution | Source |
|---|
