mrdocs::Symbol

Base class with common properties of all symbols

Synopsis

Declared in <mrdocs/Metadata/Symbol/SymbolBase.hpp>

struct Symbol;

Member Functions

Name

Description

~Symbol [destructor] [virtual]

Polymorphic base needs a virtual destructor.

asInfo

asInfo overloads

operator<=>

Compare symbols by structural fields.

Data Members

Name

Description

Access

Declaration access.

Extraction

Determine why a symbol is extracted.

IsCopyFromInherited

Whether this a copy of an inherited method, as produced when inherit‐base‐members is not never.

Kind

Kind of declaration.

Loc

The source location information.

Name

The unqualified name.

Parent

The parent symbol, if any.

doc

The extracted documentation for this declaration.

id

The unique identifier for this symbol.

Protected Member Functions

Name

Description

Symbol [constructor]

Constructors

Non-Member Functions

Name

Description

canMerge

Check whether two symbols may be merged.

getPrimaryLocation

Determine a location to use when none is explicitly chosen.

merge

Merges two Symbol objects.

Derived Classes

Name Description

SymbolCommonBase

Base class for providing variant discriminator functions.

Created with MrDocs