Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 146 lines (73 sloc) 4.013 kb
8da5e78 first commit; not yet working right
Ulf Wiger authored
1 Module edown_doclet
2 ===================
3
4 <div class="navbar">
5 <a name="#navbar_top"></a>
6
7 <table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table>
8 </div>
9
10
11 #Module edown_doclet#
12 * [Description](#description)
13 * [Data Types](#types)
14 * [Function Index](#index)
15 * [Function Details](#functions)
16 EDoc Doclet module for producing Github-flavored Markdown.
17 Copyright © 2010 Erlang Solutions Ltd
18 __Authors:__ Ulf Wiger ([`ulf.wiger@erlang-solutions.com`](mailto:ulf.wiger@erlang-solutions.com)).
19
20 ##<a name="description">Description</a>##
21 EDoc Doclet module for producing Github-flavored Markdown.
22
23 ##<a name="types">Data Types</a>##
24
25 <a name="type-doclet_gen"></a>
26
27
28 ###doclet_gen()##
29
30 `doclet_gen() = #doclet_gen{sources = [string()], app = [no_app()](#type-no_app) | atom(), packages = [atom()], modules = [atom()], modules = [atom()], filemap = function()}`
31 <a name="type-doclet_toc"></a>
32
33
34 ###doclet_toc()##
35
36 `doclet_toc() = #doclet_gen{paths = [string()], indir = string()}`
37 <a name="type-edoc_context"></a>
38
39
40 ###edoc_context()##
41
42 `edoc_context() = #context{dir = string(), env = [edoc_lib:edoc_env()](edoc_lib.html#type-edoc_env), opts = [term()]}`
43 <a name="type-no_app"></a>
44
45
46 ###no_app()##
47
48 __abstract datatype__: `no_app()`
49 A value used to mark absence of an Erlang application
50 context. Use the macro `NO_APP` defined in
51 [`edoc_doclet.hrl`](../include/edoc_doclet.hrl)
52 to produce this value.
53
54 ##<a name="index">Function Index</a>##
55
56 <table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#run-2">run/2</a></td><td>Main doclet entry point.</td></tr></table>
57
58 <a name="functions"></a>
59
60
61 ##Function Details##
62
63 <a name="run-2"></a>
64
65
66 ###run/2##
67
68
69 `run(Command::[doclet_gen()](#type-doclet_gen) | [doclet_toc()](#type-doclet_toc), Ctxt::[edoc_context()](#type-edoc_context)) -> ok`
70
71
72 Main doclet entry point.
73
74
75 Also see [`edoc:layout/2`](edoc.html#layout-2) for layout-related options, and
76 [`edoc:get_doc/2`](edoc.html#get_doc-2) for options related to reading source
77 files.
78
79 Options:
80
81
82
83 ###`{file_suffix, string()}`##
84
85
86 Specifies the suffix used for output files. The default value is
87 `".md"`.
88
89
90
91 ###`{hidden, bool()}`##
92
93
94 If the value is `true`, documentation of hidden modules and
95 functions will also be included. The default value is `false`.
96
97
98
99 ###`{overview, [edoc:filename()](edoc.html#type-filename)}`##
100
101
102 Specifies the name of the overview-file. By default, this doclet
103 looks for a file `"overview.edoc"` in the target directory.
104
105
106
107 ###`{private, bool()}`##
108
109
110 If the value is `true`, documentation of private modules and
111 functions will also be included. The default value is `false`.
112
113
114
115 ###`{stylesheet, string()}`##
116
117
118 Specifies the URI used for referencing the stylesheet. The
119 default value is `"stylesheet.css"`. If an empty string is
120 specified, no stylesheet reference will be generated.
121
122
123
124 ###`{stylesheet_file, [edoc:filename()](edoc.html#type-filename)}`##
125
126
127 Specifies the name of the stylesheet file. By default, this
128 doclet uses the file `"stylesheet.css"` in the `priv`
129 subdirectory of the EDoc installation directory. The named file
130 will be copied to the target directory.
131
132
133
134 ###`{title, string()}`##
135
136
137 Specifies the title of the overview-page.
138
139
140 <div class="navbar">
141 <a name="#navbar_bottom"></a>
142
143 <table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table>
144 </div>
145
146 _Generated by EDoc, Oct 22 2010, 15:27:00._
Something went wrong with that request. Please try again.