omni
NAME

omni

SYNOPSIS

The root namespace for the Omni framework.

top

DESCRIPTION

The omni namespace is the root namespace for the Omni framework. It consists of multiple classes, types and functions to aid a developer in many different aspects and idioms of Software Engineering and Development.

top

PARAMETERS top

If - a function has any parameters, they will be noted in this section accordingly.

If - a function has any template parameters, they will be noted in this section accordingly.

RETURN VALUES

If a function has a return value, it will be noted in this section accordingly.

top

ERRORS

Any error conditions (null values, exception handling, etc.) a framework item might have will be detailed in this area.

top

CONSIDERATIONS

Any special considerations (memory management, pointer arithmetic, etc.) a framework item might have will be detailed in this area.

top

PLATFORM SPECIFIC

Different classes and functions within the framework might have different underlying API's based on the platform being targeted. Information on what platform specific details you might need to consider when using a function will be detailed in this area.

top

NOTES

Any additional notes or details that might need be explained will be presented in this section.

top

EXAMPLE
Currently no examples.
Visit the examples page for more.

top