Omniverse Documentation System API¶
Class Hierarchy¶
-
-
namespace example
- class ExampleDoxygen
- struct OpaqueStruct
-
namespace example
File Hierarchy¶
-
-
Directory example
- File ExampleDoxygen.h
-
Directory example
Namespaces¶
example: Namespaces can be documented like any other entity. In fact, namespace must be documented in order for variables and functions to appear in Doxygen’s output. Only a single instance of the namespace should be documented.
Classes and Structs¶
example::OpaqueStruct: Opaque C structs (such as carb::tasking::Counter) will not be processed by Doxygen as forward declarations. Use the @struct command to explicitly document the opaque struct.
example::ExampleDoxygen: This is a class. The text up to the first empty line is considered the “brief” comment. It can span multiple sentences and lines, much like this comment.