dxl Namespace Reference

Description:

todox

Type Index:
struct	DoxygenINIFile
class	DoxygenXLinks
	class DoxygenXLinks More...
class	DXLApp
	class DXLApp More...
class	DXLExpression
struct	DXLExpressionFormatter
struct	DXLJob
	The base class DoxygenXLinks-jobs. More...
struct	DXLPoolWorker
	A customized ALib thread-pool worker. More...
struct	DXLScope
union	DXLTestUnion
class	DXLThreadPool
	A customized ALib thread-pool. More...
struct	ExclamationFile
struct	HTMLReplacer
class	Index
struct	IndexLoader
struct	Location
	A location of an XLink in a source or HTML file. More...
class	MappedFile
struct	ResolvedLocation
struct	SourceLocationFinder
struct	SourceReplacer
class	Styles
class	Target
class	TestAString
struct	TGTConcept
	XLink target information for C++ concepts. More...
struct	TGTDir
	XLink target information for source files. More...
struct	TGTDocAnchor
	XLink target information for pages. More...
struct	TGTEnumeration
	XLink target information for C++ enums. More...
struct	TGTEnumValue
	XLink target information for C++ enum elements. More...
struct	TGTFile
	XLink target information for source files. More...
struct	TGTFilePathComponent
struct	TGTFunction
	XLink target information for C++ namespace- and member-functions. More...
struct	TGTGenericMember
struct	TGTGroup
	XLink target information for groups. More...
struct	TGTMacro
	XLink target information for C++ preprocessor definitions. More...
struct	TGTMember
struct	TGTNamespace
	XLink target information for C++ namespaces. More...
struct	TGTPage
	XLink target information for pages. More...
struct	TGTRecord
	XLink target information for C++ structs, classes and unions. More...
struct	TGTTypedef
	XLink target information for type definitions. More...
struct	TGTVariable
	XLink target information for C++ namespace- and member-variables. More...
class	XLink

Type Definition Index:
using	ChainedAString = alib::AString
using	XLinkList = alib::StdVectorMA<ResolvedLocation>
using	XLinkType = dxl::XLink

Enumeration Index:
enum class	Exceptions {   ErrorOpeningFile = 1 , UnknownKind = 2 , XMLSyntaxError = 10 , NotATagStart = 11 ,   UnexpectedXMLTag = 12 , XMLEndTagNotInSameLine = 13 , FileNotOnRootLevel = 14 , DuplicateChildName = 15 ,   DuplicateCompound = 16 , UnexpectedXMLValue = 17 }
enum class	ExitCodes {   OK = 0 , CantOpenDoxyfile = 20 , NoTagfileGeneratedByDoxyfile = 21 , OtherErrorInDoxyfile = 22 ,   TagFileNotFound = 23 , NoHTMLFilesFound = 24 , CantOpenHMLFile = 25 , CantWriteHMLFile = 26 ,   NoSourceFilesFound = 27 , CantOpenSrcFile = 28 , NoSourceCopiesFound = 29 , CantOpenReplSrcFile = 30 ,   CantWriteReplSrcFile = 31 }

Function Index:
template<typename TGT, typename TCheck = alib::CHK>
const TGT *	Cast (const Index::Node &node)
template<typename TGT, typename TCheck = alib::CHK>
const TGT *	Cast (const Target *target)
template<typename TGT>
TGT &	Cast (Target &target)
void	ConvertASCIItoHTMLEntities (alib::AString &buffer)
void	ConvertHTMLEntitiesToAscii (alib::AString &buffer)
template<int N>
void	foo (int a)
template<typename T>
void	foo (T a)

Variable Index:
bool	FindInheritedMembers
	Denotes whether to find inherited members..

Type Definition Details:

ChainedAString

using dxl::ChainedAString = alib::AString

This type definition is not used in the code. It is for testing whether DoxygenXLinks finds members through chained type definitions.

Definition at line 74 of file dxl.hpp.

XLinkList

using dxl::XLinkList = alib::StdVectorMA<ResolvedLocation>

This type is attached to file tree nodes of source files. It lists all places of links in the file.

Definition at line 40 of file xlink.hpp.

XLinkType

using dxl::XLinkType = dxl::XLink

This type definition is not used in the code. It is for testing in manual section 2. CSS Link Styles for HTML Output.

Definition at line 62 of file dxl.hpp.

Enumeration Details:

Exceptions

enum class dxl::Exceptions

strong

TODO(251212 17:24): Ich glaube wirklich das kann man löschen und nur noch die app::App::Exceptions::ControlledEarlyExit werfen! Zuletzt zumindest alle durchgehen und schauen welche noch benutzt werden

Enumerator
ErrorOpeningFile	todox
UnknownKind	todox
XMLSyntaxError	todox
NotATagStart	todox
UnexpectedXMLTag	todox
XMLEndTagNotInSameLine	todox
FileNotOnRootLevel	todox
DuplicateChildName	todox
DuplicateCompound	todox
UnexpectedXMLValue	todox

Definition at line 108 of file dxl.hpp.

ExitCodes

enum class dxl::ExitCodes

strong

The possible exit codes of the application. In addition to these, the codes defined with BuiltInExitCodes and ExitCodes might occur.

Enumerator
OK	All went well.
CantOpenDoxyfile	Doxygen INI-file (usually Doxyfile) not found.
NoTagfileGeneratedByDoxyfile	Doxygen INI-file entry GENERATE_TAGFILE needs to be set to enable DoxygenXLinks.
OtherErrorInDoxyfile	Some other error occurred when parsing the Doxygen INI-file.
TagFileNotFound	Doxygen tag-file not created, yet. Needs a second run.
NoHTMLFilesFound	HTML files to process not found.
CantOpenHMLFile	A HTML file was not found or could not be accessed.
CantWriteHMLFile	A HTML file that was read before, could not be written.
NoSourceFilesFound	No sources found with the specification given in the Doxyfile.
CantOpenSrcFile	A source file was not found or could not be accessed.
NoSourceCopiesFound	No sources found with the specification given in the Doxyfile.
CantOpenReplSrcFile	A replacement source file was not found or could not be accessed.
CantWriteReplSrcFile	A replacement source file was not found or could not be accessed.

Definition at line 87 of file dxl.hpp.

Function Details:

Cast() [1/3]

template<typename TGT, typename TCheck = alib::CHK>

const TGT * dxl::Cast

(

const Index::Node &

node

)

Shortcut to Cast(const Target*) passing the given node's value.

Template Parameters

TGT	The requested target type.
TCheck	If NC is given, no check whether the right kind is contained in this node is performed. Defaults to CHK.

Parameters

node	The index-node.

Returns

The cast type or nullptr if the node's target is not of the requested type.

Definition at line 544 of file index.hpp.

Cast() [2/3]

template<typename TGT, typename TCheck = alib::CHK>

const TGT * dxl::Cast

(

const Target *

target

)

Casts the given Target pointer to the requested derived type TGT. In case of fai3lure returns nullptr.

Template Parameters

TGT	The requested target type.
TCheck	If NC is given, no check whether the right kind is contained in this target is performed. Defaults to CHK.

Parameters

target

The instance to cast.

Returns

The cast type or nullptr if target is not of the requested type.

Definition at line 498 of file target.hpp.

Cast() [3/3]

template<typename TGT>

TGT & dxl::Cast

(

Target &

target

)

Overload of Cast(const Target*) which works with references and calls its non-checking version.

Template Parameters

TGT	The requested target type.

Parameters

target

The instance to cast.

Returns

The cast type or nullptr if target is not of the requested type.

Definition at line 538 of file target.hpp.

ConvertASCIItoHTMLEntities()

void dxl::ConvertASCIItoHTMLEntities

(

alib::AString &

buffer

)

The counter-function of ConvertHTMLEntitiesToAscii. Also converts quotes '"' to HTML entity "\"" (what the counter-function does not do).

Parameters

buffer

The buffer to search for ASCII characters to be converted to HTML entities.

Definition at line 133 of file dxl.cpp.

ConvertHTMLEntitiesToAscii()

void dxl::ConvertHTMLEntitiesToAscii

(

alib::AString &

buffer

)

Converts the following HTML-entities to ASCII-code characters in the given string buffer:

HTML Entity	ASCII Character
&lt;	<
&gt;	>
&amp;	&
&apos;	'
&lsqb;	[
&rsqb;	]
&commat;	@
&dollar;	$
&nbsp;	' '

Note

HTML entity "\"" is kept in!

See also

Function ConvertASCIItoHTMLEntities which does the opposite.

Parameters

buffer

The buffer to search for HTML entities and convert them to ASCII.

Definition at line 104 of file dxl.cpp.

foo() [1/2]

template<int N>

void dxl::foo

(

int

a

)

Template 2

Parameters

a

An A.

Template Parameters

N

Type int.

Definition at line 31 of file dxlapp.hpp.

foo() [2/2]

template<typename T>

void dxl::foo

(

T

a

)

Template 1

Parameters

a

An A.

Template Parameters

T

Any type.

Definition at line 26 of file dxlapp.hpp.