120500b5cb
the Doxygen documentation. Documenters can just put *.dox files into the documentation/text/ directory which describe how to do things with MetalSVM. making_coffee.dox is still missing - anyone?
18 lines
757 B
Text
18 lines
757 B
Text
/**
|
|
* @file config.dox
|
|
* @page config The MetalSVM feature configuration file
|
|
*
|
|
* @section conf MetalSVM's configuration file
|
|
*
|
|
* MetalSVM's configuration parameters and some features can be configured/activated in the central configuration file located at \c include/metalsvm/config.h.
|
|
*
|
|
* The \c config.h is a usual C-header file and the configuration items are usual C preprocessor-definitions like the following:
|
|
* \code
|
|
#define CONFIGURATION_PARAMETER 123value /* A parameter with a value */
|
|
#define FEATURE_A /* An activated feature */
|
|
//#define FEATURE_B /* A deactivated feature */\endcode
|
|
*
|
|
* Just like the example suggests, features are deactivated by commenting them out.
|
|
*
|
|
*
|
|
*/
|