fixed more doxygen issues

include/fifechan/backends/directx3d/directx3dimage.hpp

@@ -26,6 +26,8 @@ namespace fcn
          *
          * @param surface The surface from which to load.
          * @param device The D3D device to use when converting the image to display format.
+         * @param width The width of the image.
+         * @param height The height of the image.
          * @param autoFree True if the surface should automatically be deleted.
          */
         DirectX3DImage(LPDIRECT3DSURFACE9 surface, LPDIRECT3DDEVICE9 device, int width, int height, bool autoFree);

include/fifechan/backends/sdl/sdlimage.hpp

@@ -29,6 +29,7 @@ namespace fcn
          *
          * @param surface the surface from which to load.
          * @param autoFree true if the surface should automatically be deleted.
+         * @param renderer the renderer to use for creating the texture.
          */
         SDLImage(SDL_Surface* surface, bool autoFree, SDL_Renderer* renderer = nullptr);
 

include/fifechan/backends/sdl/sdltruetypefont.hpp

@@ -71,7 +71,7 @@ namespace fcn
         /**
          * Sets the use of anti aliasing..
          *
-         * @param antaAlias true for use of anti aliasing.
+         * @param antiAlias true for use of anti aliasing.
          */
         virtual void setAntiAlias(bool antiAlias);
 

include/fifechan/color.hpp

@@ -106,7 +106,7 @@ namespace fcn
          * @param out The stream to output to.
          * @param color The color to output.
          */
-        friend std::ostream& operator<<(std::ostream& out, Color const & Color);
+        friend std::ostream& operator<<(std::ostream& out, Color const & color);
 
         /**
          * Holds the red color component (range 0-255).

include/fifechan/focushandler.hpp

@@ -246,7 +246,7 @@ namespace fcn
         /**
          * Sets the last widget with modal mouse input focus.
          *
-         * @param lastMouseWithModalMouseInputFocus The last widget with
+         * @param lastWidgetWithModalMouseInputFocus The last widget with
          *                                          modal mouse input focus.
          * @see getLastWidgetWithModalMouseInputFocus
          */

include/fifechan/gui.hpp

@@ -323,6 +323,7 @@ namespace fcn
         /**
          * Distributes a mouse event.
          *
+         * @param source The source widget of the event.
          * @param type The type of the event to distribute,
          * @param button The button of the event (if any used) to distribute.
          * @param x The x coordinate of the event.

include/fifechan/mouselistener.hpp

@@ -69,7 +69,7 @@ namespace fcn
         /**
          * Called when the mouse wheel has moved down on the widget area.
          *
-         * @param eEvent Describes the event.
+         * @param mouseEvent Describes the event.
          */
         virtual void mouseWheelMovedDown(MouseEvent& mouseEvent) { }
 

include/fifechan/text.hpp

@@ -54,6 +54,7 @@ namespace fcn
          * Sets the content of a row.
          *
          * @param row The row to set the text of.
+         * @param content The content of the row.
          * @throws Exception when the row does not exist.
          */
         virtual void setRow(unsigned int row, std::string const & content);
@@ -214,6 +215,7 @@ namespace fcn
          * present in the text zero will be returned.
          *
          * @param row The row to get the width of.
+         * @param font The font to use when calculating the width.
          * @return The width in pixels of a row.
          */
         virtual int getWidth(int row, Font* font) const;

include/fifechan/widget.hpp

@@ -1196,7 +1196,7 @@ namespace fcn
          * needed if both a widget in the widget and the widget itself
          * should be focused at the same time.
          *
-         * @param focusHandler The internal focus handler to be used.
+         * @param internalFocusHandler The internal focus handler to be used.
          * @see getInternalFocusHandler
          */
         void setInternalFocusHandler(FocusHandler* internalFocusHandler);
@@ -1263,7 +1263,7 @@ namespace fcn
          * XML document, a certain widget can be retrieved given that the widget
          * has an id.
          *
-         * @param id The id to set to the widget.
+         * @return The id of the widget.
          * @see setId, BasicContainer::findWidgetById
          */
         std::string const & getId() const;

include/fifechan/widgets/bargraph.hpp

@@ -50,7 +50,8 @@ namespace fcn
         void setBarPosition(int x, int y);
 
         /**
-         * @return The position of the bar.
+         * Sets the position of the bar.
+         * @param pos The position of the bar.
          */
         void setBarPosition(Point const & pos);
 

include/fifechan/widgets/checkbox.hpp

@@ -44,7 +44,7 @@ namespace fcn
          * to fit the caption.
          *
          * @param caption The caption of the check box.
-         * @param marked True if the check box is selected, false otherwise.
+         * @param selected True if the check box is selected, false otherwise.
          */
         explicit CheckBox(std::string const & caption, bool selected = false);
 

include/fifechan/widgets/container.hpp

@@ -191,7 +191,7 @@ namespace fcn
         /**
          * Set the vertical spacing between rows.
          *
-         * @param verticalSpacing spacing in pixels.
+         * @param spacing spacing in pixels.
          * @see getVerticalSpacing
          */
         virtual void setVerticalSpacing(unsigned int spacing);
@@ -207,7 +207,7 @@ namespace fcn
         /**
          * Set the horizontal spacing between columns.
          *
-         * @param horizontalSpacing spacing in pixels.
+         * @param spacing spacing in pixels.
          * @see getHorizontalSpacing
          */
         virtual void setHorizontalSpacing(unsigned int spacing);

include/fifechan/widgets/icon.hpp

@@ -41,7 +41,7 @@ namespace fcn
          * Sets the image to display. Existing image is freed automatically
          * if it was loaded internally.
          *
-         * @param image The image to display.
+         * @param filename The image to display.
          */
         void setImage(std::string const & filename);
 

include/fifechan/widgets/iconprogressbar.hpp

@@ -118,7 +118,7 @@ namespace fcn
 
         /**
          * Sets count of icons.
-         * @param counter The count of the active icons.
+         * @param icons The count of the active icons.
          */
         void setIconCount(int icons);
 

include/fifechan/widgets/tabbedarea.hpp

@@ -80,7 +80,7 @@ namespace fcn
         /**
          * Removes a tab from the tabbed area.
          *
-         * @param index The tab to remove.
+         * @param tab The tab to remove.
          * @see addTab
          */
         virtual void removeTab(Tab* tab);
@@ -103,7 +103,7 @@ namespace fcn
         /**
          * Checks if a tab is selected or not.
          *
-         * @param index The tab to check.
+         * @param tab The tab to check.
          * @return True if the tab is selected, false otherwise.
          * @see setSelectedTab
          */
@@ -120,7 +120,7 @@ namespace fcn
         /**
          * Sets a tab to be selected or not.
          *
-         * @param index The tab to be selected.
+         * @param tab The tab to be selected.
          * @see isTabSelected, getSelectedTab
          */
         virtual void setSelectedTab(Tab* tab);
@@ -210,7 +210,7 @@ namespace fcn
         /**
          * Set the vertical spacing between rows.
          *
-         * @param verticalSpacing spacing in pixels.
+         * @param spacing spacing in pixels.
          * @see getVerticalSpacing
          */
         virtual void setVerticalSpacing(unsigned int spacing);
@@ -226,7 +226,7 @@ namespace fcn
         /**
          * Set the horizontal spacing between columns.
          *
-         * @param horizontalSpacing spacing in pixels.
+         * @param spacing spacing in pixels.
          * @see getHorizontalSpacing
          */
         virtual void setHorizontalSpacing(unsigned int spacing);

include/fifechan/widgets/textbox.hpp

@@ -102,7 +102,7 @@ namespace fcn
         /**
          * Sets the row where the caret should be currently located.
          *
-         * @param The row where the caret should be currently located.
+         * @param row The row where the caret should be currently located.
          * @see getCaretRow
          */
         void setCaretRow(int row);
@@ -118,7 +118,7 @@ namespace fcn
         /**
          * Sets the column where the caret should be currently located.
          *
-         * @param The column where the caret should be currently located.
+         * @param column The column where the caret should be currently located.
          * @see getCaretColumn
          */
         void setCaretColumn(int column);