Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

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