Skip to content

Commit

Permalink
docs(Scope): include lookups in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
alandefreitas committed Nov 5, 2024
1 parent 0b9f944 commit b078bea
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions include/mrdocs/Metadata/Scope.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,18 @@ namespace mrdocs {
class are the symbols and functions declared
in the class.
The Lookups are the symbols that are accessible
from the scope of the Info. For instance, the
Lookups["foo"] of a namespace are the symbols
declared as "foo" in the namespace.
This Info class can be used as a base class
for other Info classes, such as NamespaceInfo,
ClassInfo, that represent scopes. This class
can also be used with composition, such as in
@ref Interface to represent different scopes of
the same class (such as member and static overloads).
*/
struct ScopeInfo
{
Expand Down

0 comments on commit b078bea

Please sign in to comment.