1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
.TH edoc_doclet 3 "edoc 0.7.6" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
edoc_doclet \- Standard doclet module for EDoc\&.
.SH DESCRIPTION
.LP
Standard doclet module for EDoc\&.
.SH DATA TYPES
.RS 2
.TP 4
.B
\fIdoclet_gen() = #doclet_gen{sources=[string()], app=no_app() | atom(), packages=[atom()], modules=[atom()], modules=[atom()], filemap=function()}\fR:
.TP 4
.B
\fIdoclet_toc() = #doclet_gen{paths=[string()], indir=string()}\fR:
.TP 4
.B
\fIedoc_context() = #context{dir=string(), env=edoc_env() (see module edoc_lib), opts=[term()]}\fR:
.TP 4
.B
\fIno_app()\fR:
.RS 4
.LP
A value used to mark absence of an Erlang application context\&. Use the macro \fINO_APP\fR defined in edoc_doclet\&.hrl <\&.\&./\&.\&./include/edoc_doclet\&.hrl> to produce this value\&.
.LP
.RE
.RE
.SH EXPORTS
.LP
.B
run(Command::doclet_gen() | doclet_toc(), Ctxt::edoc_context()) -> ok
.br
.RS
.LP
Main doclet entry point\&. See the file edoc_doclet\&.hrl <\&.\&./\&.\&./include/edoc_doclet\&.hrl> for the data structures used for passing parameters\&.
.LP
Also see edoc:layout/2 for layout-related options, and edoc:get_doc/2 for options related to reading source files\&.
.LP
Options:
.RS 2
.TP 4
.B
\fI{file_suffix, string()}\fR:
Specifies the suffix used for output files\&. The default value is \fI"\&.html"\fR\&.
.TP 4
.B
\fI{hidden, bool()}\fR:
If the value is \fItrue\fR, documentation of hidden modules and functions will also be included\&. The default value is \fIfalse\fR\&.
.TP 4
.B
\fI{overview, edoc:filename()}\fR:
Specifies the name of the overview-file\&. By default, this doclet looks for a file \fI"overview\&.edoc"\fR in the target directory\&.
.TP 4
.B
\fI{private, bool()}\fR:
If the value is \fItrue\fR, documentation of private modules and functions will also be included\&. The default value is \fIfalse\fR\&.
.TP 4
.B
\fI{stylesheet, string()}\fR:
Specifies the URI used for referencing the stylesheet\&. The default value is \fI"stylesheet\&.css"\fR\&. If an empty string is specified, no stylesheet reference will be generated\&.
.TP 4
.B
\fI{stylesheet_file, edoc:filename()}\fR:
Specifies the name of the stylesheet file\&. By default, this doclet uses the file \fI"stylesheet\&.css"\fR in the \fIpriv\fR subdirectory of the EDoc installation directory\&. The named file will be copied to the target directory\&.
.TP 4
.B
\fI{title, string()}\fR:
Specifies the title of the overview-page\&.
.RE
.RE
.SH SEE ALSO
.LP
edoc
|
