Author: mordante
Date: Thu Jun 19 17:33:43 2008
New Revision: 27321

URL: http://svn.gna.org/viewcvs/wesnoth?rev=27321&view=rev
Log:
Comment cleanups.

Modified:
    trunk/src/gui/widgets/tooltip.hpp

Modified: trunk/src/gui/widgets/tooltip.hpp
URL: 
http://svn.gna.org/viewcvs/wesnoth/trunk/src/gui/widgets/tooltip.hpp?rev=27321&r1=27320&r2=27321&view=diff
==============================================================================
--- trunk/src/gui/widgets/tooltip.hpp (original)
+++ trunk/src/gui/widgets/tooltip.hpp Thu Jun 19 17:33:43 2008
@@ -19,6 +19,12 @@
 
 namespace gui2 {
 
+/**
+ * A tooltip shows a 'floating' message.
+ *
+ * This is a small class which only has one state and that's active, so the
+ * functions implemented are mostly dummies.
+ */
 class ttooltip : public tcontrol
 {
 public:
@@ -29,14 +35,17 @@
                set_multiline_label();
        }
 
-       //! Inherited from tcontrol.
-       // We are always active, might not be visible but always active.
+       /** Inherited from tcontrol. */
        void set_active(const bool) {}
+
+       /** Inherited from tcontrol. */
        bool get_active() const { return true; }
+
+       /** Inherited from tcontrol. */
        unsigned get_state() const { return 0; }
 
 private:       
-       //! Inherited from tcontrol.
+       /** Inherited from tcontrol. */
        const std::string& get_control_type() const 
                { static const std::string type = "tooltip"; return type; }
 };


_______________________________________________
Wesnoth-commits mailing list
[email protected]
https://mail.gna.org/listinfo/wesnoth-commits

Reply via email to