Description:

This class reads a doxygen INI-file and parses the values that DoxygenXLinks needs into its members.

Definition at line 21 of file doxyfile.hpp.

#include <doxyfile.hpp>

Inner Type Index:
struct	TagFileInfo

Public Field Index:
alib::ListMA< alib::system::PathString >	ExcludePaths
alib::ListMA< alib::String >	ExcludePatterns
bool	ExcludeSymlinks = false
alib::String	FilePatterns
alib::String	HtmlFileExtension
alib::system::PathString	HTMLFilePath
unsigned	HtmlSubfolderDepth = 0
alib::ListMA< alib::system::PathString >	InputPaths
bool	RecursiveInputScan = false
alib::ListMA< TagFileInfo >	TagFiles

Public Method Index:
	DoxygenINIFile (alib::MonoAllocator &ma)
void	Dump () const
	Writes the contents of this file to the console.
void	Load (const alib::system::Path &filePath)

Field Details:

◆ ExcludePaths

alib::ListMA<alib::system::PathString> dxl::DoxygenINIFile::ExcludePaths

A list of files or folders to be excluded

Read from variable EXCLUDE.

Definition at line 57 of file doxyfile.hpp.

◆ ExcludePatterns

alib::ListMA<alib::String> dxl::DoxygenINIFile::ExcludePatterns

A list of patterns to exclude from the input file list. Allows wildcards like ‍/test/ and patterns are applied to the full path of a file. Read from variable EXCLUDE_PATTERNS

Definition at line 62 of file doxyfile.hpp.

◆ ExcludeSymlinks

bool dxl::DoxygenINIFile::ExcludeSymlinks = false

Determines whether symlinks should be followed or not during input file scan.

Read from variable EXCLUDE_SYMLINKS

Definition at line 71 of file doxyfile.hpp.

◆ FilePatterns

alib::String dxl::DoxygenINIFile::FilePatterns

Doxygen input files patterns. Used to filter files in InputPaths.

Read from variable FILE_PATTERNS.

Definition at line 53 of file doxyfile.hpp.

◆ HtmlFileExtension

alib::String dxl::DoxygenINIFile::HtmlFileExtension

The extension of the generated Html-Files.
Read from variable HTML_FILE_EXTENSION. Doxygen defaults this to ".html".

Definition at line 41 of file doxyfile.hpp.

◆ HTMLFilePath

alib::system::PathString dxl::DoxygenINIFile::HTMLFilePath

The doxygen output directory for HTML files. This is our input directory. Read from variables HTML_OUTPUT, and, if this is a relative path, from OUTPUT_DIRECTORY.

Definition at line 37 of file doxyfile.hpp.

◆ HtmlSubfolderDepth

unsigned dxl::DoxygenINIFile::HtmlSubfolderDepth = 0

Specifies the number of subfolders of HTML-files created by Doxygen. Read from variable RECURSIVE

Definition at line 45 of file doxyfile.hpp.

◆ InputPaths

alib::ListMA<alib::system::PathString> dxl::DoxygenINIFile::InputPaths

Doxygen input files. Those are used to search for non-resolvable or ambiguous links.

Uses variable INPUT

Definition at line 49 of file doxyfile.hpp.

◆ RecursiveInputScan

bool dxl::DoxygenINIFile::RecursiveInputScan = false

Specifies if input folders are recursively scanned for files. Read from variable RECURSIVE

Definition at line 75 of file doxyfile.hpp.

◆ TagFiles

alib::ListMA<TagFileInfo> dxl::DoxygenINIFile::TagFiles

Holds the main documentations' tag-file specified by the variable GENERATE_TAGFILE, together with all external tag-files to use specified by variable TAGFILES.
Note that with that, all tag-files are treated with the same precedence.

Definition at line 67 of file doxyfile.hpp.

Constructor(s) / Destructor Details:

◆ DoxygenINIFile()

dxl::DoxygenINIFile::DoxygenINIFile ( alib::MonoAllocator & ma )

inline

Constructor

Parameters

ma	The allocator used to create the data.

Definition at line 79 of file doxyfile.hpp.

Method Details:

◆ Dump()

void dxl::DoxygenINIFile::Dump ( ) const

Writes the contents of this file to the console.

Definition at line 245 of file doxyfile.cpp.

◆ Load()

void dxl::DoxygenINIFile::Load ( const alib::system::Path & filePath )

Loads the doxygen INI-file (usually "Doxyfile") and reads the relevant values.