r141 - in trunk/src: . objects
DONOTREPLY at icculus.org
DONOTREPLY at icculus.org
Sat Sep 3 10:21:55 EDT 2005
Author: jonas
Date: 2005-09-03 10:21:55 -0400 (Sat, 03 Sep 2005)
New Revision: 141
Modified:
trunk/src/editor.h
trunk/src/events.h
trunk/src/objects/plant.h
trunk/src/objects/teleport.h
Log:
a few additional documentations to avoid doxygen warnings and to get a better class hierarchy image
Modified: trunk/src/editor.h
===================================================================
--- trunk/src/editor.h 2005-09-03 13:17:01 UTC (rev 140)
+++ trunk/src/editor.h 2005-09-03 14:21:55 UTC (rev 141)
@@ -6,7 +6,7 @@
#define EDIT_ACT_BOX 0x00000008
#define EDIT_PLACE_OBJECT 0x00000010
-/** \brief abstract selection box base class
+/** \brief abstract Box base class
*/
class Box {
@@ -44,18 +44,27 @@
bool centered;
};
+/** \brief Main Box of the editor with all main options
+
+*/
class EditBox : public Box {
public:
EditBox(Sint16,Sint16);
virtual void act(Sint8);
};
+/** \brief Box used to choose the object that is to be placed
+
+*/
class PlaceBox : public Box {
public:
PlaceBox(Sint16,Sint16);
virtual void act(Sint8);
};
+/** \brief Abstract base class for text input boxes
+
+*/
class TextInputBox : public Box {
public:
TextInputBox(Sint16,Sint16);
@@ -70,6 +79,9 @@
virtual void update();
};
+/** \brief Configure object attributes
+
+*/
class ObjectBox : public TextInputBox {
public:
ObjectBox(string,string,Sint16,Sint16,string targ1="",string arg1="",string targ2="",string arg2="",string targ3="",string arg3="");
@@ -78,6 +90,9 @@
string objname;
};
+/** \brief Saves the map to the specified file
+
+*/
class SaveAsBox : public TextInputBox {
public:
SaveAsBox(Sint16,Sint16);
@@ -85,6 +100,9 @@
virtual void evaluateEntry();
};
+/** \brief Opens the specified map
+
+*/
class OpenMapBox : public TextInputBox {
public:
OpenMapBox(Sint16,Sint16);
@@ -92,6 +110,9 @@
virtual void evaluateEntry();
};
+/** \brief Creates a new map with the specified attributes
+
+*/
class NewMapBox : public TextInputBox {
public:
NewMapBox(Sint16,Sint16);
Modified: trunk/src/events.h
===================================================================
--- trunk/src/events.h 2005-09-03 13:17:01 UTC (rev 140)
+++ trunk/src/events.h 2005-09-03 14:21:55 UTC (rev 141)
@@ -53,6 +53,10 @@
*/
class AnimEvent : public Event {
public:
+ /// \param obj Owner object of the AnimEvent
+ /// \param length Duration of the animation, once it's started
+ /// \param edelay Delay until the animation is started
+ /// \param switchstate States that will be switched when the animation starts/ends
/// \param asound Sound (Mix_Chunk) to be played when the event starts
/// \param runanim Animation to be run when the event starts
/// \todo Get rid of the delanim parameter
@@ -97,11 +101,19 @@
*/
class EAttack : public CAnimEvent {
public:
+ /// \param chr Character owner of the AnimEvent
+ /// \param length Duration of the animation, once it's started
/// \param atweapon Weapon to be used for the attack
/// \param dir Directions to attack
/// \param weapon_range Range of the weapon starting from the
/// character into all specified directions
/// \param target_mask Mask for the object type of the targets to be hit
+ /// \param edelay Delay until the animation is started
+ /// \param switchstate States that will be switched when the animation starts/ends
+ /// \param esound Sound (Mix_Chunk) to be played when the event starts
+ /// \param runanim Animation to be run when the event starts
+ /// \todo Get rid of the delanim parameter
+ /// \param delanim True if the animation should be deleted
EAttack(Character* chr, Uint16 length, Weapon* atweapon, Uint16 dir, Uint16 weapon_range=0,
Uint16 target_mask=NOTHING, Uint16 edelay=0, Uint32 switchstate=0, Mix_Chunk* esound=NULL,
Animation* runanim=NULL, bool delanim=false);
@@ -121,8 +133,6 @@
class ERun : public CAnimEvent {
public:
/// Adds the initial speed
- /// \param inispeed Initial horizontal speed to be added
- /// \param ahspeed Horizontal speed to be added when the event starts
ERun(Character* chr, Uint16 length, Sint16 edmax, Uint16 edelay=0,
Uint32 switchstate=0, Mix_Chunk* esound=NULL, Animation* runanim=NULL, bool delanim=false);
virtual ~ERun();
Modified: trunk/src/objects/plant.h
===================================================================
--- trunk/src/objects/plant.h 2005-09-03 13:17:01 UTC (rev 140)
+++ trunk/src/objects/plant.h 2005-09-03 14:21:55 UTC (rev 141)
@@ -9,7 +9,7 @@
virtual ~Plant();
virtual void touch(Object*);
virtual void idle(Uint16);
- virtual Uint16 hit(Uint16 dir, Weapon& weap);
+ virtual Uint16 hit(Uint16 direction, Weapon& weap);
private:
Uint16 recover;
Sint16 tcur;
Modified: trunk/src/objects/teleport.h
===================================================================
--- trunk/src/objects/teleport.h 2005-09-03 13:17:01 UTC (rev 140)
+++ trunk/src/objects/teleport.h 2005-09-03 14:21:55 UTC (rev 141)
@@ -6,8 +6,12 @@
*/
class Teleporter : public Object {
public:
+ /// \param imagename Name of the image file used to display this object
+ /// \param xpos x coordinate of the object position
+ /// \param ypos y coordinate of the object position
/// \param xExit x coordinate of the exit position
/// \param yExit y coordinate of the exit position
+ /// \param name Name of this object
Teleporter(string imagename, Sint16 xpos=0, Sint16 ypos=0, Sint16 xExit=0, Sint16 yExit=0, string name="Teleporter");
virtual ~Teleporter();
virtual bool act(Object* obj);
More information about the lostpenguins-commits
mailing list