improved the doxygen documentation

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
+10 -10
View File
@@ -43,11 +43,11 @@ class SymbolPointEditor : public SymbolEditorBase {
void drawHandleCircle(DC& dc, UInt px, UInt py);
enum WhichPen {
PEN_NORMAL, //^ Pen for normal handles
PEN_HOVER, //^ Pen for hovered handles
PEN_LINE, //^ Pen for the line to handles
PEN_MAIN, //^ Pen for the main handle
PEN_NEW_POINT //^ Pen for the new point
PEN_NORMAL, ///< Pen for normal handles
PEN_HOVER, ///< Pen for hovered handles
PEN_LINE, ///< Pen for the line to handles
PEN_MAIN, ///< Pen for the main handle
PEN_NEW_POINT ///< Pen for the new point
};
/// Retrieve a pen for the drawing of parts of handles
wxPen handlePen(WhichPen p, LockMode lock);
@@ -91,11 +91,11 @@ class SymbolPointEditor : public SymbolEditorBase {
// Selection
enum Selection {
SELECTED_NONE, //^ no selection
SELECTED_POINTS, //^ some points are selected
SELECTED_HANDLE, //^ a handle is selected
SELECTED_LINE, //^ a line is selected
SELECTED_NEW_POINT //^ a new point on a line (used for hovering)
SELECTED_NONE, ///< no selection
SELECTED_POINTS, ///< some points are selected
SELECTED_HANDLE, ///< a handle is selected
SELECTED_LINE, ///< a line is selected
SELECTED_NEW_POINT ///< a new point on a line (used for hovering)
};
Selection selection;
// points
+1 -1
View File
@@ -32,7 +32,7 @@ class SymbolViewer : public SymbolView {
// --------------------------------------------------- : Point translation
Rotation rotation; //^ Object that handles rotation, scaling and translation
Rotation rotation; ///< Object that handles rotation, scaling and translation
// --------------------------------------------------- : Drawing
+3 -3
View File
@@ -35,8 +35,8 @@ class SymbolWindow : public Frame {
/// Actual initialisation
void init(Window* parent, SymbolP symbol);
SymbolControl* control; //^ The control for editing/displaying the symbol
SymbolPartList* parts; //^ A list of parts in the symbol
SymbolControl* control; ///< The control for editing/displaying the symbol
SymbolPartList* parts; ///< A list of parts in the symbol
// when editing a symbol field
// SymbolValueP value
@@ -65,7 +65,7 @@ class SymbolWindow : public Frame {
/// Activating a part: open the point editor
void onActivateFromList(wxListEvent& ev);
bool inSelectionEvent; //^ Prevent recursion in onSelect...
bool inSelectionEvent; ///< Prevent recursion in onSelect...
public:
void onSelectFromControl();