Bundlex.Doxygen (Bundlex v1.5.8)

Copy Markdown View Source

Module responsible for generating doxygen documentation for Bundlex projects.

Summary

Types

doxygen_t()

Functions

doxygen(project)

Prepares struct with all necessary filepaths for the native documentation

generate_doxyfile(doxygen)

Generates doxyfile in the c_src/project directory for Bundlex project.

generate_doxygen_documentation(doxygen)

Generates html doxygen documentation for the Bundlex project. Doxyfile must be generated before.

generate_hex_page(doxygen)

Generates page for the Bundlex project in the pages/doxygen directory. Page must be manually added to the docs extras in the mix.exs. Page contains only link to the doxygen html documentation.

Types

doxygen_t()

@type doxygen_t() :: %{
  project_name: String.t(),
  doxyfile_path: String.t(),
  doxygen_path: String.t(),
  page_path: String.t()
}

Functions

doxygen(project)

@spec doxygen(Bundlex.Project.t()) :: doxygen_t()

Prepares struct with all necessary filepaths for the native documentation

generate_doxyfile(doxygen)

@spec generate_doxyfile(doxygen_t()) :: :ok

Generates doxyfile in the c_src/project directory for Bundlex project.

generate_doxygen_documentation(doxygen)

@spec generate_doxygen_documentation(doxygen_t()) :: :ok

Generates html doxygen documentation for the Bundlex project. Doxyfile must be generated before.

generate_hex_page(doxygen)

@spec generate_hex_page(doxygen_t()) :: :ok

Generates page for the Bundlex project in the pages/doxygen directory. Page must be manually added to the docs extras in the mix.exs. Page contains only link to the doxygen html documentation.