Description:

This is a job executed by the ThreadPool in class DoxygenXLinks. The job loads a source file and searches and replaces XLink. This is used with option –doxyfy to create a version of the sources that are free of XLinks which can be used as input to Doxygen again for creating other output targets.

Definition at line 105 of file jobs.hpp.

#include <jobs.hpp>

Inheritance diagram for dxl::SourceReplacer:

Public Field Index:
DoxygenXLinks &	dxl
	The main linker class.
alib::files::File	srcFileNode
	The source-file to load and search for DoxygenXLinks links.
Public Field Index: inherited from dxl::DXLJob
DXLPoolWorker *	poolWorker
	The pool worker that executes this job.
Public Field Index: inherited from alib::threadmodel::Job
const std::type_info &	ID

Public Method Index:
	SourceReplacer (DoxygenXLinks &pDL, alib::files::File pSrcFileNode)
bool	Do () override
size_t	SizeOf () override
Public Method Index: inherited from alib::threadmodel::Job
	Job (const std::type_info &id)
TJob &	Cast ()
bool	Is ()
bool	IsNull ()
virtual void	PrepareDeferredDeletion ()

Field Details:

◆ dxl

DoxygenXLinks& dxl::SourceReplacer::dxl

The main linker class.

Definition at line 107 of file jobs.hpp.

◆ srcFileNode

alib::files::File dxl::SourceReplacer::srcFileNode

The source-file to load and search for DoxygenXLinks links.

Definition at line 110 of file jobs.hpp.

Constructor(s) / Destructor Details:

◆ SourceReplacer()

dxl::SourceReplacer::SourceReplacer	(	DoxygenXLinks &	pDL,
		alib::files::File	pSrcFileNode )

inline

Constructor.

Parameters

pDL	A reference to the main class.
pSrcFileNode	The source file to read and replace XLink in.

Definition at line 115 of file jobs.hpp.

Method Details:

◆ Do()

bool dxl::SourceReplacer::Do ( )

overridevirtual

Implements this job.

Returns: Constant true.

Reimplemented from alib::threadmodel::Job.

Definition at line 24 of file sourcereplacer.cpp.

◆ SizeOf()

size_t dxl::SourceReplacer::SizeOf ( )

inlineoverridevirtual

Overrides the parent function as necessary.

Returns: The sizeof this derived type.