#Module edown_layout#
- Description
- Function Index
- Function Details
Github-flavored Markdown layout module for EDoc.
Copyright © 2010 Erlang Solutions Ltd
Authors: Ulf Wiger (
ulf.wiger@erlang-solutions.com).
##Description##
Github-flavored Markdown layout module for EDoc.
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()}##
Specifies the number of column pairs used for the function index tables. The default value is 1.
###{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, bool()}##
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/xmerl:export_simple_content/2 for details.
See also: edoc:layout/2.
###overview/2##
overview(E, Options) -> any()
###package/2##
package(E, Options) -> any()
###type/1##
type(E) -> any()
Generated by EDoc, Oct 22 2010, 19:30:35.