archive-gh-me/documentation
1
0
Fork 0
mirror of https://github.com/documentationjs/documentation.git synced 2026-01-25 14:26:29 +00:00
Code Issues Projects Releases Wiki Activity
documentation/test/fixture/params.output.md
Tom MacWright 802dc4cf2c fix(inference): Robust parsing for shorthand object methods 
This extends findTarget and the membership interference steps, treating ObjectProperty within var-assigned objects the same as we did for ObjectMethods. It also adds tests that specifically test findTarget directly.

Fixes https://github.com/documentationjs/documentation/issues/649 and fixes https://github.com/documentationjs/documentation/issues/678
2017-02-24 11:56:00 -05:00

3.9 KiB
Raw Blame History

Table of Contents

addThem

This function returns the number one.

Parameters

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

fishesAndFoxes

This method has partially inferred params

Parameters

  • $0 any
    • $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

Foo

This is foo's documentation

method

The method

Parameters

TraditionalObject

Traditional object

traditionalMethod

This method should acquire the param x

Parameters

  • x

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

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