This library provides some predicates which generate documentation automatically for a given documenation component (module, package, application, etc.), using the declarations and assertions used in the source itself as input (see the assertions library).
The output format in which the documentation is generated is defined by the backend modules (autodoc_texinfo, autodoc_html, autodoc_man, etc.).
Usage:ensure_output_dir_prepared(Backend,Opts)
Ensure that the output directories for backend Backend are prepared.
Usage:get_autodoc_opts(Backend,Mod,Opts)
Get the list of documentation options Opts for the FileBase file.
Usage:autodoc_gen_doctree(Backend,FileBase,FileExt,Opts,Mod)
FileBase is the module specifier of the source file being documented (without extension, FileExt is the source extension). The output is a file whose contents document the main file, based on any assertions present in that file. The documentation is produced in the format given by Backend (the name of the output file also depends on Backend). The formats supported are given by backend_id/1.
Usage:fmt_infodir_entry(DocSt,Version,Mod)
Generates a one line description (ASCII) of the application or library in a file for the directory of emacs info manuals.
Usage:
Compute the globally resolved references (including bibliography)
Usage:
Translate the doctree using the specific backend