/** @mainpage
This is the documentation of the Magic Set Editor (MSE) source code, automatically generated using doxygen.
Before starting with the source code, you should take a look at the following:
- \subpage structure "Structure of the MSE source code"
- \subpage dependencies "Libraries and dependencies"
- \subpage coding_conventions "Coding conventions"
- \subpage tricks "Tricks used by MSE"
@page structure Structure of the MSE source code
The MSE source code is subdivided into several directories, with the following meaning:
- util: Utility functions and classes, stuff that would work equally well in another project
- util/io: Classes related to input and output
- gfx: Graphics related functions, again mostly independent of MSE.
This directory contains algorithms for image blending, scaling, and bezier curve functions.
- data: Data structures, like sets, cards, symbols, etc.
These data structures are documented in the 'Extending MSE' section of the official documentation.
- data/action: Actions that can be applied to those data structures.
- data/field: Data types for fields, values and styles. One source file per type.
- data/format: File formats and import/export stuff.
- script: The scripting system.
- gui: Graphical User Interface
- set: SetWindow related
- symbol: SymbolWindow related
- resource: Resource files used (icons, cursors, etc.)
See the directory list for details.
@page dependencies Libraries and dependencies
MSE depends on the following libraries:
- wxWidgets for the GUI.
- boost, just for shared_ptr and some preprocessor tricks.
Additional tools (not needed for building MSE) also depend on:
- doxygen for generating the documentation.
- Perl for small utility scripts
*/