Ref(doclet, linkopt)

Reference to an individual nav item.

Constructor

new Ref(doclet, linkopt)

Parameters:
Name Type Default Description
doclet Doclet
linkopt object null
Properties
Name Type Description
url string

Link URL

label string

Link label

text string

Link text (Defaults to link.label)

Source:
lib/Nav.js, line 135

Members

<a> linking to this ref.

Source:
lib/Nav.js, line 155

Methods

has(doclet)boolean

Whether this ref is associated with the given doclet.

Parameters:
Name Type Description
doclet Doclet
Source:
lib/Nav.js, line 163
Returns:
Type:
boolean

Licensed under the Apache License 2.0

Documentation generated by JSDoc 4.0.2 using Docolatte theme