Skip to content

Commit b078bea

Browse files
committed
docs(Scope): include lookups in documentation
1 parent 0b9f944 commit b078bea

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

include/mrdocs/Metadata/Scope.hpp

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,18 @@ namespace mrdocs {
2929
class are the symbols and functions declared
3030
in the class.
3131
32+
The Lookups are the symbols that are accessible
33+
from the scope of the Info. For instance, the
34+
Lookups["foo"] of a namespace are the symbols
35+
declared as "foo" in the namespace.
36+
37+
This Info class can be used as a base class
38+
for other Info classes, such as NamespaceInfo,
39+
ClassInfo, that represent scopes. This class
40+
can also be used with composition, such as in
41+
@ref Interface to represent different scopes of
42+
the same class (such as member and static overloads).
43+
3244
*/
3345
struct ScopeInfo
3446
{

0 commit comments

Comments
 (0)