Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 153 lines (59 sloc) 2.78 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
8da5e78 first commit; not yet working right
Ulf Wiger authored
12 EDoc Doclet module for producing Github-flavored Markdown.
659a33f more context-sensitive markup
Ulf Wiger authored
13
14
8da5e78 first commit; not yet working right
Ulf Wiger authored
15
9036f27 URI rewriting & special treatment of first sentence
Ulf Wiger authored
16 Copyright © 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 <a name="functions"></a>
28
29
659a33f more context-sensitive markup
Ulf Wiger authored
30 <h2>Function Details</h2>
31
8da5e78 first commit; not yet working right
Ulf Wiger authored
32
33 <a name="run-2"></a>
34
35
659a33f more context-sensitive markup
Ulf Wiger authored
36 <h3>run/2</h3>
37
38
39
40
41
42 <tt>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</tt>
43
8da5e78 first commit; not yet working right
Ulf Wiger authored
44
45
46
47
48 Main doclet entry point.
c7f546e normalize #text#
Ulf Wiger authored
49
50
659a33f more context-sensitive markup
Ulf Wiger authored
51
8fc6e87 more general URI redirect
Ulf Wiger authored
52 Also see [`//edoc/edoc:layout/2`](http://www.erlang.org/doc/man/edoc.html#layout-2) for layout-related options, and
53 [`//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
54 files.
c7f546e normalize #text#
Ulf Wiger authored
55
56 Options:
57
58
8da5e78 first commit; not yet working right
Ulf Wiger authored
59
659a33f more context-sensitive markup
Ulf Wiger authored
60 <dt><code>{file_suffix, string()}</code>
c7f546e normalize #text#
Ulf Wiger authored
61 </dt>
62
659a33f more context-sensitive markup
Ulf Wiger authored
63
8da5e78 first commit; not yet working right
Ulf Wiger authored
64
65
659a33f more context-sensitive markup
Ulf Wiger authored
66 <dd>Specifies the suffix used for output files. The default value is
c7f546e normalize #text#
Ulf Wiger authored
67 <code>".md"</code>.
68 </dd>
69
659a33f more context-sensitive markup
Ulf Wiger authored
70
8da5e78 first commit; not yet working right
Ulf Wiger authored
71
72
659a33f more context-sensitive markup
Ulf Wiger authored
73 <dt><code>{hidden, bool()}</code>
c7f546e normalize #text#
Ulf Wiger authored
74 </dt>
75
659a33f more context-sensitive markup
Ulf Wiger authored
76
8da5e78 first commit; not yet working right
Ulf Wiger authored
77
659a33f more context-sensitive markup
Ulf Wiger authored
78
79 <dd>If the value is <code>true</code>, documentation of hidden modules and
c7f546e normalize #text#
Ulf Wiger authored
80 functions will also be included. The default value is <code>false</code>.
81 </dd>
82
659a33f more context-sensitive markup
Ulf Wiger authored
83
84
85
8fc6e87 more general URI redirect
Ulf Wiger authored
86 <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
87 </dt>
88
659a33f more context-sensitive markup
Ulf Wiger authored
89
90
8da5e78 first commit; not yet working right
Ulf Wiger authored
91
659a33f more context-sensitive markup
Ulf Wiger authored
92 <dd>Specifies the name of the overview-file. By default, this doclet
c7f546e normalize #text#
Ulf Wiger authored
93 looks for a file <code>"overview.edoc"</code> in the target directory.
94 </dd>
95
659a33f more context-sensitive markup
Ulf Wiger authored
96
8da5e78 first commit; not yet working right
Ulf Wiger authored
97
659a33f more context-sensitive markup
Ulf Wiger authored
98
99 <dt><code>{private, bool()}</code>
c7f546e normalize #text#
Ulf Wiger authored
100 </dt>
101
659a33f more context-sensitive markup
Ulf Wiger authored
102
103
104
105 <dd>If the value is <code>true</code>, documentation of private modules and
c7f546e normalize #text#
Ulf Wiger authored
106 functions will also be included. The default value is <code>false</code>.
107 </dd>
108
659a33f more context-sensitive markup
Ulf Wiger authored
109
110
8da5e78 first commit; not yet working right
Ulf Wiger authored
111
659a33f more context-sensitive markup
Ulf Wiger authored
112 <dt><code>{stylesheet, string()}</code>
c7f546e normalize #text#
Ulf Wiger authored
113 </dt>
114
659a33f more context-sensitive markup
Ulf Wiger authored
115
8da5e78 first commit; not yet working right
Ulf Wiger authored
116
659a33f more context-sensitive markup
Ulf Wiger authored
117
118 <dd>Specifies the URI used for referencing the stylesheet. The
c7f546e normalize #text#
Ulf Wiger authored
119 default value is <code>"stylesheet.css"</code>. If an empty string is
120 specified, no stylesheet reference will be generated.
121 </dd>
122
659a33f more context-sensitive markup
Ulf Wiger authored
123
124
8da5e78 first commit; not yet working right
Ulf Wiger authored
125
8fc6e87 more general URI redirect
Ulf Wiger authored
126 <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
127 </dt>
128
659a33f more context-sensitive markup
Ulf Wiger authored
129
8da5e78 first commit; not yet working right
Ulf Wiger authored
130
659a33f more context-sensitive markup
Ulf Wiger authored
131
132 <dd>Specifies the name of the stylesheet file. By default, this
c7f546e normalize #text#
Ulf Wiger authored
133 doclet uses the file <code>"stylesheet.css"</code> in the <code>priv</code>
134 subdirectory of the EDoc installation directory. The named file
135 will be copied to the target directory.
136 </dd>
137
8da5e78 first commit; not yet working right
Ulf Wiger authored
138
139
659a33f more context-sensitive markup
Ulf Wiger authored
140
141 <dt><code>{title, string()}</code>
c7f546e normalize #text#
Ulf Wiger authored
142 </dt>
143
659a33f more context-sensitive markup
Ulf Wiger authored
144
145
146
147 <dd>Specifies the title of the overview-page.
c7f546e normalize #text#
Ulf Wiger authored
148 </dd>
149
659a33f more context-sensitive markup
Ulf Wiger authored
150
151
152
2b22898 fix uri redirect & nl after index
Ulf Wiger authored
153 _Generated by EDoc, Oct 31 2010, 21:13:12._
Something went wrong with that request. Please try again.