archive-gh-me/documentation
1
0
Fork 0
mirror of https://github.com/documentationjs/documentation.git synced 2026-02-01 14:53:07 +00:00
Code Issues Projects Releases Wiki Activity
documentation/test/fixture/es6.output.md
Tom MacWright 3f08c19533 Move documentation-theme-utils into core 
Also:

* Fixes many issues in the default theme
* Moves the default theme from default-theme to default_theme
* Creates a new, robust linker infrastructure that will support
  bare links
* Replaces slugg with github-slugger
* Outputs unknown types as Any. Fixes #451
2016-06-08 12:40:05 -04:00

2.7 KiB
Raw Permalink Blame History

destructure

This function destructures with defaults. It should not have any parameter descriptions.

Parameters

  • $0 Object (optional, default {})
    • $0.phoneNumbers (optional, default [])
    • $0.emailAddresses (optional, default [])
    • $0.params ...Any

destructure

Similar, but with an array

Parameters

  • $0 Array
    • $0.a
    • $0.b
    • $0.c

Examples

destructure([1, 2, 3])

multiply

This function returns the number one.

Parameters

Returns Number numberone

Sink

This is a sink

staticProp

This is a property of the sink.

empty

Is it empty

aGetter

This is a getter method: it should be documented as a property.

constructor

Parameters

  • height number the height of the thing
  • width number the width of the thing

hello

This method says hello

makeABasket

This method returns a basket. The type should not be linked.

Returns Basket a basket

makeASink

This method returns a sink. The type should be linked. It takes a number which should also be linked.

Returns Sink a sink

functionWithRest

This function takes rest params

Parameters

  • someParams ...Any

functionWithRestAndType

So does this one, with types

Parameters

foo

This is an async method

es6.input

Parameters

  • thisIsTheArgument

es6.input

This function returns the number one.

Returns Number numberone

veryImportantTransform

This tests our support of optional parameters in ES6

Parameters

  • foo (optional, default 'bar')

iAmProtected

A protected function

iAmPublic

A public function

execute

This is re-exported