Description:

This is a job executed by the ThreadPool in class DoxygenXLinks. The job loads an HTML file and searches for XLinks and replaces them with an HTML anchor.

Definition at line 48 of file jobs.hpp.

#include <jobs.hpp>

Inheritance diagram for dxl::HTMLReplacer:

Public Field Index:
DoxygenXLinks &	dxl
	The main linker class.
alib::files::File	htmlFileNode
	The HTML-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:
	HTMLReplacer (DoxygenXLinks &pDL, alib::files::File pHtmlFileNode)
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::HTMLReplacer::dxl

The main linker class.

Definition at line 50 of file jobs.hpp.

◆ htmlFileNode

alib::files::File dxl::HTMLReplacer::htmlFileNode

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

Definition at line 53 of file jobs.hpp.

Constructor(s) / Destructor Details:

◆ HTMLReplacer()

dxl::HTMLReplacer::HTMLReplacer	(	DoxygenXLinks &	pDL,
		alib::files::File	pHtmlFileNode )

inline

Constructor.

Parameters

pDL	A reference to the main class.
pHtmlFileNode	The HTML file to read and search for XLinks.

Definition at line 58 of file jobs.hpp.

Method Details:

◆ Do()

bool dxl::HTMLReplacer::Do ( )

overridevirtual

Implements this job.

Returns: Constant true.

Reimplemented from alib::threadmodel::Job.

Definition at line 24 of file htmlreplacer.cpp.

◆ SizeOf()

size_t dxl::HTMLReplacer::SizeOf ( )

inlineoverridevirtual

Overrides the parent function as necessary.

Returns: The sizeof this derived type.