Commit 063e0347 authored by twanvl's avatar twanvl

minor cleanup of comments and includes

parent 44a4b0ca
...@@ -7,7 +7,6 @@ ...@@ -7,7 +7,6 @@
// ----------------------------------------------------------------------------- : Includes // ----------------------------------------------------------------------------- : Includes
#include <data/field/information.hpp> #include <data/field/information.hpp>
#include <util/tagged_string.hpp>
#include <script/script.hpp> #include <script/script.hpp>
// ----------------------------------------------------------------------------- : InfoField // ----------------------------------------------------------------------------- : InfoField
......
...@@ -11,7 +11,6 @@ ...@@ -11,7 +11,6 @@
#include <util/prec.hpp> #include <util/prec.hpp>
#include <render/value/viewer.hpp> #include <render/value/viewer.hpp>
#include <render/text/viewer.hpp>
#include <data/field/information.hpp> #include <data/field/information.hpp>
// ----------------------------------------------------------------------------- : InfoValueViewer // ----------------------------------------------------------------------------- : InfoValueViewer
......
...@@ -72,10 +72,10 @@ class ActionStack { ...@@ -72,10 +72,10 @@ class ActionStack {
void add(Action* action, bool allowMerge = true); void add(Action* action, bool allowMerge = true);
/// Undoes the last action that was (re)done /// Undoes the last action that was (re)done
/// @pre canUndo() /** @pre canUndo() */
void undo(); void undo();
/// Redoes the last action that was undone /// Redoes the last action that was undone
/// @pre canRedo() /** @pre canRedo() */
void redo(); void redo();
/// Is undoing possible? /// Is undoing possible?
...@@ -83,15 +83,15 @@ class ActionStack { ...@@ -83,15 +83,15 @@ class ActionStack {
/// Is redoing possible? /// Is redoing possible?
bool canRedo() const; bool canRedo() const;
/// Name of the action that will be undone next, in the form "Undo <Action>" /// Name of the action that will be undone next, in the form " <Action>"
/// If there is no action to undo returns "Undo" /** If there is no action to undo returns "" */
String undoName() const; String undoName() const;
/// Name of the action that will be redone next "Redo <Action>" /// Name of the action that will be redone next " <Action>"
/// If there is no action to undo returns "Redo" /** If there is no action to undo returns "" */
String redoName() const; String redoName() const;
/// Is the file currently at a 'savepoint'? /// Is the file currently at a 'savepoint'?
/// This is the last point at which the file was saved /** This is the last point at which the file was saved. */
bool atSavePoint() const; bool atSavePoint() const;
/// Indicate that the file is at a savepoint. /// Indicate that the file is at a savepoint.
void setSavePoint(); void setSavePoint();
...@@ -104,11 +104,11 @@ class ActionStack { ...@@ -104,11 +104,11 @@ class ActionStack {
void tellListeners(const Action&, bool undone); void tellListeners(const Action&, bool undone);
private: private:
/// Actions to be undone /// Actions to be undone.
/// Owns the action objects! /** Owns the action objects! */
vector<Action*> undo_actions; vector<Action*> undo_actions;
/// Actions to be redone /// Actions to be redone
/// Owns the action objects! /** Owns the action objects! */
vector<Action*> redo_actions; vector<Action*> redo_actions;
/// Point at which the file was saved, corresponds to the top of the undo stack at that point /// Point at which the file was saved, corresponds to the top of the undo stack at that point
Action* save_point; Action* save_point;
...@@ -119,15 +119,16 @@ class ActionStack { ...@@ -119,15 +119,16 @@ class ActionStack {
// ----------------------------------------------------------------------------- : Utilities // ----------------------------------------------------------------------------- : Utilities
/// Tests if variable has the type Type /// Tests if variable has the type Type.
/** Uses dynamic cast, so Type must have a virtual function. /** Uses dynamic cast, so Type must have a virtual function.
*/ */
#define TYPE_CASE_(variable, Type) \ #define TYPE_CASE_(variable, Type) \
if (dynamic_cast<const Type*>(&variable)) if (dynamic_cast<const Type*>(&variable))
/// Tests if variable has the type Type. If this is the case, makes /// Tests if variable has the type Type.
/// variable have type Type inside the statement /** If this is the case, makes variable have type Type inside the statement.
/** Uses dynamic cast, so Type must have a virtual function. *
* Uses dynamic cast, so Type must have a virtual function.
*/ */
#define TYPE_CASE(variable, Type) \ #define TYPE_CASE(variable, Type) \
pair<const Type*,bool> Type##variable \ pair<const Type*,bool> Type##variable \
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment