#Module edown_layout#
Markdown layout module for EDoc.
Copyright (c) 2010 Erlang Solutions Ltd
Authors: Ulf Wiger ([email protected]
).
##Description##
Derived from edoc_layout
, which is part of the Erlang/OTP application EDoc.
The module is intended to be used together with edoc.
##Function Index##
markdown/3 | |
module/2 | The layout function. |
overview/2 | |
package/2 | |
type/1 |
##Function Details##
###markdown/3##
markdown(Title, CSS, Body) -> any()
###module/2##
module(Element, Options) -> any()
The layout function.
Options to the standard layout:
{index_columns, integer()}
{pretty_printer, atom()}
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()}
"stylesheet.css"
. If an empty string is
specified, no stylesheet reference will be generated.
{sort_functions, boolean()}
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()}
xmerl
callback module to be
used for exporting the documentation. See //xmerl/xmerl:export_simple_content/2
for details.
See also: //edoc/edoc:layout/2, edown_doclet:layout/2.
###overview/2##
overview(E, Options) -> any()
###package/2##
package(E, Options) -> any()
###type/1##
type(E) -> any()