summaryrefslogtreecommitdiff
path: root/docs/tools/documentation_generator.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/tools/documentation_generator.md')
-rw-r--r--docs/tools/documentation_generator.md31
1 files changed, 0 insertions, 31 deletions
diff --git a/docs/tools/documentation_generator.md b/docs/tools/documentation_generator.md
deleted file mode 100644
index fa8b09c9c..000000000
--- a/docs/tools/documentation_generator.md
+++ /dev/null
@@ -1,31 +0,0 @@
-## Documentation Generator
-
-`deno doc` followed by a list of one or more source files will print the JSDoc
-documentation for each of the module's **exported** members.
-
-For example, given a file `add.ts` with the contents:
-
-```ts
-/**
- * Adds x and y.
- * @param {number} x
- * @param {number} y
- * @returns {number} Sum of x and y
- */
-export function add(x: number, y: number): number {
- return x + y;
-}
-```
-
-Running the Deno `doc` command, prints the function's JSDoc comment to `stdout`:
-
-```shell
-deno doc add.ts
-function add(x: number, y: number): number
- Adds x and y. @param {number} x @param {number} y @returns {number} Sum of x and y
-```
-
-Use the `--json` flag to output the documentation in JSON format. This JSON
-format is consumed by the
-[deno doc website](https://github.com/denoland/doc_website) and is used to
-generate module documentation.