documentation/test/fixture/params.output.md

addThem

This function returns the number one.

Parameters

• a
• b number the second param
• c
• $3 Object
  • $3.d
  • $3.e
  • $3.f

fishesAndFoxes

This method has partially inferred params

Parameters

• $0 Object
  • $0.fishes String number of kinds of fish
  • $0.foxes

withDefault

This method has a type in the description and a default in the code

Parameters

• x [number](default 2)

Foo

This is foo's documentation

method

The method

Parameters

• x number Param to method

Address6

Represents an IPv6 address

This tests our support of optional parameters

Parameters

• address string An IPv6 address string
• groups [number] How many octets to parse (optional, default 8)
• third ?number A third argument
• foo [Array] to properly be parsed (optional, default [1])

Examples

var address = new Address6('2001::/32');

GeoJSONSource

Create a GeoJSON data source instance given an options object

This tests our support of nested parameters

Parameters

• options [Object] optional options
  • options.data (Object | string) A GeoJSON data object or URL to it. The latter is preferable in case of large GeoJSON files.
  • options.maxzoom [number] Maximum zoom to preserve detail at. (optional, default 14)
  • options.buffer [number] Tile buffer on each side.
  • options.tolerance [number] Simplification tolerance (higher means simpler).

myfunc

This tests our support for parameters with explicit types but with default values specified in code.

Parameters

• x number an argument

Returns number some

foo

This tests our support of JSDoc param tags without type information, or any type information we could infer from annotations.

Parameters

• address An IPv6 address string