Update doxgen config and some comments.

This commit is contained in:
Thomas Geymayer
2014-05-29 00:27:50 +02:00
parent d77ba7d2db
commit 36ae8cdce3
4 changed files with 2071 additions and 547 deletions
+2055 -535
View File
File diff suppressed because it is too large Load Diff
+2 -1
View File
@@ -1,4 +1,4 @@
// The canvas for rendering with the 2d API ///@file The canvas for rendering with the 2d API
// //
// Copyright (C) 2012 Thomas Geymayer <tomgey@gmail.com> // Copyright (C) 2012 Thomas Geymayer <tomgey@gmail.com>
// //
@@ -34,6 +34,7 @@
namespace simgear namespace simgear
{ {
/// Canvas 2D drawing API
namespace canvas namespace canvas
{ {
class CanvasMgr; class CanvasMgr;
+2 -2
View File
@@ -38,8 +38,8 @@ namespace canvas
# define ENUM_MAPPING(name, str) name, # define ENUM_MAPPING(name, str) name,
# include "CanvasEventTypes.hxx" # include "CanvasEventTypes.hxx"
# undef ENUM_MAPPING # undef ENUM_MAPPING
CUSTOM_EVENT ///<! all user defined event types share the same id. They CUSTOM_EVENT ///< all user defined event types share the same id. They
/// are just differentiated by using the type string. /// are just differentiated by using the type string.
}; };
int type; int type;
+12 -9
View File
@@ -1,4 +1,4 @@
// Interface for 2D Canvas elements ///@file Interface for 2D Canvas elements
// //
// Copyright (C) 2012 Thomas Geymayer <tomgey@gmail.com> // Copyright (C) 2012 Thomas Geymayer <tomgey@gmail.com>
// //
@@ -41,6 +41,9 @@ namespace simgear
namespace canvas namespace canvas
{ {
/**
* Baseclass for Elements displayed inside a Canvas.
*/
class Element: class Element:
public PropertyBasedElement public PropertyBasedElement
{ {
@@ -69,10 +72,10 @@ namespace canvas
}; };
struct StyleInfo struct StyleInfo
{ {
StyleSetter setter; ///!< Function(s) for setting this style StyleSetter setter; ///< Function(s) for setting this style
std::string type; ///!< Interpolation type std::string type; ///< Interpolation type
bool inheritable; ///!< Whether children can inherit this style from bool inheritable; ///< Whether children can inherit this style from
/// their parents /// their parents
}; };
/** /**
@@ -80,10 +83,10 @@ namespace canvas
*/ */
enum ReferenceFrame enum ReferenceFrame
{ {
GLOBAL, ///!< Global coordinates GLOBAL, ///< Global coordinates
PARENT, ///!< Coordinates relative to parent coordinate frame PARENT, ///< Coordinates relative to parent coordinate frame
LOCAL ///!< Coordinates relative to local coordinates (parent LOCAL ///< Coordinates relative to local coordinates (parent
/// coordinates with local transformations applied) /// coordinates with local transformations applied)
}; };
/** /**