bionic (3) edoc_lib.3erl.gz

Provided by: erlang-manpages_20.2.2+dfsg-1ubuntu2_all bug

NAME
       edoc_lib - Utility functions for EDoc.


DESCRIPTION
       Utility functions for EDoc.


DATA TYPES
         edoc_env():

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

         proplist() = proplists:property():


EXPORTS
       get_doc_env(App, Modules, Options::proplist()) -> edoc_env()

              Types:

                 App = [] | atom()
                 Modules = [atom()]
                 proplist() = [term()]

              Creates an environment data structure used by parts of EDoc for generating  references,  etc.  See
              edoc:run/2 for a description of the options file_suffix, app_default and doc_path.

              See also: edoc:get_doc/3, edoc_extract:source/4.

       write_file(Text, Dir, Name, Options) -> term()


SEE ALSO
       edoc


AUTHORS
       Richard Carlsson <carlsson.richard@gmail.com>

                                                   edoc 0.9.2                                     edoc_lib(3erl)