Home

class: LinkHelper

Help building documentation links

Methods summary

Public methods
public constructor(conf: Object): void
public formatReturns(returnsData: JSDocReturns): String

Properties

Name Type Attribute Description
typesTpl Object public

Map each type (either native or user-defined) to an URL

Methods

constructor(conf: Object): void

Create a new LinkHelper

Params:

Name Type Attribute Description
conf

The template configuration

Returns:

void


formatReturns(returnsData: JSDocReturns): String

src\helpers\link.js, line 57

Format return type data into HTML String.

Params:

Name Type Attribute Description
returnsData

The returns property of a JSDocRecord

Returns:

String