summaryrefslogtreecommitdiff
path: root/tools
diff options
context:
space:
mode:
authorAnna Henningsen <anna@addaleax.net>2016-05-19 11:11:51 +0200
committerAnna Henningsen <anna@addaleax.net>2016-06-06 00:46:23 +0200
commite7f1c0043cf5340778ddf75f7dc80ade65e2d974 (patch)
treea513c93df054e14970ec2c477d04b31da7b0eccc /tools
parent2cd99eb0a0f39f9244ba40d0c7c43ff28fc86b60 (diff)
downloadandroid-node-v8-e7f1c0043cf5340778ddf75f7dc80ade65e2d974.tar.gz
android-node-v8-e7f1c0043cf5340778ddf75f7dc80ade65e2d974.tar.bz2
android-node-v8-e7f1c0043cf5340778ddf75f7dc80ade65e2d974.zip
tools,doc: add example usage for REPLACEME tag
Ref: https://github.com/nodejs/node/issues/6578 PR-URL: https://github.com/nodejs/node/pull/6864 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'tools')
-rw-r--r--tools/doc/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/tools/doc/README.md b/tools/doc/README.md
index 22bd053ed1..1620d6c25a 100644
--- a/tools/doc/README.md
+++ b/tools/doc/README.md
@@ -34,6 +34,15 @@ Each type of heading has a description block.
A description of the function.
+ ### module.someNewFunction(x)
+ <!-- YAML
+ added: REPLACEME
+ -->
+
+ * `x` {String} the description of the string
+
+ This feature is not in a release yet.
+
### Event: 'blerg'
<!-- YAML
added: v0.10.0