Author: ilor
Date: Mon Sep 22 22:28:52 2008
New Revision: 29650
URL: http://svn.gna.org/viewcvs/wesnoth?rev=29650&view=rev
Log:
editor2 action doc comment
Modified:
trunk/src/editor2/action.hpp
Modified: trunk/src/editor2/action.hpp
URL:
http://svn.gna.org/viewcvs/wesnoth/trunk/src/editor2/action.hpp?rev=29650&r1=29649&r2=29650&view=diff
==============================================================================
--- trunk/src/editor2/action.hpp (original)
+++ trunk/src/editor2/action.hpp Mon Sep 22 22:28:52 2008
@@ -14,7 +14,13 @@
/**
* @file action.hpp
- * Editor action classes
+ * Editor action classes. Some important points:
+ * - This is a polymorphic hierarchy of classes, so actions are usually passed
around
+ * as editor_action pointers
+ * - The pointers can, in general, be null. Always check for null before doing
anything.
+ * The helper functions perform_ that take a pointer do that.
+ * - The perform() functions can throw when an error occurs. Use smart
pointers if you
+ * need to ensure the pointer is deleted.
*/
#ifndef EDITOR2_ACTION_HPP
_______________________________________________
Wesnoth-commits mailing list
[email protected]
https://mail.gna.org/listinfo/wesnoth-commits
