Skip to content
This repository
tag: 0.3.0
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 156 lines (60 sloc) 3.002 kb

Module edown_layout

Markdown layout module for EDoc.

Copyright (c) 2010 Erlang Solutions Ltd

Authors: Ulf Wiger (ulf.wiger@erlang-solutions.com).

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()}

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/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()

Something went wrong with that request. Please try again.