[QGIS Commit] r9194 - trunk/qgis/src/gui

[svn_qgis at osgeo.org]

Author: timlinux
Date: 2008-08-27 17:31:59 -0400 (Wed, 27 Aug 2008)
New Revision: 9194

Modified:
   trunk/qgis/src/gui/qgsgenericprojectionselector.h
Log:
Added a small useage example to generic projection selector dialog docs

Modified: trunk/qgis/src/gui/qgsgenericprojectionselector.h
===================================================================
--- trunk/qgis/src/gui/qgsgenericprojectionselector.h	2008-08-27 20:45:53 UTC (rev 9193)
+++ trunk/qgis/src/gui/qgsgenericprojectionselector.h	2008-08-27 21:31:59 UTC (rev 9194)
@@ -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