View Source Bundlex.Doxygen (Bundlex v1.1.0)

Module responsible for generating doxygen documentation for Bundlex projects.

Link to this section Summary

Functions

Prepares struct with all necessary filepaths for the native documentation

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

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

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.

Link to this section Types

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

Link to this section Functions

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

Prepares struct with all necessary filepaths for the native documentation

Link to this function

generate_doxyfile(doxygen)

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

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

Link to this function

generate_doxygen_documentation(doxygen)

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

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

Link to this function

generate_hex_page(doxygen)

View Source
@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.