-
Notifications
You must be signed in to change notification settings - Fork 16
/
deno_doc.deno.txt
37 lines (28 loc) · 2.48 KB
/
deno_doc.deno.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
DENO_DOC
VERSION ==> #See deno
deno doc [UPATH] [VARR] #Show documentation for a module
#Def UPATH: like --builtin
#Include:
# - TypeScript types
# - main /** */ block
# - JSDoc comments:
--private #Unless defined, only allow exported VARR
--builtin VARR #Target a Deno.* or DOM VARR
JSDOC TAGS ==> # - @typedef
# - @example
# - @type @readonly @default
# - @module
# - @deprecated
# - @ignore @private @protected @public
# - @property @enum
# - @param @returns
# - @callback
# - @class @this
NON-JSDOC TAGS ==> # - @todo -> @unsupported
# - @augments -> @extends {TYPE} COMMENT
# - @tags allow-*,...
# - @category CATEGORY
# - @template T COMMENT
DENO.LAND DOCS ==> #deno.land automatically shows `deno doc` auto-generated documentation