Doxygen XLinks
by
V: 2511R0
Website: doxygen
Loading...
Searching...
No Matches
dxl::TGTDocAnchor Struct Reference

Description:

XLink target information for pages.

Definition at line 307 of file target.hpp.

#include <target.hpp>

Inheritance diagram for dxl::TGTDocAnchor:
dxl::Target

Public Field Index:

alib::String Name
alib::String Title
 The title of the group.
Public Field Index: inherited from dxl::Target
alib::String HTMLFile
 The HTML file that this target links to (or into).
int LineNo
 The line number in the Doxygen tag-file where this entity is defined.

Public Method Index:

 TGTDocAnchor (const alib::String &htmlFile, int lineNo, alib::String &name, alib::String &title)
Public Method Index: inherited from dxl::Target
bool IsA (Kinds aKind) const
Kinds Kind () const

Additional Inherited Members

Public Type Index: inherited from dxl::Target
enum  Kinds : unsigned {
  Dir = (1 << 0) , File = (1 << 1) , Page = (1 << 2) , Group = (1 << 3) ,
  DocAnchor = (1 << 4) , Namespace = (1 << 5) , Struct = (1 << 6) , Class = (1 << 7) ,
  Union = (1 << 8) , Concept = (1 << 9) , Macro = (1 <<10) , Typedef = (1 <<11) ,
  Variable = (1 <<12) , Function = (1 <<13) , Enumeration = (1 <<14) , EnumElement = (1 <<15) ,
  GenericMember = (1 <<16) , FILEPATH_COMPONENT = (1 <<17) , UNKNOWN_COMPOUND = (1 <<18) , UNSPECIFIED = (1 <<19) ,
  MAX_KIND = 19 , ROOT = (1 <<20) , UNRESOLVED = (1 <<21) , MEMBER = Macro + Typedef + Variable + Function + Enumeration + EnumElement ,
  RECORD = Struct + Class + Union , COMPOUND = RECORD + Namespace
}
 Enumerates the kinds of compounds found in a the Doxygen tagfile. More...
Public Static Field Index: inherited from dxl::Target
static size_t MAX_TEMPLATE_ARGS = 64
Public Static Method Index: inherited from dxl::Target
static TargetGetRootNodeTarget ()
Protected Field Index: inherited from dxl::Target
Kinds kind
 The kind of this target.
Protected Method Index: inherited from dxl::Target
 Target (Kinds pKind, const alib::String &htmlFile, int lineNo)

Field Details:

◆ Name

alib::String dxl::TGTDocAnchor::Name

The key of the anchor. This is redundant with its node name, but needed, as anchors of members can be inserted only after the member was read.

Definition at line 310 of file target.hpp.

◆ Title

alib::String dxl::TGTDocAnchor::Title

The title of the group.

Definition at line 313 of file target.hpp.

Constructor(s) / Destructor Details:

◆ TGTDocAnchor()

dxl::TGTDocAnchor::TGTDocAnchor ( const alib::String & htmlFile,
int lineNo,
alib::String & name,
alib::String & title )
inline

Constructor.

Parameters
htmlFileThe HTML file that this instance targets.
lineNoThe definition line number in the Doxygen tag-file.
nameThe name (key) of the anchor.
titleThe title of the anchor.

Definition at line 320 of file target.hpp.


The documentation for this struct was generated from the following file: