[#mrdocs-Location]
= xref:mrdocs.adoc[mrdocs]::Location
:relfileprefix: ../
:mrdocs:

Source location of a symbol or entity&period;

== Synopsis

Declared in `&lt;mrdocs&sol;Metadata&sol;Symbol&sol;Location&period;hpp&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct Location;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/Location/2constructor.adoc[`Location`]         [.small]#[constructor]#
| Construct a location with optional fields&period;
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/Location/ColumnNumber.adoc[`ColumnNumber`] 
| Column number within the line
| xref:mrdocs/Location/Documented.adoc[`Documented`] 
| Whether this location has documentation&period;
| xref:mrdocs/Location/FullPath.adoc[`FullPath`] 
| The full file path
| xref:mrdocs/Location/LineNumber.adoc[`LineNumber`] 
| Line number within the file
| xref:mrdocs/Location/ShortPath.adoc[`ShortPath`] 
| The file path relative to one of the search directories
| xref:mrdocs/Location/SourcePath.adoc[`SourcePath`] 
| The file path relative to the source&hyphen;root directory
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/getPrimaryLocation-0a.adoc[`getPrimaryLocation`]
| Determine a location to use when none is explicitly chosen&period;
| xref:mrdocs/getPrimaryLocation-0f.adoc[`getPrimaryLocation`]
| Choose the best location to display for a symbol&period;
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
