From 47f9388dae7028ef1ce3109e975e2fc7699f68bf Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jan=20M=C3=B6bius?= <moebius@cs.rwth-aachen.de>
Date: Wed, 21 Mar 2012 10:10:49 +0000
Subject: [PATCH] Fixed documentations

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@14194 383ad7c9-94d9-4d36-a494-682f7c89f535
---
 widgets/coreWidget/ContextMenu.cc |  4 ++--
 widgets/coreWidget/CoreWidget.hh  |  6 ++++--
 widgets/coreWidget/SideElement.hh | 10 ++++++----
 widgets/glWidget/QtBaseViewer.hh  |  8 ++++----
 4 files changed, 16 insertions(+), 12 deletions(-)

diff --git a/widgets/coreWidget/ContextMenu.cc b/widgets/coreWidget/ContextMenu.cc
index cd9f32da..674ead5e 100644
--- a/widgets/coreWidget/ContextMenu.cc
+++ b/widgets/coreWidget/ContextMenu.cc
@@ -512,13 +512,13 @@ void CoreWidget::updatePopupMenuBackground(QMenu* _menu , const QPoint& /*_point
 
 }
 
-/** \brief Update context Menu an object has been clicked on.
+/** \brief Update popup Menu when an object has been clicked on.
  *
  * This function is called when an object has been clicked on.
  * This context menu will show all properties for the given object.
  *
  * @param _menu Pointer to the context Menu
- * @param _objectId Id of the object that has been clicked on.
+ * @param _object Object that has been clicked on.
  */
 void CoreWidget::updatePopupMenuObject(QMenu* _menu , BaseObjectData* _object ) {
 
diff --git a/widgets/coreWidget/CoreWidget.hh b/widgets/coreWidget/CoreWidget.hh
index f97517c0..fe5a7fd6 100644
--- a/widgets/coreWidget/CoreWidget.hh
+++ b/widgets/coreWidget/CoreWidget.hh
@@ -1353,9 +1353,11 @@ public:
 
     /** \brief  add pick mode
      *
-     *  @param _name Name of the Pick Mode or "Separator" to insert a separator
+     *  @param _name           Name of the Pick Mode or "Separator" to insert a separator
      *  @param _mouse_tracking true: every mouse movement will emit mouse events not only when mousebutton is pressed
-     *  @param _pos position to insert the mode in the popup menu.
+     *  @param _pos            position to insert the mode in the popup menu.
+     *  @param _visible        If true, the ode will be visible in the ui, otherwise it is a hidden pick mode
+     *  @param _cursor         The cursor that should be used when the given pickmode is active
      */
     void addPickMode(const std::string& _name,
                      bool               _mouse_tracking = false,
diff --git a/widgets/coreWidget/SideElement.hh b/widgets/coreWidget/SideElement.hh
index 99a35c79..d5a7f6d7 100644
--- a/widgets/coreWidget/SideElement.hh
+++ b/widgets/coreWidget/SideElement.hh
@@ -81,9 +81,11 @@ class SideElement : public QWidget
 
   public:
     /** Create a SideElement
-      \param _parent SideArea widget that holds this widget
-      \param _w Plugin tool widget
-      \param _name Plugin name
+      @param _parent   SideArea widget that holds this widget
+      @param _w        Plugin tool widget
+      @param _name     Plugin name
+      @param _icon     An icon that should be shown in the title bar of the side element
+
     */
     SideElement (SideArea *_parent, QWidget *_w, QString _name, QIcon* _icon = 0);
 
@@ -161,4 +163,4 @@ class SideElement : public QWidget
 //=============================================================================
 //=============================================================================
 #endif // SIDE_ELEMENT_ defined
-//=============================================================================
\ No newline at end of file
+//=============================================================================
diff --git a/widgets/glWidget/QtBaseViewer.hh b/widgets/glWidget/QtBaseViewer.hh
index eefcc55c..55030189 100644
--- a/widgets/glWidget/QtBaseViewer.hh
+++ b/widgets/glWidget/QtBaseViewer.hh
@@ -136,16 +136,16 @@ public:
 
   /** Create a glViewer.
    *
-   * @param scene       The graphics scene that will be the parent of this widget
+   * @param _scene      The graphics scene that will be the parent of this widget
    * @param _glWidget   A pointer to the underlying gl widget
    * @param _properties viewerOptions controlled by PluginFunctions
    * @param _parent     The parent graphicswidget
    *
   */
-  glViewer( QGraphicsScene* _scene,
-            QGLWidget* _glWidget,
+  glViewer( QGraphicsScene*           _scene,
+            QGLWidget*                _glWidget,
             Viewer::ViewerProperties& _properties,
-            QGraphicsWidget* _parent=0);
+            QGraphicsWidget*          _parent = 0 );
 
   /// Destructor.
   virtual ~glViewer();
-- 
GitLab