deps/npm/node_modules/request/node_modules/tough-cookie/node_modules/punycode/vendor/docdown/doc/README.md

   1 # Docdown <sup>v1.0.0</sup>
   2
   3 <!-- div -->
   4
   5
   6 <!-- div -->
   7
   8 ## <a id="docdown"></a>`docdown`
   9 * [`docdown`](#docdown$optionsarray)
  10
  11 <!-- /div -->
  12
  13
  14 <!-- /div -->
  15
  16
  17 <!-- div -->
  18
  19
  20 <!-- div -->
  21
  22 ## `docdown`
  23
  24 <!-- div -->
  25
  26 ### <a id="docdown$optionsarray"></a>`docdown([$options=array()])`
  27 <a href="#docdown$optionsarray">#</a> [&#x24C8;](https://github.com/jdalton/docdown/blob/master/docdown.php#L34 "View in source") [&#x24C9;][1]
  28
  29 Generates Markdown from JSDoc entries in a given file.
  30
  31 #### Arguments
  32 1. `[$options=array()]` *(Array)*: The options array.
  33
  34 #### Returns
  35 *(String)*: The generated Markdown.
  36
  37 #### Example
  38 ```php
  39 // specify a file path
  40 $markdown = docdown(array(
  41   // path to js file
  42   'path' => $filepath,
  43   // url used to reference line numbers in code
  44   'url' => 'https://github.com/username/project/blob/master/my.js'
  45 ));
  46
  47 // or pass raw js
  48 $markdown = docdown(array(
  49   // raw JavaScript source
  50   'source' => $rawJS,
  51   // documentation title
  52   'title' => 'My API Documentation',
  53   // url used to reference line numbers in code
  54   'url' => 'https://github.com/username/project/blob/master/my.js'
  55 ));
  56 ```
  57
  58 * * *
  59
  60 <!-- /div -->
  61
  62
  63 <!-- /div -->
  64
  65
  66 <!-- /div -->
  67
  68
  69   [1]: #docdown "Jump back to the TOC."