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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
# Module edown_doclet #
* [Description](#description)
* [Function Index](#index)
* [Function Details](#functions)
EDoc Doclet module for producing Markdown.
Copyright (c) 2014-2015 Ulf Wiger
__Authors:__ Ulf Wiger ([`ulf@wiger.net`](mailto:ulf@wiger.net)).
<a name="index"></a>
## Function Index ##
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#run-2">run/2</a></td><td>Main doclet entry point.</td></tr></table>
<a name="functions"></a>
## Function Details ##
<a name="run-2"></a>
### run/2 ###
<pre><code>
run(Command::<a href="#type-doclet_gen">doclet_gen()</a> | <a href="#type-doclet_toc">doclet_toc()</a>, Ctxt::<a href="#type-edoc_context">edoc_context()</a>) -> ok
</code></pre>
<br />
Main doclet entry point.
Also see [`//edoc/edoc:layout/2`](http://www.erlang.org/doc/man/edoc.html#layout-2) for layout-related options, and
[`//edoc/edoc:get_doc/2`](http://www.erlang.org/doc/man/edoc.html#get_doc-2) for options related to reading source
files.
Options:
<dt><code>{file_suffix, string()}</code>
</dt>
<dd>Specifies the suffix used for output files. The default value is
<code>".md"</code>.
</dd>
<dt><code>{hidden, bool()}</code>
</dt>
<dd>If the value is <code>true</code>, documentation of hidden modules and
functions will also be included. The default value is <code>false</code>.
</dd>
<dt><code>{overview, <a href="http://www.erlang.org/doc/man/edoc.html#type-filename">//edoc/edoc:filename()</a>}</code>
</dt>
<dd>Specifies the name of the overview-file. By default, this doclet
looks for a file <code>"overview.edoc"</code> in the target directory.
</dd>
<dt><code>{private, bool()}</code>
</dt>
<dd>If the value is <code>true</code>, documentation of private modules and
functions will also be included. The default value is <code>false</code>.
</dd>
<dt><code>{stylesheet, string()}</code>
</dt>
<dd>Specifies the URI used for referencing the stylesheet. The
default value is <code>"stylesheet.css"</code>. If an empty string is
specified, no stylesheet reference will be generated.
</dd>
<dt><code>{stylesheet_file, <a href="http://www.erlang.org/doc/man/edoc.html#type-filename">//edoc/edoc:filename()</a>}</code>
</dt>
<dd>Specifies the name of the stylesheet file. By default, this
doclet uses the file <code>"stylesheet.css"</code> in the <code>priv</code>
subdirectory of the EDoc installation directory. The named file
will be copied to the target directory.
</dd>
<dt><code>{title, string()}</code>
</dt>
<dd>Specifies the title of the overview-page.
</dd>
|
