From 97571f801799e77920f32dbc433a805053fe6124 Mon Sep 17 00:00:00 2001
From: Christoph Sommer <mail@christoph-sommer.de>
Date: Sat, 28 Oct 2006 00:45:41 +0000
Subject: [PATCH] Added some markup for doxygen, fixed a doxygen warning

SVN-Revision: 4424
---
 src/object/ambient_sound.hpp  |  9 +++++++--
 src/object/background.hpp     |  2 +-
 src/object/candle.hpp         |  8 +++++++-
 src/object/display_effect.hpp | 10 ++++++++++
 src/object/level_time.hpp     |  9 +++++++++
 src/object/platform.hpp       |  9 +++++++++
 src/object/thunderstorm.hpp   |  9 +++++++++
 src/object/wind.hpp           |  9 +++++++++
 8 files changed, 61 insertions(+), 4 deletions(-)

diff --git a/src/object/ambient_sound.hpp b/src/object/ambient_sound.hpp
index 948df9c7e..8f4dbbce0 100644
--- a/src/object/ambient_sound.hpp
+++ b/src/object/ambient_sound.hpp
@@ -67,11 +67,16 @@ public:
     return position;
   }
 
-  // --- Scripting Interface ---
-
+  /** 
+   * @name Scriptable Methods
+   * @{ 
+   */
   void set_pos(float x, float y);
   float get_pos_x() const;
   float get_pos_y() const;
+  /** 
+   * @} 
+   */
 
 protected:
   virtual void hit(Player& player);
diff --git a/src/object/background.hpp b/src/object/background.hpp
index 6b4625e83..3321c923c 100644
--- a/src/object/background.hpp
+++ b/src/object/background.hpp
@@ -62,7 +62,7 @@ private:
   float speed_y; /**< scroll-speed in vertical direction */
   std::auto_ptr<Surface> image_top; /**< image to draw above pos */
   std::auto_ptr<Surface> image; /**< image to draw, anchored at pos */
-  std::auto_ptr<Surface> image_bottom; /**< image to draw below pos+<screenheight> */
+  std::auto_ptr<Surface> image_bottom; /**< image to draw below pos+screenheight */
 };
 
 #endif /*SUPERTUX_BACKGROUND_H*/
diff --git a/src/object/candle.hpp b/src/object/candle.hpp
index 95d005a40..f461a067f 100644
--- a/src/object/candle.hpp
+++ b/src/object/candle.hpp
@@ -42,10 +42,16 @@ public:
   virtual void expose(HSQUIRRELVM vm, SQInteger table_idx);
   virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
 
+  /** 
+   * @name Scriptable Methods
+   * @{ 
+   */
   void puff_smoke(); /**< spawn a puff of smoke */
-
   bool get_burning(); /**< returns true if candle is lighted */
   void set_burning(bool burning); /**< true: light candle, false: extinguish candle */
+  /** 
+   * @} 
+   */
 
 private:
   bool burning; /**< true if candle is currently lighted */
diff --git a/src/object/display_effect.hpp b/src/object/display_effect.hpp
index 582dcbe9d..d10ab8001 100644
--- a/src/object/display_effect.hpp
+++ b/src/object/display_effect.hpp
@@ -37,6 +37,12 @@ public:
     void update(float elapsed_time);
     void draw(DrawingContext& context);
 
+
+    /** 
+     * @name Scriptable Methods
+     * @{ 
+     */
+
     void fade_out(float fadetime);
     void fade_in(float fadetime);
     void set_black(bool enabled);
@@ -44,6 +50,10 @@ public:
     void sixteen_to_nine(float fadetime);
     void four_to_three(float fadetime);
 
+    /** 
+     * @} 
+     */
+
 private:
     enum FadeType {
         NO_FADE, FADE_IN, FADE_OUT
diff --git a/src/object/level_time.hpp b/src/object/level_time.hpp
index 98c792622..45f001a6e 100644
--- a/src/object/level_time.hpp
+++ b/src/object/level_time.hpp
@@ -38,6 +38,11 @@ public:
     void update(float elapsed_time);
     void draw(DrawingContext& context);
 
+    /** 
+     * @name Scriptable Methods
+     * @{ 
+     */
+
     /**
      * Resumes the countdown
      */
@@ -58,6 +63,10 @@ public:
      */
     void set_time(float time_left);
 
+    /** 
+     * @} 
+     */
+
 private:
     std::auto_ptr<Surface> time_surface;
     bool running;
diff --git a/src/object/platform.hpp b/src/object/platform.hpp
index 74cd70487..0815a7118 100644
--- a/src/object/platform.hpp
+++ b/src/object/platform.hpp
@@ -44,6 +44,11 @@ public:
     return speed;
   }
 
+  /** 
+   * @name Scriptable Methods
+   * @{ 
+   */
+
   /** Move platform until at given node, then stop */
   void goto_node(int node_no);
 
@@ -53,6 +58,10 @@ public:
   /** Stop platform at next node */
   void stop_moving();
 
+  /** 
+   * @} 
+   */
+
   virtual void expose(HSQUIRRELVM vm, SQInteger table_idx);
   virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
 
diff --git a/src/object/thunderstorm.hpp b/src/object/thunderstorm.hpp
index afbc5acb0..7aa8173ee 100644
--- a/src/object/thunderstorm.hpp
+++ b/src/object/thunderstorm.hpp
@@ -40,6 +40,11 @@ public:
     virtual void expose(HSQUIRRELVM vm, SQInteger table_idx);
     virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
 
+    /** 
+     * @name Scriptable Methods
+     * @{ 
+     */
+
     /**
      * Start playing thunder and lightning at configured interval
      */
@@ -70,6 +75,10 @@ public:
      */
     void electrify();
 
+    /** 
+     * @} 
+     */
+
 private:
     bool running; /**< whether we currently automatically trigger lightnings */
     float interval; /**< time between two lightnings */
diff --git a/src/object/wind.hpp b/src/object/wind.hpp
index 53304d6ff..864ca8088 100644
--- a/src/object/wind.hpp
+++ b/src/object/wind.hpp
@@ -40,6 +40,11 @@ public:
   void draw(DrawingContext& context);
   HitResponse collision(GameObject& other, const CollisionHit& hit);
 
+  /** 
+   * @name Scriptable Methods
+   * @{ 
+   */
+
   /**
    * start blowing
    */
@@ -50,6 +55,10 @@ public:
    */
   void stop();
 
+  /** 
+   * @} 
+   */
+
   virtual void expose(HSQUIRRELVM vm, SQInteger table_idx);
   virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
 
-- 
2.11.0