Utility functions for EDoc.
See edoc:run/3 for a description of the options
subpackages
, source_suffix
and exclude_packages
.
get_doc_env(Options::proplist()) -> edoc_env()
Equivalent to get_doc_env([], [], [], Opts).
get_doc_env(App, Packages, Modules, Options::proplist()) -> edoc_env()
Types:
App = [] | atom()
Packages = [atom()]
Modules = [atom()]
[term()]
Creates an environment data structure used by parts of EDoc for
generating references, etc. See edoc:run/3 for a description
of the options file_suffix
, app_default
and doc_path
.
See also: edoc:get_doc/3, edoc_extract:source/4.
get_first_sentence() -> term()
EDoc "contact information" parsing. This is the type of the content in e.g. @author tags.
EDoc Erlang expression parsing. For parsing things like the content of @equiv tags, and strings denoting file names, e.g. in @headerfile. Also used by edoc_run.
See edoc:run/3 for a description of the doclet
option.
See edoc:layout/2 for a description of the layout
option.
Write the given Text
to the file named by Name
in directory
Dir
. If the target directory does not exist, it will be created.
Like write_file/3, but adds path components to the target directory corresponding to the specified package.