Copyright © 2001-2003 Richard Carlsson
Authors: Richard Carlsson (richardc@csd.uu.se).
See also: edoc.
abstract datatype: edoc_env()
Environment information needed by EDoc for generating references. The data representation is not documented.
copy_file/2 | |
count/2 | |
escape_uri/1 | |
filename/1 | |
find_file/3 | |
find_sources/2 | |
find_sources/3 | |
find_sources/5 | |
get_doc_env/1 | |
get_doc_env/4 | Creates an environment data structure used by parts of EDoc for generating references, etc. |
get_first_sentence/1 | |
get_info_files/1 | |
is_name/1 | |
join_uri/2 | |
read_info_file/1 | |
segment/2 | |
split/2 | |
split_at_stop/1 | |
strip_space/1 | |
transpose/1 | |
try_subdir/2 | |
unique/1 | |
write_file/3 | Write the given Text to the file named by Name in directory
Dir . |
write_file/4 | Like write_file/3 , but adds path components to the target
directory corresponding to the specified package. |
write_info_file/4 |
get_doc_env(Options::option_list()) -> edoc_env()
See also: get_doc_env/4.
get_doc_env(App, Packages, Modules, Options::option_list()) -> edoc_env()
Creates an environment data structure used by parts of EDoc for generating references, etc.
See also: edoc_extract:source/4.
write_file(Text::deep_string(), Dir::filename(), Name::filename()) -> ok
Write the given Text
to the file named by Name
in directory
Dir
. If the target directory does not exist, it will be created.
write_file(Text::deep_string(), Dir::filename(), Name::filename(), Package::atom() | string()) -> ok
Like write_file/3
, but adds path components to the target
directory corresponding to the specified package.