mrdocs::Location

Source location of a symbol or entity.

Synopsis

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

struct Location;

Member Functions

Name

Description

Location [constructor]

Construct a location with optional fields.

Data Members

Name

Description

ColumnNumber

Column number within the line

Documented

Whether this location has documentation.

FullPath

The full file path

LineNumber

Line number within the file

ShortPath

The file path relative to one of the search directories

SourcePath

The file path relative to the source‐root directory

Non-Member Functions

Name

Description

getPrimaryLocation

Determine a location to use when none is explicitly chosen.

getPrimaryLocation

Choose the best location to display for a symbol.

Created with MrDocs