From 9c5791d3e3b413d8b703f1530f67de8936a3434c Mon Sep 17 00:00:00 2001
From: Thorbjørn Lindeijer <thorbjorn@lindeijer.nl>
Date: Fri, 21 Oct 2011 20:54:54 +0200
Subject: Fixed a certain class of Doxygen warnings

All cases of documentation for non-existing parameters are now fixed.

Also marked a few getters as 'const', removed some superfluous 'inline'
keywords and removed the unused 'forceQuantity' option from
ItemContainer.

Reviewed-by: Yohann Ferreira
---
 src/gui/widgets/chattab.h         |  1 -
 src/gui/widgets/dropdown.h        |  4 +---
 src/gui/widgets/itemcontainer.cpp |  5 ++---
 src/gui/widgets/itemcontainer.h   |  8 ++------
 src/gui/widgets/shopitems.h       |  2 +-
 src/gui/widgets/spacer.h          | 12 ++++++------
 6 files changed, 12 insertions(+), 20 deletions(-)

(limited to 'src/gui/widgets')

diff --git a/src/gui/widgets/chattab.h b/src/gui/widgets/chattab.h
index 6d262e11..bc139079 100644
--- a/src/gui/widgets/chattab.h
+++ b/src/gui/widgets/chattab.h
@@ -45,7 +45,6 @@ class ChatTab : public Tab, public AutoCompleteLister
          *
          * @param line Text message.
          * @param own  Type of message (usually the owner-type).
-         * @param channelName which channel to send the message to.
          * @param ignoreRecord should this not be recorded?
          */
         void chatLog(std::string line, Own own = BY_SERVER,
diff --git a/src/gui/widgets/dropdown.h b/src/gui/widgets/dropdown.h
index e0cfd0d7..c7b3cdb1 100644
--- a/src/gui/widgets/dropdown.h
+++ b/src/gui/widgets/dropdown.h
@@ -41,9 +41,7 @@ class DropDown : public gcn::DropDown
          * Contructor.
          *
          * @param listModel the ListModel to use.
-         * @param scrollArea the ScrollArea to use.
-         * @param listBox the listBox to use.
-         * @see ListModel, ScrollArea, ListBox.
+         * @see ListModel
          */
         DropDown(gcn::ListModel *listModel = 0);
 
diff --git a/src/gui/widgets/itemcontainer.cpp b/src/gui/widgets/itemcontainer.cpp
index 546a16d2..d88a5747 100644
--- a/src/gui/widgets/itemcontainer.cpp
+++ b/src/gui/widgets/itemcontainer.cpp
@@ -52,7 +52,7 @@
 static const int BOX_WIDTH = 35;
 static const int BOX_HEIGHT = 43;
 
-ItemContainer::ItemContainer(Inventory *inventory, bool forceQuantity):
+ItemContainer::ItemContainer(Inventory *inventory):
     mInventory(inventory),
     mGridColumns(1),
     mGridRows(1),
@@ -60,7 +60,6 @@ ItemContainer::ItemContainer(Inventory *inventory, bool forceQuantity):
     mHighlightedIndex(-1),
     mLastUsedSlot(-1),
     mSelectionStatus(SEL_NONE),
-    mForceQuantity(forceQuantity),
     mSwapItems(false),
     mDescItems(false)
 {
@@ -159,7 +158,7 @@ void ItemContainer::draw(gcn::Graphics *graphics)
             }
             // Draw item caption
             std::string caption;
-            if (item->getQuantity() > 1 || mForceQuantity)
+            if (item->getQuantity() > 1)
                 caption = toString(item->getQuantity());
             else if (item->isEquipped())
                 caption = "Eq.";
diff --git a/src/gui/widgets/itemcontainer.h b/src/gui/widgets/itemcontainer.h
index 4d5afde2..0da894ea 100644
--- a/src/gui/widgets/itemcontainer.h
+++ b/src/gui/widgets/itemcontainer.h
@@ -54,11 +54,8 @@ class ItemContainer : public gcn::Widget,
          * Constructor. Initializes the graphic.
          *
          * @param inventory
-         * @param gridColumns Amount of columns in grid.
-         * @param gridRows    Amount of rows in grid.
-         * @param offset      Index offset
          */
-        ItemContainer(Inventory *inventory, bool forceQuantity = false);
+        ItemContainer(Inventory *inventory);
 
         virtual ~ItemContainer();
 
@@ -184,7 +181,6 @@ class ItemContainer : public gcn::Widget,
         int mSelectedIndex, mHighlightedIndex;
         int mLastUsedSlot;
         SelectionState mSelectionStatus;
-        bool mForceQuantity;
         bool mSwapItems;
         bool mDescItems;
         int mDragPosX, mDragPosY;
@@ -201,4 +197,4 @@ class ItemContainer : public gcn::Widget,
         SelectionListenerList mSelectionListeners;
 };
 
-#endif
+#endif // ITEMCONTAINER_H
diff --git a/src/gui/widgets/shopitems.h b/src/gui/widgets/shopitems.h
index 0e95d9a0..f3e774aa 100644
--- a/src/gui/widgets/shopitems.h
+++ b/src/gui/widgets/shopitems.h
@@ -62,7 +62,7 @@ class ShopItems : public gcn::ListModel
          *
          * @param inventoryIndex the inventory index of the item
          * @param id the id of the item
-         * @param quantity number of available copies of the item
+         * @param amount number of available copies of the item
          * @param price price of the item
          */
         void addItem(int inventoryIndex, int id, int amount, int price);
diff --git a/src/gui/widgets/spacer.h b/src/gui/widgets/spacer.h
index cc171890..4756b452 100644
--- a/src/gui/widgets/spacer.h
+++ b/src/gui/widgets/spacer.h
@@ -37,17 +37,17 @@ class Spacer : public gcn::Widget
         /**
          * Constructor.
          *
-         * @note Can be called empty, will default to a 5x5 px space
+         * @note Can be called empty, will default to a space of 5x5 pixels.
          *
-         * @param w - width in px.
-         * @param h - height in px.
+         * @param w width in pixels.
+         * @param h height in pixels.
          */
-        Spacer(int x = 5, int y = 5);
+        Spacer(int w = 5, int h = 5);
 
         /**
-         * Draws the Space.
+         * Draws nothing.
          */
-        void draw(gcn::Graphics *g){}
+        void draw(gcn::Graphics *g) {}
 };
 
 #endif // SPACER_H
-- 
cgit v1.2.3-70-g09d2