doxymentattion

qgis · Jan 5, 2018 · 2528639 · 2528639
1 parent d8cc285
commit 2528639
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/python/gui/editorwidgets/qgsdatetimeedit.sip b/python/gui/editorwidgets/qgsdatetimeedit.sip
@@ -12,6 +12,13 @@ class QgsDateTimeEdit : QDateTimeEdit
 {
 %Docstring
  The QgsDateTimeEdit class is a QDateTimeEdit with the capability of setting/reading null date/times.
+
+.. warning::
+
+   You should use the signal dateTimeChanged of this subclass QgsDateTimeEdit
+rather than parent's one (QDateTimeEdit). If you consequently connect parent's
+dateTimeChanged signal and call dateTime() afterwards there is no warranty to
+have a proper NULL value handling.
 %End
 
 %TypeHeaderCode
@@ -66,7 +73,13 @@ Resets the widget to show no value (ie, an "unknown" state).
 %End
 
   signals:
+
     void dateTimeChanged( const QDateTime &date );
+%Docstring
+reimplements QDateTimeEdit.dateTimeChanged signal
+to properly handles NULL values.
+@param date the new date/time value.
+%End
 
   protected:
     virtual void mousePressEvent( QMouseEvent *event );

diff --git a/src/gui/editorwidgets/qgsdatetimeedit.h b/src/gui/editorwidgets/qgsdatetimeedit.h
@@ -23,6 +23,11 @@
 /**
  * \ingroup gui
  * \brief The QgsDateTimeEdit class is a QDateTimeEdit with the capability of setting/reading null date/times.
+ *
+ * \warning You should use the signal dateTimeChanged of this subclass QgsDateTimeEdit
+ * rather than parent's one (QDateTimeEdit). If you consequently connect parent's
+ * dateTimeChanged signal and call dateTime() afterwards there is no warranty to
+ * have a proper NULL value handling.
  */
 class GUI_EXPORT QgsDateTimeEdit : public QDateTimeEdit
 {
@@ -63,6 +68,12 @@ class GUI_EXPORT QgsDateTimeEdit : public QDateTimeEdit
     void setEmpty();
 
   signals:
+
+    /**
+     * reimplements QDateTimeEdit::dateTimeChanged signal
+     * to properly handles NULL values.
+     * @param date the new date/time value.
+     */
     void dateTimeChanged( const QDateTime &date );
 
   protected: