mrdocs::Location::Location

Construct a location with optional fields.

Synopsis

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

constexpr
Location(
    std::string_view const full_path = {},
    std::string_view const short_path = {},
    std::string_view const source_path = {},
    unsigned int const line = 0,
    unsigned int const col = 0,
    bool const documented = false);

Parameters

Name

Description

full_path

Absolute path to the file on disk.

short_path

Repository‐ or search‐root relative path, may be empty.

source_path

Path relative to the documented source root.

line

Line number within the file.

col

Column number within the line.

documented

Whether the location already carries user documentation.

Created with MrDocs