Commit 47f9388d authored by Jan Möbius's avatar Jan Möbius

Fixed documentations

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@14194 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 80f85132
...@@ -512,13 +512,13 @@ void CoreWidget::updatePopupMenuBackground(QMenu* _menu , const QPoint& /*_point ...@@ -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 function is called when an object has been clicked on.
* This context menu will show all properties for the given object. * This context menu will show all properties for the given object.
* *
* @param _menu Pointer to the context Menu * @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 ) { void CoreWidget::updatePopupMenuObject(QMenu* _menu , BaseObjectData* _object ) {
......
...@@ -1353,9 +1353,11 @@ public: ...@@ -1353,9 +1353,11 @@ public:
/** \brief add pick mode /** \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 _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, void addPickMode(const std::string& _name,
bool _mouse_tracking = false, bool _mouse_tracking = false,
......
...@@ -81,9 +81,11 @@ class SideElement : public QWidget ...@@ -81,9 +81,11 @@ class SideElement : public QWidget
public: public:
/** Create a SideElement /** Create a SideElement
\param _parent SideArea widget that holds this widget @param _parent SideArea widget that holds this widget
\param _w Plugin tool widget @param _w Plugin tool widget
\param _name Plugin name @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); SideElement (SideArea *_parent, QWidget *_w, QString _name, QIcon* _icon = 0);
...@@ -161,4 +163,4 @@ class SideElement : public QWidget ...@@ -161,4 +163,4 @@ class SideElement : public QWidget
//============================================================================= //=============================================================================
//============================================================================= //=============================================================================
#endif // SIDE_ELEMENT_ defined #endif // SIDE_ELEMENT_ defined
//============================================================================= //=============================================================================
\ No newline at end of file
...@@ -136,16 +136,16 @@ public: ...@@ -136,16 +136,16 @@ public:
/** Create a glViewer. /** 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 _glWidget A pointer to the underlying gl widget
* @param _properties viewerOptions controlled by PluginFunctions * @param _properties viewerOptions controlled by PluginFunctions
* @param _parent The parent graphicswidget * @param _parent The parent graphicswidget
* *
*/ */
glViewer( QGraphicsScene* _scene, glViewer( QGraphicsScene* _scene,
QGLWidget* _glWidget, QGLWidget* _glWidget,
Viewer::ViewerProperties& _properties, Viewer::ViewerProperties& _properties,
QGraphicsWidget* _parent=0); QGraphicsWidget* _parent = 0 );
/// Destructor. /// Destructor.
virtual ~glViewer(); virtual ~glViewer();
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment