diff options
author | Bartek IwaĆczuk <biwanczuk@gmail.com> | 2021-07-20 16:25:36 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-07-20 16:25:36 +0200 |
commit | d744c0c6d9a557bbaa2a23571ffb3acabf19c35a (patch) | |
tree | 6f7fb8a71b786e79c48f4b2c11a5a9ca988717e8 /docs/tools/documentation_generator.md | |
parent | 9b9becf1ae256b645e37a7eecf3441f3ae4b8ea5 (diff) |
chore: move docs to separate repository
Diffstat (limited to 'docs/tools/documentation_generator.md')
-rw-r--r-- | docs/tools/documentation_generator.md | 31 |
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. |