amy/MagicSetEditor2
1
0
Fork 0
mirror of https://github.com/amyinspace/MagicSetEditor2.git synced 2026-06-12 05:36:59 -04:00
Code Issues Packages Projects Releases Wiki Activity

improved the doxygen documentation

Browse Source 
git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@4 0fc631ac-6414-0410-93d0-97cfa31319b6
This commit is contained in:
twanvl
2006-10-01 15:18:40 +00:00
parent a9b6c73407
commit 50b22e9478
24 changed files with 340 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/util/reflect.hpp
+11 -11
View File
@@ -9,7 +9,7 @@
/** @file util/reflect.hpp
*
* Reflection of classes, currently reflection is used for (de)serialization.
* @brief Reflection of classes, currently reflection is used for (de)serialization.
*/
// ----------------------------------------------------------------------------- : Includes
@@ -41,18 +41,18 @@
// ----------------------------------------------------------------------------- : Implementing reflection
/// Implement the refelection of a class type Cls
/// Reflection allows the member variables of a class to be inspected at runtime.
///
/// Currently creates the methods:
/// - Reader::handle(Cls&)
/// - Writer::handle(Cls&)
/** Usage:
* \begincode
/** Reflection allows the member variables of a class to be inspected at runtime.
*
* Currently creates the methods:
* - Reader::handle(Cls&)
* - Writer::handle(Cls&)
* Usage:
* @code
* IMPLEMENT_REFLECTION(MyClass) {
* REFLECT(a_variable_in_my_class);
* REFLECT(another_variable_in_my_class);
* }
* \endcode
* @endcode
*/
#define IMPLEMENT_REFLECTION(Cls) \
REFLECT_OBJECT_READER(Cls) \
@@ -80,12 +80,12 @@
/// Implement the refelection of a enumeration type Enum
/** Usage:
* \begincode
* @code
* IMPLEMENT_REFLECTION_ENUM(MyEnum) {
* VALUE(value_of_enum_1);
* VALUE(value_of_enum_2);
* }
* \endcode
* @endcode
*
* When reading the first value declared is the default value
*