Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 154 lines (59 sloc) 2.968 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_layout#
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 Markdown layout module for EDoc.
659a33f more context-sensitive markup
Ulf Wiger authored
10
9036f27 URI rewriting & special treatment of first sentence
Ulf Wiger authored
11
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
6e85097 @uwiger fix error handling type macros; fix email
uwiger authored
15 __Authors:__ Ulf Wiger ([`ulf@wiger.net`](mailto:ulf@wiger.net)).<a name="description"></a>
659a33f more context-sensitive markup
Ulf Wiger authored
16
4d41ead use markdown notation in headers
Ulf Wiger authored
17 ##Description##
9036f27 URI rewriting & special treatment of first sentence
Ulf Wiger authored
18 Derived from `edoc_layout`, which is part of the Erlang/OTP application EDoc.
4d41ead use markdown notation in headers
Ulf Wiger authored
19 The module is intended to be used together with edoc.<a name="index"></a>
659a33f more context-sensitive markup
Ulf Wiger authored
20
4d41ead use markdown notation in headers
Ulf Wiger authored
21 ##Function Index##
659a33f more context-sensitive markup
Ulf Wiger authored
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="#markdown-3">markdown/3</a></td><td></td></tr><tr><td valign="top"><a href="#module-2">module/2</a></td><td>The layout function.</td></tr><tr><td valign="top"><a href="#overview-2">overview/2</a></td><td></td></tr><tr><td valign="top"><a href="#package-2">package/2</a></td><td></td></tr><tr><td valign="top"><a href="#type-1">type/1</a></td><td></td></tr></table>
25
659a33f more context-sensitive markup
Ulf Wiger authored
26
4d41ead use markdown notation in headers
Ulf Wiger authored
27 <a name="functions"></a>
8da5e78 first commit; not yet working right
Ulf Wiger authored
28
4d41ead use markdown notation in headers
Ulf Wiger authored
29 ##Function Details##
8da5e78 first commit; not yet working right
Ulf Wiger authored
30
31 <a name="markdown-3"></a>
32
4d41ead use markdown notation in headers
Ulf Wiger authored
33 ###markdown/3##
659a33f more context-sensitive markup
Ulf Wiger authored
34
35
8da5e78 first commit; not yet working right
Ulf Wiger authored
36
37
38 `markdown(Title, CSS, Body) -> any()`
39
40 <a name="module-2"></a>
41
4d41ead use markdown notation in headers
Ulf Wiger authored
42 ###module/2##
659a33f more context-sensitive markup
Ulf Wiger authored
43
44
8da5e78 first commit; not yet working right
Ulf Wiger authored
45
46
47 `module(Element, Options) -> any()`
48
49
659a33f more context-sensitive markup
Ulf Wiger authored
50
51
52
48bc5c3 @uwiger re-generated docs
uwiger authored
53 The layout function. Options to the standard layout:
c7f546e normalize #text#
Ulf Wiger authored
54
55
8da5e78 first commit; not yet working right
Ulf Wiger authored
56
659a33f more context-sensitive markup
Ulf Wiger authored
57 <dt><code>{index_columns, integer()}</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
659a33f more context-sensitive markup
Ulf Wiger authored
62
63 <dd>Specifies the number of column pairs used for the function
c7f546e normalize #text#
Ulf Wiger authored
64 index tables. The default value is 1.
65 </dd>
66
659a33f more context-sensitive markup
Ulf Wiger authored
67
68
8da5e78 first commit; not yet working right
Ulf Wiger authored
69
56d4aae updated for R14B02 & layout fixes
Ulf Wiger authored
70 <dt><code>{pretty_printer, atom()}</code>
71 </dt>
72
73
74
75
76 <dd>Specifies how types and specifications are pretty printed.
77 If the value <code>erl_pp</code> is specified the Erlang pretty printer
78 (the module <code>erl_pp</code>) will be used. The default is to do
79 no pretty printing which implies that lines can be very long.
80 </dd>
81
82
83
84
659a33f more context-sensitive markup
Ulf Wiger authored
85 <dt><code>{stylesheet, string()}</code>
c7f546e normalize #text#
Ulf Wiger authored
86 </dt>
87
659a33f more context-sensitive markup
Ulf Wiger authored
88
8da5e78 first commit; not yet working right
Ulf Wiger authored
89
659a33f more context-sensitive markup
Ulf Wiger authored
90
91 <dd>Specifies the URI used for referencing the stylesheet. The
c7f546e normalize #text#
Ulf Wiger authored
92 default value is <code>"stylesheet.css"</code>. If an empty string is
93 specified, no stylesheet reference will be generated.
94 </dd>
95
659a33f more context-sensitive markup
Ulf Wiger authored
96
97
8da5e78 first commit; not yet working right
Ulf Wiger authored
98
f0159e5 added top_level_readme option
Ulf Wiger authored
99 <dt><code>{sort_functions, boolean()}</code>
c7f546e normalize #text#
Ulf Wiger authored
100 </dt>
101
659a33f more context-sensitive markup
Ulf Wiger authored
102
8da5e78 first commit; not yet working right
Ulf Wiger authored
103
659a33f more context-sensitive markup
Ulf Wiger authored
104
105 <dd>If <code>true</code>, the detailed function descriptions are listed by
c7f546e normalize #text#
Ulf Wiger authored
106 name, otherwise they are listed in the order of occurrence in
107 the source file. The default value is <code>true</code>.
108 </dd>
109
8da5e78 first commit; not yet working right
Ulf Wiger authored
110
111
659a33f more context-sensitive markup
Ulf Wiger authored
112
113 <dt><code>{xml_export, Module::atom()}</code>
c7f546e normalize #text#
Ulf Wiger authored
114 </dt>
115
659a33f more context-sensitive markup
Ulf Wiger authored
116
117
118
48bc5c3 @uwiger re-generated docs
uwiger authored
119 <dd>Specifies an <a href="http://www.erlang.org/doc/man/index.html" target="_top"><code>xmerl</code></a> callback module to be
120 used for exporting the documentation. See <a href="http://www.erlang.org/doc/man/xmerl.html#export_simple_content-2"><code>//xmerl/xmerl:export_simple_content/2</code></a> for details.
c7f546e normalize #text#
Ulf Wiger authored
121 </dd>
122
123
659a33f more context-sensitive markup
Ulf Wiger authored
124
125
126
48bc5c3 @uwiger re-generated docs
uwiger authored
127 __See also:__ [//edoc/edoc:layout/2](http://www.erlang.org/doc/man/edoc.html#layout-2), [edown_doclet:layout/2](edown_doclet.md#layout-2).<a name="overview-2"></a>
659a33f more context-sensitive markup
Ulf Wiger authored
128
4d41ead use markdown notation in headers
Ulf Wiger authored
129 ###overview/2##
659a33f more context-sensitive markup
Ulf Wiger authored
130
131
8da5e78 first commit; not yet working right
Ulf Wiger authored
132
133
134 `overview(E, Options) -> any()`
135
136 <a name="package-2"></a>
137
4d41ead use markdown notation in headers
Ulf Wiger authored
138 ###package/2##
659a33f more context-sensitive markup
Ulf Wiger authored
139
140
8da5e78 first commit; not yet working right
Ulf Wiger authored
141
142
143 `package(E, Options) -> any()`
144
145 <a name="type-1"></a>
146
4d41ead use markdown notation in headers
Ulf Wiger authored
147 ###type/1##
659a33f more context-sensitive markup
Ulf Wiger authored
148
149
8da5e78 first commit; not yet working right
Ulf Wiger authored
150
151
152 `type(E) -> any()`
153
Something went wrong with that request. Please try again.