summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/request/node_modules/tough-cookie/node_modules/punycode/vendor/docdown/doc/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/node_modules/request/node_modules/tough-cookie/node_modules/punycode/vendor/docdown/doc/README.md')
-rw-r--r--deps/npm/node_modules/request/node_modules/tough-cookie/node_modules/punycode/vendor/docdown/doc/README.md69
1 files changed, 0 insertions, 69 deletions
diff --git a/deps/npm/node_modules/request/node_modules/tough-cookie/node_modules/punycode/vendor/docdown/doc/README.md b/deps/npm/node_modules/request/node_modules/tough-cookie/node_modules/punycode/vendor/docdown/doc/README.md
deleted file mode 100644
index 459d36abdc..0000000000
--- a/deps/npm/node_modules/request/node_modules/tough-cookie/node_modules/punycode/vendor/docdown/doc/README.md
+++ /dev/null
@@ -1,69 +0,0 @@
-# Docdown <sup>v1.0.0</sup>
-
-<!-- div -->
-
-
-<!-- div -->
-
-## <a id="docdown"></a>`docdown`
-* [`docdown`](#docdown$optionsarray)
-
-<!-- /div -->
-
-
-<!-- /div -->
-
-
-<!-- div -->
-
-
-<!-- div -->
-
-## `docdown`
-
-<!-- div -->
-
-### <a id="docdown$optionsarray"></a>`docdown([$options=array()])`
-<a href="#docdown$optionsarray">#</a> [&#x24C8;](https://github.com/jdalton/docdown/blob/master/docdown.php#L34 "View in source") [&#x24C9;][1]
-
-Generates Markdown from JSDoc entries in a given file.
-
-#### Arguments
-1. `[$options=array()]` *(Array)*: The options array.
-
-#### Returns
-*(String)*: The generated Markdown.
-
-#### Example
-```php
-// specify a file path
-$markdown = docdown(array(
- // path to js file
- 'path' => $filepath,
- // url used to reference line numbers in code
- 'url' => 'https://github.com/username/project/blob/master/my.js'
-));
-
-// or pass raw js
-$markdown = docdown(array(
- // raw JavaScript source
- 'source' => $rawJS,
- // documentation title
- 'title' => 'My API Documentation',
- // url used to reference line numbers in code
- 'url' => 'https://github.com/username/project/blob/master/my.js'
-));
-```
-
-* * *
-
-<!-- /div -->
-
-
-<!-- /div -->
-
-
-<!-- /div -->
-
-
- [1]: #docdown "Jump back to the TOC." \ No newline at end of file