Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 143 lines (60 sloc) 2.654 kB
8da5e78 first commit; not yet working right
Ulf Wiger authored
1
2
7b59ee1 @uwiger regenerated docs after seth's patches
uwiger authored
3 # Module edown_doclet #
8da5e78 first commit; not yet working right
Ulf Wiger authored
4 * [Description](#description)
5 * [Function Index](#index)
6 * [Function Details](#functions)
2b22898 fix uri redirect & nl after index
Ulf Wiger authored
7
8
e4da232 It's normal Markdown - not GFM
Ulf Wiger authored
9 EDoc Doclet module for producing Markdown.
8fbee6d Copyright symbol changed to (c)
Ulf Wiger authored
10 Copyright (c) 2010 Erlang Solutions Ltd
659a33f more context-sensitive markup
Ulf Wiger authored
11
7b59ee1 @uwiger regenerated docs after seth's patches
uwiger authored
12 __Authors:__ Ulf Wiger ([`ulf@wiger.net`](mailto:ulf@wiger.net)).
13 <a name="index"></a>
659a33f more context-sensitive markup
Ulf Wiger authored
14
7b59ee1 @uwiger regenerated docs after seth's patches
uwiger authored
15 ## Function Index ##
659a33f more context-sensitive markup
Ulf Wiger authored
16
8da5e78 first commit; not yet working right
Ulf Wiger authored
17
18 <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>
19
659a33f more context-sensitive markup
Ulf Wiger authored
20
4d41ead use markdown notation in headers
Ulf Wiger authored
21 <a name="functions"></a>
8da5e78 first commit; not yet working right
Ulf Wiger authored
22
7b59ee1 @uwiger regenerated docs after seth's patches
uwiger authored
23 ## Function Details ##
8da5e78 first commit; not yet working right
Ulf Wiger authored
24
25 <a name="run-2"></a>
26
7b59ee1 @uwiger regenerated docs after seth's patches
uwiger authored
27 ### run/2 ###
659a33f more context-sensitive markup
Ulf Wiger authored
28
29
7b59ee1 @uwiger regenerated docs after seth's patches
uwiger authored
30 <pre><code>
31 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>) -&gt; ok
32 </code></pre>
b5f1675 added edown_make script
Ulf Wiger authored
33
7b59ee1 @uwiger regenerated docs after seth's patches
uwiger authored
34 <br></br>
659a33f more context-sensitive markup
Ulf Wiger authored
35
8da5e78 first commit; not yet working right
Ulf Wiger authored
36
37
e32e40a @uwiger Expand double-newlines, then collapse double 'p' tags
uwiger authored
38 Main doclet entry point.
8da5e78 first commit; not yet working right
Ulf Wiger authored
39
40
c7f546e normalize #text#
Ulf Wiger authored
41
48bc5c3 @uwiger re-generated docs
uwiger authored
42 Also see [`//edoc/edoc:layout/2`](http://www.erlang.org/doc/man/edoc.html#layout-2) for layout-related options, and
e32e40a @uwiger Expand double-newlines, then collapse double 'p' tags
uwiger authored
43 [`//edoc/edoc:get_doc/2`](http://www.erlang.org/doc/man/edoc.html#get_doc-2) for options related to reading source
44 files.
45
7b59ee1 @uwiger regenerated docs after seth's patches
uwiger authored
46
e32e40a @uwiger Expand double-newlines, then collapse double 'p' tags
uwiger authored
47 Options:
c7f546e normalize #text#
Ulf Wiger authored
48
49
8da5e78 first commit; not yet working right
Ulf Wiger authored
50
659a33f more context-sensitive markup
Ulf Wiger authored
51 <dt><code>{file_suffix, string()}</code>
c7f546e normalize #text#
Ulf Wiger authored
52 </dt>
53
659a33f more context-sensitive markup
Ulf Wiger authored
54
8da5e78 first commit; not yet working right
Ulf Wiger authored
55
56
659a33f more context-sensitive markup
Ulf Wiger authored
57 <dd>Specifies the suffix used for output files. The default value is
c7f546e normalize #text#
Ulf Wiger authored
58 <code>".md"</code>.
59 </dd>
60
659a33f more context-sensitive markup
Ulf Wiger authored
61
8da5e78 first commit; not yet working right
Ulf Wiger authored
62
63
659a33f more context-sensitive markup
Ulf Wiger authored
64 <dt><code>{hidden, bool()}</code>
c7f546e normalize #text#
Ulf Wiger authored
65 </dt>
66
659a33f more context-sensitive markup
Ulf Wiger authored
67
8da5e78 first commit; not yet working right
Ulf Wiger authored
68
659a33f more context-sensitive markup
Ulf Wiger authored
69
70 <dd>If the value is <code>true</code>, documentation of hidden modules and
c7f546e normalize #text#
Ulf Wiger authored
71 functions will also be included. The default value is <code>false</code>.
72 </dd>
73
659a33f more context-sensitive markup
Ulf Wiger authored
74
75
76
48bc5c3 @uwiger re-generated docs
uwiger authored
77 <dt><code>{overview, <a href="http://www.erlang.org/doc/man/edoc.html#type-filename">//edoc/edoc:filename()</a>}</code>
c7f546e normalize #text#
Ulf Wiger authored
78 </dt>
79
659a33f more context-sensitive markup
Ulf Wiger authored
80
81
8da5e78 first commit; not yet working right
Ulf Wiger authored
82
659a33f more context-sensitive markup
Ulf Wiger authored
83 <dd>Specifies the name of the overview-file. By default, this doclet
c7f546e normalize #text#
Ulf Wiger authored
84 looks for a file <code>"overview.edoc"</code> in the target directory.
85 </dd>
86
659a33f more context-sensitive markup
Ulf Wiger authored
87
8da5e78 first commit; not yet working right
Ulf Wiger authored
88
659a33f more context-sensitive markup
Ulf Wiger authored
89
90 <dt><code>{private, bool()}</code>
c7f546e normalize #text#
Ulf Wiger authored
91 </dt>
92
659a33f more context-sensitive markup
Ulf Wiger authored
93
94
95
96 <dd>If the value is <code>true</code>, documentation of private modules and
c7f546e normalize #text#
Ulf Wiger authored
97 functions will also be included. The default value is <code>false</code>.
98 </dd>
99
659a33f more context-sensitive markup
Ulf Wiger authored
100
101
8da5e78 first commit; not yet working right
Ulf Wiger authored
102
659a33f more context-sensitive markup
Ulf Wiger authored
103 <dt><code>{stylesheet, string()}</code>
c7f546e normalize #text#
Ulf Wiger authored
104 </dt>
105
659a33f more context-sensitive markup
Ulf Wiger authored
106
8da5e78 first commit; not yet working right
Ulf Wiger authored
107
659a33f more context-sensitive markup
Ulf Wiger authored
108
109 <dd>Specifies the URI used for referencing the stylesheet. The
c7f546e normalize #text#
Ulf Wiger authored
110 default value is <code>"stylesheet.css"</code>. If an empty string is
111 specified, no stylesheet reference will be generated.
112 </dd>
113
659a33f more context-sensitive markup
Ulf Wiger authored
114
115
8da5e78 first commit; not yet working right
Ulf Wiger authored
116
48bc5c3 @uwiger re-generated docs
uwiger authored
117 <dt><code>{stylesheet_file, <a href="http://www.erlang.org/doc/man/edoc.html#type-filename">//edoc/edoc:filename()</a>}</code>
c7f546e normalize #text#
Ulf Wiger authored
118 </dt>
119
659a33f more context-sensitive markup
Ulf Wiger authored
120
8da5e78 first commit; not yet working right
Ulf Wiger authored
121
659a33f more context-sensitive markup
Ulf Wiger authored
122
123 <dd>Specifies the name of the stylesheet file. By default, this
c7f546e normalize #text#
Ulf Wiger authored
124 doclet uses the file <code>"stylesheet.css"</code> in the <code>priv</code>
125 subdirectory of the EDoc installation directory. The named file
126 will be copied to the target directory.
127 </dd>
128
8da5e78 first commit; not yet working right
Ulf Wiger authored
129
130
659a33f more context-sensitive markup
Ulf Wiger authored
131
132 <dt><code>{title, string()}</code>
c7f546e normalize #text#
Ulf Wiger authored
133 </dt>
134
659a33f more context-sensitive markup
Ulf Wiger authored
135
136
137
138 <dd>Specifies the title of the overview-page.
c7f546e normalize #text#
Ulf Wiger authored
139 </dd>
140
659a33f more context-sensitive markup
Ulf Wiger authored
141
7b59ee1 @uwiger regenerated docs after seth's patches
uwiger authored
142
Something went wrong with that request. Please try again.