GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  EDOC_LAYOUT (3)

NAME

edoc_layout - The standard HTML layout module for EDoc.

CONTENTS

Description
Exports
Authors

DESCRIPTION

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

EXPORTS

module(Element, Options) -> term()

The layout function.

Options to the standard layout:

{index_columns, integer()}: Specifies the number of column pairs used for the function index tables. The default value is 1.
{pretty_printer, atom()}: Specifies how types and specifications are pretty printed. If the value erl_pp is specified the Erlang pretty printer (the module erl_pp) will be used. The default is to do no pretty printing which implies that lines can be very long.
{stylesheet, string()}: Specifies the URI used for referencing the stylesheet. The default value is "stylesheet.css". If an empty string is specified, no stylesheet reference will be generated.
{sort_functions, boolean()}: If true, 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 true.
{xml_export, Module::atom()}: Specifies an xmerl callback module to be used for exporting the documentation. See xmerl:export_simple/3 for details.

See also: edoc:layout/2.

overview(E, Options) -> term()

type(E) -> term()

SEE ALSO

edoc

AUTHORS

Richard Carlsson <carlsson.richard@gmail.com

Search for    or go to Top of page |  Section 3 |  Main Index


EDOC_LAYOUT (3) edoc 0.7.18

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.