UNPKG

builddocs

Version:

Build documentation files from commented source code

github.com/marijnh/builddocs

marijnh/builddocs

34 lines (32 loc) • 1.52 kB
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
<<in {item, name, static, hideType}>> <dt id="<<t prefix + item.id>>"> <code><<if item.abstract>><span class=keyword>abstract</span> <</if>><<if static>><span class=keyword>static</span> <</if>> <<if item.type == "Function" && !item.optional>> <<if item.signatures[0].type == "constructor">><span class=keyword>new</span> <</if>><strong><a href="#<<t prefix + item.id>>"><<t name>></a></strong><<fntype item.signatures[0]>> <<else>> <strong><a href="#<<t prefix + item.id>>"><<t name>></a></strong><<if item.optional && !hideType>>&#8288;?<</if>><<if item.type && !hideType>>: <<type item>><</if>> <</if>> </code> <<for sig item.signatures?.slice(1) || []>> <div><code><<if sig.type == "constructor">><span class=keyword>new</span> <</if>><strong><a href="#<<t prefix + item.id>>"><<t name>></a></strong><<fntype sig>></code></div> <</for>> </dt> <dd> <<markdown item.description>> <<do let inList = false>> <<for name, prop in item.properties || {}>> <<if hasDescription(prop)>> <<if !inList>><dl><<do inList = true>><</if>> <<define {item: prop, name: name}>> <</if>> <</for>> <<for params (item.signatures || []).map(s => s.params.concat(item.typeParams || [])).concat([item.typeParams || []])>> <<for param params>> <<if hasDescription(param)>> <<if !inList>><dl><<do inList = true>><</if>> <<define {item: param, name: param.name, hideType: true}>> <</if>> <</for>> <</for>> <<if inList>></dl><</if>> </dd>