]> git.sesse.net Git - vlc/commitdiff
* skins2/*: fixed some doxygen comments
authorOlivier Teulière <ipkiss@videolan.org>
Sun, 30 Jul 2006 14:34:21 +0000 (14:34 +0000)
committerOlivier Teulière <ipkiss@videolan.org>
Sun, 30 Jul 2006 14:34:21 +0000 (14:34 +0000)
modules/gui/skins2/controls/ctrl_generic.hpp
modules/gui/skins2/src/generic_layout.hpp

index c3c491ac5ce0f1926c74bf64788db763947b9341..7ab7ea459392575c93f9dd7edadb4c294189b983 100644 (file)
@@ -66,8 +66,10 @@ class CtrlGeneric: public SkinObject, public Observer<VarBool>
         virtual UString getTooltipText() const
             { return UString( getIntf(), "" ); }
 
-        /// Overload this method if you want to do something special when
-        /// the layout is resized
+        /**
+         * Overload this method if you want to do something special when
+         * the layout is resized
+         */
         virtual void onResize() {}
 
         /// Get the help text
@@ -87,14 +89,18 @@ class CtrlGeneric: public SkinObject, public Observer<VarBool>
         CtrlGeneric( intf_thread_t *pIntf, const UString &rHelp,
                      VarBool *pVisible = NULL );
 
-        /// Tell the layout when the image has changed, with the size of the
-        /// rectangle to repaint and its offset.
-        /// Use the default values to repaint the whole window
+        /**
+         * Tell the layout when the image has changed, with the size of the
+         * rectangle to repaint and its offset.
+         * Use the default values to repaint the whole window
+         */
         virtual void notifyLayout( int witdh = -1, int height = -1,
                                    int xOffSet = 0, int yOffSet = 0 ) const;
 
-        /// Same as notifyLayout(), but takes optional images as parameters.
-        /// The maximum size(s) of the images will be used for repainting.
+        /**
+         * Same as notifyLayout(), but takes optional images as parameters.
+         * The maximum size(s) of the images will be used for repainting.
+         */
         void notifyLayoutMaxSize( const Box *pImg1 = NULL,
                                   const Box *pImg2 = NULL );
 
@@ -110,8 +116,10 @@ class CtrlGeneric: public SkinObject, public Observer<VarBool>
         /// Get the associated window, if any
         virtual TopWindow *getWindow() const;
 
-        /// Overload this method if you want to do something special when
-        /// the Position object is set
+        /**
+         * Overload this method if you want to do something special when
+         * the Position object is set
+         */
         virtual void onPositionChange() {}
 
         /// Overload this method to get notified of bool variable changes
index adf8a17d6b0ed8c4134c6676ed4bf50e4b8d2854..0f3066d1450998018a5030e6c01117a19ec669a6 100644 (file)
@@ -100,8 +100,10 @@ class GenericLayout: public SkinObject, public Box
         /// Resize the layout
         virtual void resize( int width, int height );
 
-        /// Add a control in the layout at the given position, and
-        /// the optional given layer
+        /**
+         * Add a control in the layout at the given position, and
+         * the optional given layer
+         */
         virtual void addControl( CtrlGeneric *pControl,
                                  const Position &rPosition,
                                  int layer );
@@ -110,9 +112,11 @@ class GenericLayout: public SkinObject, public Box
         virtual const list<LayeredControl> &getControlList() const;
 
         /// Called by a control when its image has changed
-        /// The arguments indicate the size of the rectangle to refresh,
-        /// and the offset (from the control position) of this rectangle.
-        /// Use a negative width or height to refresh the layout completely
+        /**
+         * The arguments indicate the size of the rectangle to refresh,
+         * and the offset (from the control position) of this rectangle.
+         * Use a negative width or height to refresh the layout completely
+         */
         virtual void onControlUpdate( const CtrlGeneric &rCtrl,
                                       int width, int height,
                                       int xOffSet, int yOffSet );