This documentation is a collection of C++ class information in all cyCodeBase code releases. All the information presented here also exists in the source codes. The reason I have these documentation pages here is to provide a nicely formated, indexed and more readable documentation in a collective form.

Documentation pages are prepared using .

Version Info

All code releases have major and minor version numbers. For example, version 1.2 indicates major version 1 and minor version 2. Minor additions and bug fixes only change the minor version number. Major version number is incremented when there is a significant change. All versions have backwards compatibility with the previous version that have the same major version number. When the major version changes, backwards compatibility is not guaranteed.

Naming Convention

All file, class and struct names begin with "cy" prefix. All constants begin with "CY_", and all internal constants begin with "_CY_". All functions and class methods begin with an upper case letter. All variable names are written in lower case. If the function or variable name is made up of more than one word, each word begins with an upper case letter and the rest of the names use lower case letters.

A namespace is defined if you would like to use the classes without the "cy" prefix. Simply include the line

using namespace cy;

and then you can omit the prefixes. For example, you can use Point3f instead of cyPoint3f.