Added a small useage example to generic projection selector dialog docs

git-svn-id: http://svn.osgeo.org/qgis/trunk@9194 c8812cc2-4d05-0410-92ff-de0c093fc19c
qgis · Aug 27, 2008 · 4ea563b · 4ea563b
1 parent 94ac3a8
commit 4ea563b
Showing 1 changed file with 15 additions and 3 deletions.
diff --git a/src/gui/qgsgenericprojectionselector.h b/src/gui/qgsgenericprojectionselector.h
@@ -23,9 +23,21 @@
 
 #include <QSet>
 
-/**
- * \class QgsGenericProjectionSelector
- * \brief A generic dialog to prompt the user for a Coordinate Reference System
+/** 
+ * \ingroup gui
+ * A generic dialog to prompt the user for a Coordinate Reference System.
+ *
+ * Typically you will use this when you want to prompt the user for 
+ * a coordinate system identifier e.g. from a plugin you might do this 
+ * to get an epsg code:
+ * \code
+ * QgsGenericProjectionSelector mySelector( mQGisIface->getMainWindow() );
+ * mySelector.setSelectedEpsg( mEpsgId );
+ * if ( mySelector.exec() )
+ * {
+ *   mEpsgId = mySelector.getSelectedEpsg();
+ * }
+ * \endcode
  */
 
 class GUI_EXPORT QgsGenericProjectionSelector : public QDialog, private Ui::QgsGenericProjectionSelectorBase