Doxygen fixes

qgis · May 2, 2016 · 3a543e4 · 3a543e4
1 parent e53cb6e
commit 3a543e4
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/python/gui/qgsadvanceddigitizingdockwidget.sip b/python/gui/qgsadvanceddigitizingdockwidget.sip
@@ -67,6 +67,12 @@ class QgsAdvancedDigitizingDockWidget : QDockWidget
           HardLock
         };
 
+        /** Constructor for CadConstraint.
+         * @param lineEdit associated line edit for constraint value
+         * @param lockerButton associated button for locking constraint
+         * @param relativeButton optional button for toggling relative constraint mode
+         * @param repeatingLockButton optional button for toggling repeating lock mode
+         */
         CadConstraint( QLineEdit* lineEdit, QToolButton* lockerButton, QToolButton* relativeButton = nullptr, QToolButton* repeatingLockButton = nullptr );
 
         /**

diff --git a/src/gui/qgsadvanceddigitizingdockwidget.h b/src/gui/qgsadvanceddigitizingdockwidget.h
@@ -89,6 +89,12 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QDockWidget, private U
           HardLock
         };
 
+        /** Constructor for CadConstraint.
+         * @param lineEdit associated line edit for constraint value
+         * @param lockerButton associated button for locking constraint
+         * @param relativeButton optional button for toggling relative constraint mode
+         * @param repeatingLockButton optional button for toggling repeating lock mode
+         */
         CadConstraint( QLineEdit* lineEdit, QToolButton* lockerButton, QToolButton* relativeButton = nullptr, QToolButton* repeatingLockButton = nullptr )
             : mLineEdit( lineEdit )
             , mLockerButton( lockerButton )
@@ -413,6 +419,7 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QDockWidget, private U
     double parseUserInput( const QString& inputValue, bool& ok ) const;
 
     /** Updates a constraint value based on a text input.
+     * @param constraint constraint to update
      * @param textValue user entered text value, may be an expression
      * @param convertExpression set to true to update widget contents to calculated expression value
      */