Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    primarykey
    data
    text
    <p>You can reference an achor (e.g. files, namespaces, classes, functions, variables, enums etc) using Doxygen's <a href="http://www.stack.nl/~dimitri/doxygen/commands.html#cmdref" rel="nofollow noreferrer"><code>ref</code></a> command using, for example</p> <pre><code>\ref variable_name </code></pre> <p>If the variable you want to document is not in the local namespace or scope, you can prefix the variable name with <code>namespace::</code>, where <code>namespace</code> is the scope or class where the variable you are referring to is defined. For example, consider the following two files (modified from examples in the Doxygen manual):</p> <p><strong>File 1</strong>:</p> <pre><code>/// A test class. /** A more elaborate class description. */ class Test { public: /// An enum. /** More detailed enum description. */ enum TEnum { TVal1, ///&lt; Enum value TVal1. TVal2, ///&lt; Enum value TVal2. TVal3 ///&lt; Enum value TVal3. } /// Enum pointer. /** Details. */ *enumPtr, /// Enum variable. /** Details. */ enumVar; /// A constructor. /** A more elaborate description of the constructor. */ Test(); }; </code></pre> <p><strong>File 2</strong>:</p> <pre><code>// Another test class. /** This class depends on the variable \ref Test::TEnum, defined in another file. It doesn't, actually, but I've said it does. */ class AnotherTest { public: /// A constructor AnotherTest(); }; </code></pre> <p>Here <code>TEnum</code> is defined in the class <code>Test</code> in the first file. So in the second file, we prefix the variable name with the class in which it is defined, i.e. <code>Test::TEnum</code>.</p> <p>See the accepted answer to the question <a href="https://stackoverflow.com/questions/4922679/reference-static-const-variables-declared-in-namespace">Reference static const variables declared in namespace</a> for more information on the global namespace prefix <code>::</code>.</p>
    singulars
    1. This table or related slice is empty.
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
 

Querying!

 
Guidance

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload