1edoc_doclet(3)             Erlang Module Definition             edoc_doclet(3)
2
3
4

NAME

6       edoc_doclet - Standard doclet module for EDoc.
7

DESCRIPTION

9       Standard doclet module for EDoc.
10

DATA TYPES

12         doclet_gen() = #doclet_gen{sources=[string()], app=no_app() | atom(),
13         modules=[atom()]}:
14
15
16         doclet_toc() = #doclet_gen{paths=[string()], indir=string()}:
17
18
19         edoc_context()  =   #context{dir=string(),   env=edoc_lib:edoc_env(),
20         opts=[term()]}:
21
22
23         no_app():
24
25
26           A  value used to mark absence of an Erlang application context. Use
27           the macro NO_APP defined in edoc_doclet.hrl to produce this value.
28

EXPORTS

30       run(Command::doclet_gen() | doclet_toc(), Ctxt::edoc_context()) -> ok
31
32              Main doclet entry point. See the file  edoc_doclet.hrl  for  the
33              data structures used for passing parameters.
34
35              Also   see   edoc:layout/2   for   layout-related  options,  and
36              edoc:get_doc/2 for options related to reading source files.
37
38              Options:
39
40                {file_suffix, string()}:
41                  Specifies the suffix used  for  output  files.  The  default
42                  value is ".html".
43
44                {hidden, boolean()}:
45                  If  the  value  is true, documentation of hidden modules and
46                  functions will also be included. The default value is false.
47
48                {overview, edoc:filename()}:
49                  Specifies the name of the overview-file.  By  default,  this
50                  doclet looks for a file "overview.edoc" in the target direc‐
51                  tory.
52
53                {private, boolean()}:
54                  If the value is true, documentation of private  modules  and
55                  functions will also be included. The default value is false.
56
57                {stylesheet, string()}:
58                  Specifies  the  URI used for referencing the stylesheet. The
59                  default value is "stylesheet.css". If  an  empty  string  is
60                  specified, no stylesheet reference will be generated.
61
62                {stylesheet_file, edoc:filename()}:
63                  Specifies  the name of the stylesheet file. By default, this
64                  doclet uses the file "stylesheet.css" in the priv  subdirec‐
65                  tory of the EDoc installation directory. The named file will
66                  be copied to the target directory.
67
68                {title, string()}:
69                  Specifies the title of the overview-page.
70

SEE ALSO

72       edoc
73

AUTHORS

75       Richard Carlsson <carlsson.richard@gmail.com>
76
77
78
79                                   edoc 0.10                    edoc_doclet(3)