Module edoc_lib

Utility functions for EDoc.

Copyright © 2001-2003 Richard Carlsson

Authors: Richard Carlsson (richardc@csd.uu.se).

See also: edoc.

Description

Utility functions for EDoc.

Data Types

edoc_env()

abstract datatype: edoc_env()

Environment information needed by EDoc for generating references. The data representation is not documented.

Function Index

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/4Creates 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/3Write the given Text to the file named by Name in directory Dir.
write_file/4Like write_file/3, but adds path components to the target directory corresponding to the specified package.
write_info_file/4

Function Details

copy_file/2

copy_file(From, To) -> term()

count/2

count(X, Xs) -> term()

escape_uri/1

escape_uri(Cs) -> term()

filename/1

filename(T) -> term()

find_file/3

find_file(Ps, Pkg, Name) -> term()

find_sources/2

find_sources(Path, Opts) -> term()

find_sources/3

find_sources(Path, Pkg, Opts) -> term()

find_sources/5

find_sources(Path, Pkg, Rec, Ext, Opts) -> term()

get_doc_env/1

get_doc_env(Options::option_list()) -> edoc_env()

See also: get_doc_env/4.

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.

get_first_sentence/1

get_first_sentence(Es) -> term()

get_info_files/1

get_info_files(Ps) -> term()

is_name/1

is_name(Cs) -> term()

join_uri/2

join_uri(Base, Path) -> term()

read_info_file/1

read_info_file(Dir) -> term()

segment/2

segment(Es, N) -> term()

split/2

split(Cs, K) -> term()

split_at_stop/1

split_at_stop(Cs) -> term()

strip_space/1

strip_space(Cs) -> term()

transpose/1

transpose(Xss) -> term()

try_subdir/2

try_subdir(Dir, Subdir) -> term()

unique/1

unique(Xs) -> term()

write_file/3

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/4

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.

write_info_file/4

write_info_file(App, Packages, Modules, Dir) -> term()