Description:

This is a job executed by the ThreadPool in class DoxygenXLinks. The job loads a source file and searches for locations of the "original" source strings which are found in HTML files. With that information DoxygenXLinks is enabled to print the location of erroneous XLinks.
The job just collects the data. The result output is done later in a sorted fashion.

Definition at line 77 of file jobs.hpp.

#include <jobs.hpp>

Inheritance diagram for dxl::SourceLocationFinder:

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:
	SourceLocationFinder (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::SourceLocationFinder::dxl

The main linker class.

Definition at line 79 of file jobs.hpp.

◆ srcFileNode

alib::files::File dxl::SourceLocationFinder::srcFileNode

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

Definition at line 82 of file jobs.hpp.

Constructor(s) / Destructor Details:

◆ SourceLocationFinder()

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

inline

Constructor.

Parameters

pDL	A reference to the main class.
pSrcFileNode	The source file to read and search for XLinks.

Definition at line 87 of file jobs.hpp.

Method Details:

◆ Do()

bool dxl::SourceLocationFinder::Do ( )

overridevirtual

Implements this job.

Returns: Constant true.

Reimplemented from alib::threadmodel::Job.

Definition at line 52 of file sourcelocationfinder.cpp.

◆ SizeOf()

size_t dxl::SourceLocationFinder::SizeOf ( )

inlineoverridevirtual

Overrides the parent function as necessary.

Returns: The sizeof this derived type.