[FEATURE] - Support for {@link} from JSDoc

[lexon0011]

We use the {@link} tag in our comments, like

/**
 * See {@link MyClass} and [MyClass's foo property]{@link MyClass#foo}.
 * Also, check out {@link http://www.google.com|Google} and
 * {@link https://github.com GitHub}.
 */

see JSDoc

Is it possible to include this link-tags to the generated documentation?

Thanks!

[pburrows]

@link does not seem to be getting parsed for properties. For the following comments:

/**
 * Event object emitted by {@link AutoFormMasterComponent}
 */
export interface IAutoFormEvent {

	/**
	 * The original {@link FieldDefinition} object that participated in this event. Can be used
	 * to determine which field was modified
	 */
	fieldDefinition: FieldDefinition;

	/**
	 * The original {@link Event}
	 */
	event: Event;
}

The {@link AutoFormMasterComponent} is getting parsed correctly, but the two @link tags in the property descriptions are not.

[tommueller]

This is in the docs now, but it does not work for me. It breaks the parsing of the comment. If I paste the exact example from the docs (both for internal and external links):

    /**
     * @param {string} target  The target to process see {@link Todo}
     *
     * @example
     * This is a good example
     * processTarget('yo')
     *
     * @returns      The processed target number
     */

it generates this output:

Parameters :

target

The target to process see {

Example :

This is a good example processTarget('yo')
Returns : Observable<>

The processed target number

[vogloblinsky]

@tommueller Related to #237
Completed, released soon in 1.0.0-beta.14

[tommueller]

Great, thanks!

[007300]

in 1.0.0-beta.14:
{@link xxx} is getting parsed for properties still not correctly:
only "{" will be represented

[vogloblinsky]

@007300
Any example ?

[007300]

/**
 * Creates a typed instance of the ApiService with the endpoint selected from the {@link ApiMap} with the endpointKey
 * @param {string} endpointKey The key to pick the enpoint from the {@link ApiMap}
 */

then it generates:

Name	Type	Description
endpointKey	string	The key to pick the enpoint from the {

The second {@link} is broken

[vogloblinsky]

@007300
Seems related to microsoft/TypeScript#16498
I open another specific issue for that : #294

[lock]

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context.