anvl_texinfo_erlang Erlang Module (ANVL)

Next: Module anvl_texinfo_lee, Previous: Module anvl_texinfo, Up: API Reference [Contents][Index]

4.5.2 Module `anvl_texinfo_erlang` ¶

This module provides functions for extracting doc chunks from Erlang modules and converting them to texinfo sources.

Types
Functions

4.5.2.1 Types ¶

extraction_config() ¶

-type extraction_config() :: #{ref_prefix :=
                                   binary()}.

4.5.2.2 Functions ¶

module_docs_extracted(Project, OutputDir, AppInfo, Config, Mod) ¶

-spec module_docs_extracted(Project ::
                                anvl_project:t(),
                            OutputDir :: file:filename(),
                            AppInfo :: anvl_erlc:app_info(),
                            Config :: extraction_config(),
                            Mod ::
                                module()) -> anvl_condition:t().

Render documentation for an Erlang module.

app_docs_extracted(A, B, C, D) ¶

-spec app_docs_extracted(Project ::
                             anvl_project:t(),
                         Profile :: anvl_erlc:profile(),
                         App :: anvl_erlc:application(),
                         extraction_config()) -> anvl_condition:t().

Render documentation for an Erlang application App compiled in profile Profile.

app_docs_extracted(Project, Profile, App) ¶

-spec app_docs_extracted(anvl_project:t(),
                         anvl_erlc:profile(),
                         anvl_erlc:application()) -> anvl_condition:t().

Equivalent to

erl_doc(Profile, App, #{ref_prefix => <<"Erlang">>})

app_doc_dir(Profile, App) ¶

-spec app_doc_dir(anvl_erlc:profile(),
                  anvl_erlc:application()) -> file:filename().

Return directory where the documentation is located.

includes_dir() ¶

-spec includes_dir() -> file:filename().

Path to the include file containing definitions of TexInfo macros.

4.5.2 Module anvl_texinfo_erlang ¶