OSVR-Core  0.6-1962-g59773924
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
AnnotationMacrosC.h File Reference

Header containing macros for source-level annotation. More...

Go to the source code of this file.

Macros

#define OSVR_RETURN_SUCCESS_CONDITION(X)
 Applied to a typedef, indicates the condition for return under which a function returning it should be considered to have succeeded (thus holding certain specifications). More...
 
Function annotations

These indicate particular relevant aspects about a function. Some duplicate the effective meaning of parameter annotations: applying both allows the fullest extent of static analysis tools to analyze the code, and in some compilers, generate warnings.

#define OSVR_RETURN_WARN_UNUSED
 Indicates the function has a return value that must be used (either a security problem or an obvious bug if not). More...
 

Detailed Description

Header containing macros for source-level annotation.

In theory, supporting MSVC SAL, as well as compatible GCC and Clang attributes. In practice, expanded as time allows and requires.

Must be c-safe!

Date
2014
Author
Sensics, Inc. http://sensics.com/osvr

Definition in file AnnotationMacrosC.h.