Internal SDK

Introduction

Internal SDK documentation of the IUP library, automatically generated using Doxygen (http://www.doxygen.org/).

Code Standards

Function Names (prefix format)

• IupFunc - User API, implemented in the core
• iupFunc - Internal Core API, implemented in the core, used in the core or in driver
• iupxxxFunc - Windows Internal API, implemented in driver xxx, used in driver xxx
• iupdrvFunc - Driver API, implemented in driver, used in the core or driver
• xxxFunc - Driver xxx local functions

Global Variables (lower case format)

• iupxxx_var

Local Variables (lower case format, using module name)

• iyyy_var

File Names

• iupyyy.h - public headers
• iup_yyy.h/c - core
• iupxxx_yyy.h/c - driver

Structures

• Iyyy

File Comments (at start)

• Check an existent file for example.

Defines

• __IUPXXX_H (for include file, same file name, upper case, "__" prefix and replace "." by "_")
• IUP_XXX (for global enumerations)
• IXXX_YYY (for local enumerations)
• iupXXX (for macros, complement with Function Names rules)

Documentation

• In the header, using Doxygen commands.
• Check an existent header for example.