File: edoc_layout.3

package info (click to toggle)
erlang-manpages 1%3A12.b.3-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 4,188 kB
  • ctags: 2
  • sloc: makefile: 68; perl: 30; sh: 15
file content (61 lines) | stat: -rw-r--r-- 1,314 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
.TH edoc_layout 3 "edoc  0.7.6" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
edoc_layout \- The standard HTML layout module for EDoc\&.
.SH DESCRIPTION
.LP
The standard HTML layout module for EDoc\&. See the edoc module for details on usage\&.

.SH EXPORTS
.LP
.B
module() -> term()
.br
.RS
.LP
The layout function\&.
.LP
Options to the standard layout: 
.RS 2
.TP 4
.B
\fI{index_columns, integer()}\fR:
Specifies the number of column pairs used for the function index tables\&. The default value is 1\&. 
.TP 4
.B
\fI{stylesheet, string()}\fR:
Specifies the URI used for referencing the stylesheet\&. The default value is \fI"stylesheet\&.css"\fR\&. If an empty string is specified, no stylesheet reference will be generated\&. 
.TP 4
.B
\fI{sort_functions, bool()}\fR:
If \fItrue\fR, the detailed function descriptions are listed by name, otherwise they are listed in the order of occurrence in the source file\&. The default value is \fItrue\fR\&. 
.TP 4
.B
\fI{xml_export, Module::atom()}\fR:
Specifies an xmerl callback module to be used for exporting the documentation\&. See xmerl:export_simple/3 for details\&. 
.RE
.LP

.LP
\fISee also:\fR edoc:layout/2\&.
.RE
.LP
.B
overview() -> term()
.br
.RS
.RE
.LP
.B
package() -> term()
.br
.RS
.RE
.LP
.B
type() -> term()
.br
.RS
.RE
.SH SEE ALSO
.LP
edoc