Fix docs for QgsProjectionSelectionWidget

Author: nyalldawson

python/gui/qgsprojectionselectionwidget.sip

@@ -25,43 +25,43 @@ class QgsProjectionSelectionWidget : QWidget
 
     explicit QgsProjectionSelectionWidget( QWidget *parent /TransferThis/ = 0 );
 
-    /* Returns a pointer to the projection selector dialog used by the widget.
+    /** Returns a pointer to the projection selector dialog used by the widget.
      * Can be used to modify how the projection selector dialog behaves.
      * @returns projection selector dialog
      */
     QgsGenericProjectionSelector* dialog();
 
-    /* Returns the currently selected CRS for the widget
+    /** Returns the currently selected CRS for the widget
      * @returns current CRS
      */
     QgsCoordinateReferenceSystem crs() const;
 
-    /* Sets whether a predefined CRS option should be shown in the widget.
+    /** Sets whether a predefined CRS option should be shown in the widget.
      * @param option CRS option to show/hide
      * @param visible whether the option should be shown
      */
     void setOptionVisible( const CrsOption option, const bool visible );
 
   signals:
 
-    /* Emitted when the selected CRS is changed
+    /** Emitted when the selected CRS is changed
      */
     void crsChanged( QgsCoordinateReferenceSystem );
 
   public slots:
 
-    /* Sets the current CRS for the widget
+    /** Sets the current CRS for the widget
      * @param crs new CRS
      */
     void setCrs( const QgsCoordinateReferenceSystem& crs );
 
-    /* Sets the layer CRS for the widget. If set, this will be added as an option
+    /** Sets the layer CRS for the widget. If set, this will be added as an option
      * to the preset CRSes shown in the widget.
      * @param crs layer CRS
      */
     void setLayerCrs( const QgsCoordinateReferenceSystem& crs );
 
-    /* Opens the dialog for selecting a new CRS
+    /** Opens the dialog for selecting a new CRS
      */
     void selectCrs();
 

src/gui/qgsprojectionselectionwidget.h

@@ -50,43 +50,43 @@ class GUI_EXPORT QgsProjectionSelectionWidget : public QWidget
 
     explicit QgsProjectionSelectionWidget( QWidget *parent = 0 );
 
-    /* Returns a pointer to the projection selector dialog used by the widget.
+    /** Returns a pointer to the projection selector dialog used by the widget.
      * Can be used to modify how the projection selector dialog behaves.
      * @returns projection selector dialog
      */
     QgsGenericProjectionSelector* dialog() { return mDialog; }
 
-    /* Returns the currently selected CRS for the widget
+    /** Returns the currently selected CRS for the widget
      * @returns current CRS
      */
     QgsCoordinateReferenceSystem crs() const;
 
-    /* Sets whether a predefined CRS option should be shown in the widget.
+    /** Sets whether a predefined CRS option should be shown in the widget.
      * @param option CRS option to show/hide
      * @param visible whether the option should be shown
      */
     void setOptionVisible( const CrsOption option, const bool visible );
 
   signals:
 
-    /* Emitted when the selected CRS is changed
+    /** Emitted when the selected CRS is changed
      */
     void crsChanged( QgsCoordinateReferenceSystem );
 
   public slots:
 
-    /* Sets the current CRS for the widget
+    /** Sets the current CRS for the widget
      * @param crs new CRS
      */
     void setCrs( const QgsCoordinateReferenceSystem& crs );
 
-    /* Sets the layer CRS for the widget. If set, this will be added as an option
+    /** Sets the layer CRS for the widget. If set, this will be added as an option
      * to the preset CRSes shown in the widget.
      * @param crs layer CRS
      */
     void setLayerCrs( const QgsCoordinateReferenceSystem& crs );
 
-    /* Opens the dialog for selecting a new CRS
+    /** Opens the dialog for selecting a new CRS
      */
     void selectCrs();