Geography
Basic Types
Utilities

inline_tokenizer

inline_tokenizer(processor: Object): undefined

A remark plugin that installs tokenizers and locators for JSDoc inline {@link} and {@tutorial} tags.

This does not handle the [text]({@link url}) and [text]({@tutorial url}) forms of these tags. That's a JSDoc misfeature; just use regular markdown syntax instead: [text](url).

Extends

inlineSuperprocessor

Throws

TypeError when provided with an invalid processor

Example

var tooltip = new mapboxgl.Popup()
  .setLatLng(map.unproject(e.point))
  .setHTML("<h1>Hello World!</h1>")
  .addTo(map);

Parameters

processor
Object a remark instance
anotherParamJustToTest
string name of the thing
↳ nestedParameter
Array<any> some description
↳ otherProperty
Array<any> this property has a super duper long description just to break everything, because there's so much text here. This is for that weird case where people write a novel as the description for a property.

Properties

someProp
Object a remark instance
name
string name of the thing
↳ bar
Array<any> some description

Returns

undefined
string
in some cases we return a string for, like no reason
© 2016 BigCorp
Generated by documentation.js v4.0.0