Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 148 lines (56 sloc) 2.684 kb
8da5e78 first commit; not yet working right
Ulf Wiger authored
1
2
66e54e6 remove double h1:s, stylesheet, image
Ulf Wiger 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.
659a33f more context-sensitive markup
Ulf Wiger authored
10
11
8da5e78 first commit; not yet working right
Ulf Wiger authored
12
8fbee6d Copyright symbol changed to (c)
Ulf Wiger authored
13 Copyright (c) 2010 Erlang Solutions Ltd
659a33f more context-sensitive markup
Ulf Wiger authored
14
9036f27 URI rewriting & special treatment of first sentence
Ulf Wiger authored
15 __Authors:__ Ulf Wiger ([`ulf.wiger@erlang-solutions.com`](mailto:ulf.wiger@erlang-solutions.com)).
8da5e78 first commit; not yet working right
Ulf Wiger authored
16
659a33f more context-sensitive markup
Ulf Wiger authored
17 <h2><a name="index">Function Index</a></h2>
18
19
8da5e78 first commit; not yet working right
Ulf Wiger authored
20
21 <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>
22
659a33f more context-sensitive markup
Ulf Wiger authored
23
8da5e78 first commit; not yet working right
Ulf Wiger authored
24
25
56d4aae updated for R14B02 & layout fixes
Ulf Wiger authored
26 <h2><a name="functions">Function Details</a></h2>
659a33f more context-sensitive markup
Ulf Wiger authored
27
8da5e78 first commit; not yet working right
Ulf Wiger authored
28
29 <a name="run-2"></a>
30
659a33f more context-sensitive markup
Ulf Wiger authored
31 <h3>run/2</h3>
32
33
34
35
36
e7efc59 use 'pre' tags even without erl_pp
Ulf Wiger authored
37 <pre>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</pre>
56d4aae updated for R14B02 & layout fixes
Ulf Wiger authored
38 <br></br>
39
659a33f more context-sensitive markup
Ulf Wiger authored
40
8da5e78 first commit; not yet working right
Ulf Wiger authored
41
42
43
44
45 Main doclet entry point.
c7f546e normalize #text#
Ulf Wiger authored
46
47
659a33f more context-sensitive markup
Ulf Wiger authored
48
8fc6e87 more general URI redirect
Ulf Wiger authored
49 Also see [`//edoc/edoc:layout/2`](http://www.erlang.org/doc/man/edoc.html#layout-2) for layout-related options, and
50 [`//edoc/edoc:get_doc/2`](http://www.erlang.org/doc/man/edoc.html#get_doc-2) for options related to reading source
8da5e78 first commit; not yet working right
Ulf Wiger authored
51 files.
c7f546e normalize #text#
Ulf Wiger authored
52
53 Options:
54
55
8da5e78 first commit; not yet working right
Ulf Wiger authored
56
659a33f more context-sensitive markup
Ulf Wiger authored
57 <dt><code>{file_suffix, string()}</code>
c7f546e normalize #text#
Ulf Wiger authored
58 </dt>
59
659a33f more context-sensitive markup
Ulf Wiger authored
60
8da5e78 first commit; not yet working right
Ulf Wiger authored
61
62
659a33f more context-sensitive markup
Ulf Wiger authored
63 <dd>Specifies the suffix used for output files. The default value is
c7f546e normalize #text#
Ulf Wiger authored
64 <code>".md"</code>.
65 </dd>
66
659a33f more context-sensitive markup
Ulf Wiger authored
67
8da5e78 first commit; not yet working right
Ulf Wiger authored
68
69
659a33f more context-sensitive markup
Ulf Wiger authored
70 <dt><code>{hidden, bool()}</code>
c7f546e normalize #text#
Ulf Wiger authored
71 </dt>
72
659a33f more context-sensitive markup
Ulf Wiger authored
73
8da5e78 first commit; not yet working right
Ulf Wiger authored
74
659a33f more context-sensitive markup
Ulf Wiger authored
75
76 <dd>If the value is <code>true</code>, documentation of hidden modules and
c7f546e normalize #text#
Ulf Wiger authored
77 functions will also be included. The default value is <code>false</code>.
78 </dd>
79
659a33f more context-sensitive markup
Ulf Wiger authored
80
81
82
8fc6e87 more general URI redirect
Ulf Wiger authored
83 <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
84 </dt>
85
659a33f more context-sensitive markup
Ulf Wiger authored
86
87
8da5e78 first commit; not yet working right
Ulf Wiger authored
88
659a33f more context-sensitive markup
Ulf Wiger authored
89 <dd>Specifies the name of the overview-file. By default, this doclet
c7f546e normalize #text#
Ulf Wiger authored
90 looks for a file <code>"overview.edoc"</code> in the target directory.
91 </dd>
92
659a33f more context-sensitive markup
Ulf Wiger authored
93
8da5e78 first commit; not yet working right
Ulf Wiger authored
94
659a33f more context-sensitive markup
Ulf Wiger authored
95
96 <dt><code>{private, bool()}</code>
c7f546e normalize #text#
Ulf Wiger authored
97 </dt>
98
659a33f more context-sensitive markup
Ulf Wiger authored
99
100
101
102 <dd>If the value is <code>true</code>, documentation of private modules and
c7f546e normalize #text#
Ulf Wiger authored
103 functions will also be included. The default value is <code>false</code>.
104 </dd>
105
659a33f more context-sensitive markup
Ulf Wiger authored
106
107
8da5e78 first commit; not yet working right
Ulf Wiger authored
108
659a33f more context-sensitive markup
Ulf Wiger authored
109 <dt><code>{stylesheet, string()}</code>
c7f546e normalize #text#
Ulf Wiger authored
110 </dt>
111
659a33f more context-sensitive markup
Ulf Wiger authored
112
8da5e78 first commit; not yet working right
Ulf Wiger authored
113
659a33f more context-sensitive markup
Ulf Wiger authored
114
115 <dd>Specifies the URI used for referencing the stylesheet. The
c7f546e normalize #text#
Ulf Wiger authored
116 default value is <code>"stylesheet.css"</code>. If an empty string is
117 specified, no stylesheet reference will be generated.
118 </dd>
119
659a33f more context-sensitive markup
Ulf Wiger authored
120
121
8da5e78 first commit; not yet working right
Ulf Wiger authored
122
8fc6e87 more general URI redirect
Ulf Wiger authored
123 <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
124 </dt>
125
659a33f more context-sensitive markup
Ulf Wiger authored
126
8da5e78 first commit; not yet working right
Ulf Wiger authored
127
659a33f more context-sensitive markup
Ulf Wiger authored
128
129 <dd>Specifies the name of the stylesheet file. By default, this
c7f546e normalize #text#
Ulf Wiger authored
130 doclet uses the file <code>"stylesheet.css"</code> in the <code>priv</code>
131 subdirectory of the EDoc installation directory. The named file
132 will be copied to the target directory.
133 </dd>
134
8da5e78 first commit; not yet working right
Ulf Wiger authored
135
136
659a33f more context-sensitive markup
Ulf Wiger authored
137
138 <dt><code>{title, string()}</code>
c7f546e normalize #text#
Ulf Wiger authored
139 </dt>
140
659a33f more context-sensitive markup
Ulf Wiger authored
141
142
143
144 <dd>Specifies the title of the overview-page.
c7f546e normalize #text#
Ulf Wiger authored
145 </dd>
146
659a33f more context-sensitive markup
Ulf Wiger authored
147
Something went wrong with that request. Please try again.