summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSam Ruby <rubys@intertwingly.net>2018-07-03 12:46:56 -0400
committerVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-07-09 22:57:33 +0300
commit0c743b5f77a53f278d6d6554e69d2d55ef945f66 (patch)
tree18e34392c8f668d5c3777b259785c86606ede358 /doc
parent1529ef4dc5e4cf99ea964bc1cc47cd62cca17540 (diff)
downloadandroid-node-v8-0c743b5f77a53f278d6d6554e69d2d55ef945f66.tar.gz
android-node-v8-0c743b5f77a53f278d6d6554e69d2d55ef945f66.tar.bz2
android-node-v8-0c743b5f77a53f278d6d6554e69d2d55ef945f66.zip
tools: build all.json by combining generated JSON
Notes: 1) Removed a number of root properties that did not seem relevant: source, desc, and introduced_in. There no longer is a source, and the other two are from the first include and do not reflect the entire API. 2) As with https://github.com/nodejs/node/issues/20100, the current "desc" properties sometimes contained in-page links, other times referenced another page, and often did not match the links in the original HTML or JSON file. I chose to standardize on external links as "desc" values are isolated snippets as opposed to all.html which can be viewed as a standalone and self contained document. 3) Eliminated preprocessing for @include entirely, including the test case for this function. 4) _toc.md was renamed to index.md. 5) index comments no longer appear in embedded TOCs (left hand side column in the generated documentation. PR-URL: https://github.com/nodejs/node/pull/21637 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/_toc.md62
-rw-r--r--doc/api/all.md50
-rw-r--r--doc/api/index.md65
3 files changed, 64 insertions, 113 deletions
diff --git a/doc/api/_toc.md b/doc/api/_toc.md
deleted file mode 100644
index e307d52ae8..0000000000
--- a/doc/api/_toc.md
+++ /dev/null
@@ -1,62 +0,0 @@
-@// NB(chrisdickinson): if you move this file, be sure to update
-@// tools/doc/html.js to point at the new location.
-
-<!--introduced_in=v0.10.0-->
-
-* [About these Docs](documentation.html)
-* [Usage & Example](synopsis.html)
-
-<div class="line"></div>
-
-* [Assertion Testing](assert.html)
-* [Async Hooks](async_hooks.html)
-* [Buffer](buffer.html)
-* [C++ Addons](addons.html)
-* [C/C++ Addons - N-API](n-api.html)
-* [Child Processes](child_process.html)
-* [Cluster](cluster.html)
-* [Command Line Options](cli.html)
-* [Console](console.html)
-* [Crypto](crypto.html)
-* [Debugger](debugger.html)
-* [Deprecated APIs](deprecations.html)
-* [DNS](dns.html)
-* [Domain](domain.html)
-* [ECMAScript Modules](esm.html)
-* [Errors](errors.html)
-* [Events](events.html)
-* [File System](fs.html)
-* [Globals](globals.html)
-* [HTTP](http.html)
-* [HTTP/2](http2.html)
-* [HTTPS](https.html)
-* [Inspector](inspector.html)
-* [Internationalization](intl.html)
-* [Modules](modules.html)
-* [Net](net.html)
-* [OS](os.html)
-* [Path](path.html)
-* [Performance Hooks](perf_hooks.html)
-* [Process](process.html)
-* [Punycode](punycode.html)
-* [Query Strings](querystring.html)
-* [Readline](readline.html)
-* [REPL](repl.html)
-* [Stream](stream.html)
-* [String Decoder](string_decoder.html)
-* [Timers](timers.html)
-* [TLS/SSL](tls.html)
-* [Trace Events](tracing.html)
-* [TTY](tty.html)
-* [UDP/Datagram](dgram.html)
-* [URL](url.html)
-* [Utilities](util.html)
-* [V8](v8.html)
-* [VM](vm.html)
-* [Worker Threads](worker_threads.html)
-* [ZLIB](zlib.html)
-
-<div class="line"></div>
-
-* [GitHub Repo & Issue Tracker](https://github.com/nodejs/node)
-* [Mailing List](https://groups.google.com/group/nodejs)
diff --git a/doc/api/all.md b/doc/api/all.md
deleted file mode 100644
index 47216b695d..0000000000
--- a/doc/api/all.md
+++ /dev/null
@@ -1,50 +0,0 @@
-<!--lint disable prohibited-strings-->
-@include documentation
-@include synopsis
-@include assert
-@include async_hooks
-@include buffer
-@include addons
-@include n-api
-@include child_process
-@include cluster
-@include cli
-@include console
-@include crypto
-@include debugger
-@include deprecations
-@include dns
-@include domain
-@include esm
-@include errors
-@include events
-@include fs
-@include globals
-@include http
-@include http2
-@include https
-@include inspector
-@include intl
-@include modules
-@include net
-@include os
-@include path
-@include perf_hooks
-@include process
-@include punycode
-@include querystring
-@include readline
-@include repl
-@include stream
-@include string_decoder
-@include timers
-@include tls
-@include tracing
-@include tty
-@include dgram
-@include url
-@include util
-@include v8
-@include vm
-@include worker_threads
-@include zlib
diff --git a/doc/api/index.md b/doc/api/index.md
index 400faf6e5e..0b43097bf2 100644
--- a/doc/api/index.md
+++ b/doc/api/index.md
@@ -1 +1,64 @@
-@include _toc.md
+<!--
+ NB(chrisdickinson): if you move this file, be sure to update
+ tools/doc/html.js to point at the new location.
+-->
+
+<!--introduced_in=v0.10.0-->
+
+* [About these Docs](documentation.html)
+* [Usage & Example](synopsis.html)
+
+<div class="line"></div>
+
+* [Assertion Testing](assert.html)
+* [Async Hooks](async_hooks.html)
+* [Buffer](buffer.html)
+* [C++ Addons](addons.html)
+* [C/C++ Addons - N-API](n-api.html)
+* [Child Processes](child_process.html)
+* [Cluster](cluster.html)
+* [Command Line Options](cli.html)
+* [Console](console.html)
+* [Crypto](crypto.html)
+* [Debugger](debugger.html)
+* [Deprecated APIs](deprecations.html)
+* [DNS](dns.html)
+* [Domain](domain.html)
+* [ECMAScript Modules](esm.html)
+* [Errors](errors.html)
+* [Events](events.html)
+* [File System](fs.html)
+* [Globals](globals.html)
+* [HTTP](http.html)
+* [HTTP/2](http2.html)
+* [HTTPS](https.html)
+* [Inspector](inspector.html)
+* [Internationalization](intl.html)
+* [Modules](modules.html)
+* [Net](net.html)
+* [OS](os.html)
+* [Path](path.html)
+* [Performance Hooks](perf_hooks.html)
+* [Process](process.html)
+* [Punycode](punycode.html)
+* [Query Strings](querystring.html)
+* [Readline](readline.html)
+* [REPL](repl.html)
+* [Stream](stream.html)
+* [String Decoder](string_decoder.html)
+* [Timers](timers.html)
+* [TLS/SSL](tls.html)
+* [Trace Events](tracing.html)
+* [TTY](tty.html)
+* [UDP/Datagram](dgram.html)
+* [URL](url.html)
+* [Utilities](util.html)
+* [V8](v8.html)
+* [VM](vm.html)
+* [Worker Threads](worker_threads.html)
+* [ZLIB](zlib.html)
+
+<div class="line"></div>
+
+* [GitHub Repo & Issue Tracker](https://github.com/nodejs/node)
+* [Mailing List](https://groups.google.com/group/nodejs)