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         command() = doclet_gen() | doclet_toc():
13
14
15           Doclet commands.
16
17         context()     =     #doclet_context{dir=string(),     env=edoc:env(),
18         opts=[term()]}:
19
20
21           Context for doclets.
22
23         doclet_gen() = #doclet_gen{sources=[string()], app=no_app  |  atom(),
24         modules=[module()]}:
25
26
27           Doclet command.
28
29         doclet_toc() = #doclet_toc{paths=[string()], indir=string()}:
30
31
32           Doclet command.
33

EXPORTS

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

SEE ALSO

78       edoc
79

AUTHORS

81       Richard Carlsson <carlsson.richard@gmail.com>
82
83
84
85                                   edoc 1.1                     edoc_doclet(3)