diff options
author | Matt Dumler <mattd3v@pm.me> | 2020-06-04 14:12:02 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-06-04 15:12:02 -0400 |
commit | a04166e9fa87450dfa910afeaf0c1dad988f3988 (patch) | |
tree | 23017952997b44a6cd463f624ef3815683ab3b4b /docs | |
parent | 4b1638dccc601ff0282172c7e3ef0f1126a603ed (diff) |
deno doc docs (#5650)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/tools/documentation_generator.md | 32 |
1 files changed, 31 insertions, 1 deletions
diff --git a/docs/tools/documentation_generator.md b/docs/tools/documentation_generator.md index 07b0b5c95..661fa22e5 100644 --- a/docs/tools/documentation_generator.md +++ b/docs/tools/documentation_generator.md @@ -1,3 +1,33 @@ ## Documentation Generator -<!-- TODO(lucacasonto): write things --> +`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. Currently, only +exports in the style `export <declaration>` and `export ... from ...` are are +supported. + +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 used to generate +module documentation. |