1edoc_layout(3)             Erlang Module Definition             edoc_layout(3)
2
3
4

NAME

6       edoc_layout - The standard HTML layout module for EDoc.
7

DESCRIPTION

9       The  standard  HTML  layout  module  for  EDoc. See the edoc module for
10       details on usage.
11

EXPORTS

13       module(Element, Options) -> term()
14
15              The layout function.
16
17              Options to the standard layout:
18
19                {index_columns, integer()}:
20                  Specifies the number of column pairs used for  the  function
21                  index tables. The default value is 1.
22
23                {pretty_printer, atom()}:
24                  Specifies  how  types and specifications are pretty printed.
25                  If the value erl_pp is specified the Erlang  pretty  printer
26                  (the  module  erl_pp)  will be used. The default is to do no
27                  pretty printing which implies that lines can be very long.
28
29                {stylesheet, string()}:
30                  Specifies the URI used for referencing the  stylesheet.  The
31                  default  value  is  "stylesheet.css".  If an empty string is
32                  specified, no stylesheet reference will be generated.
33
34                {sort_functions, boolean()}:
35                  If true, the detailed function descriptions  are  listed  by
36                  name,  otherwise  they are listed in the order of occurrence
37                  in the source file. The default value is true.
38
39                {xml_export, Module::atom()}:
40                  Specifies an xmerl callback module to be used for  exporting
41                  the documentation. See xmerl:export_simple/3 for details.
42
43              See also: edoc:layout/2.
44
45       overview(E, Options) -> term()
46
47       type(E) -> term()
48

SEE ALSO

50       edoc
51

AUTHORS

53       Richard Carlsson <carlsson.richard@gmail.com>
54
55
56
57                                   edoc 0.11                    edoc_layout(3)