summaryrefslogtreecommitdiff
path: root/SDL_Core/doc/doxygen/tools/InterfaceGenerator/Use of Output.txt
blob: b486fd7e377c15bdfd977f1ec58e957d7c826a8e (plain)
1
2
3
4
5
6
7
8
9
10
11
/*! \page tools_interfacegenerator_output Use of InterfaceGenerator output

As a result InterfaceGenerator produces one .cpp and one .hpp file in the output directory. Those files contain one C++ class which named in accordance with input XML file name. Class is declared and implemented in specified namespace. Also all enums form source XML file have automatically generated declarations within specified namespace.

Generated class is inherited form predefined base template class CSmartFactory. Actually this inherited class defines specific set of Smart Object schema's initialization methods which are set to the base class member and can be used by the clients.

Also generated code contains string mapping for enums that is used to convert string representation or enums to integer values and vice versa.

Result source code should be compilable but this is not guaranteed if source XML file contains identifier names that are not correct C++ identifiers.

*/