Updates for doxygen for gui module

git-svn-id: http://svn.osgeo.org/qgis/trunk@9221 c8812cc2-4d05-0410-92ff-de0c093fc19c
qgis · Aug 30, 2008 · e8b9f2d · e8b9f2d
1 parent f882e96
commit e8b9f2d
Show file tree

Hide file tree

Showing 25 changed files with 87 additions and 17 deletions.
diff --git a/src/gui/qgisgui.h b/src/gui/qgisgui.h
@@ -18,9 +18,9 @@
 
 #include <Qt>
 
-/*!
+/** \ingroup gui
  * /namespace QgisGui
- * /brief The QgisGui namespace contains constants used throughout the QGIS GUI.
+ * The QgisGui namespace contains constants used throughout the QGIS GUI.
  */
 namespace QgisGui
 {

diff --git a/src/gui/qgisinterface.h b/src/gui/qgisinterface.h
@@ -34,9 +34,9 @@ class QgsMapCanvas;
 class QgsRasterLayer;
 class QgsVectorLayer;
 
-/**
- * \class QgisInterface
- * \brief Abstract base class defining interfaces exposed by QgisApp and
+/** \ingroup gui
+ * QgisInterface
+ * Abstract base class defining interfaces exposed by QgisApp and
  * made available to plugins.
  *
  * Only functionality exposed by QgisInterface can be used in plugins.

diff --git a/src/gui/qgscolorbutton.h b/src/gui/qgscolorbutton.h
@@ -18,6 +18,9 @@
 
 #include <QToolButton>
 
+/** \ingroup gui
+ * A cross platform button subclass for selecting colors.
+ */
 class GUI_EXPORT QgsColorButton: public QToolButton
 {
   public:

diff --git a/src/gui/qgscomposerview.h b/src/gui/qgscomposerview.h
@@ -31,6 +31,7 @@ class QgsComposerPicture;
 class QgsComposerScaleBar;
 
 /** \ingroup MapComposer
+ * \ingroup gui
  * Widget to display the composer items. Manages the composer tools and the
  * mouse/key events.
  * Creates the composer items according to the current map tools and keeps track

diff --git a/src/gui/qgscursors.h b/src/gui/qgscursors.h
@@ -18,6 +18,9 @@
 #ifndef QGSCURSORS_H
 #define QGSCURSORS_H
 
+/** \ingroup gui
+ * Bitmap cursors for map operations.
+ */
 extern GUI_EXPORT const char *zoom_in[];
 extern GUI_EXPORT const char *zoom_out[];
 

diff --git a/src/gui/qgsdetaileditemdata.h b/src/gui/qgsdetaileditemdata.h
@@ -23,7 +23,8 @@
 #include <QString>
 #include <QPixmap>
 
-/** This class is the data only representation of a
+/** \ingroup gui
+ * This class is the data only representation of a
  * QgsDetailedItemWidget, designed to be used in custom views.
  */
 class GUI_EXPORT QgsDetailedItemData

diff --git a/src/gui/qgsdetaileditemdelegate.h b/src/gui/qgsdetaileditemdelegate.h
@@ -27,6 +27,11 @@ class QgsDetailedItemData;
 class QFontMetrics;
 class QFont;
 
+/** \ingroup gui
+ * A custom model/view delegate that can display an icon, heading 
+ * and detail sections.
+ * @see also QgsDetailedItemData
+ */
 class GUI_EXPORT QgsDetailedItemDelegate :
       public QAbstractItemDelegate
 {

diff --git a/src/gui/qgsdetaileditemwidget.h b/src/gui/qgsdetaileditemwidget.h
@@ -21,6 +21,10 @@
 #include <ui_qgsdetaileditemwidgetbase.h>
 #include <qgsdetaileditemdata.h>
 
+/** \ingroup gui
+ * A widget renderer for detailed item views.
+ * @see also QgsDetailedItem and QgsDetailedItemData.
+ */
 class QgsDetailedItemWidget :
       public QWidget, private Ui::QgsDetailedItemWidgetBase
 {

diff --git a/src/gui/qgsencodingfiledialog.h b/src/gui/qgsencodingfiledialog.h
@@ -19,7 +19,9 @@
 #include <QFileDialog>
 class QComboBox;
 
-/**A file dialog which lets the user select the prefered encoding type for a data provider*/
+/** \ingroup gui
+ * A file dialog which lets the user select the prefered encoding type for a data provider.
+ **/
 class GUI_EXPORT QgsEncodingFileDialog: public QFileDialog
 {
     Q_OBJECT

diff --git a/src/gui/qgsfiledropedit.h b/src/gui/qgsfiledropedit.h
@@ -18,6 +18,10 @@
 
 #include <QLineEdit>
 
+/** \ingroup gui
+ * A line edit for capturing file names that can have files dropped onto 
+ * it via drag & drop.
+ */
 class GUI_EXPORT QgsFileDropEdit: public QLineEdit
 {
   public:

diff --git a/src/gui/qgsgenericprojectionselector.h b/src/gui/qgsgenericprojectionselector.h
@@ -38,6 +38,9 @@
  *   mEpsgId = mySelector.getSelectedEpsg();
  * }
  * \endcode
+ *
+ * If you wish to embed the projection selector into an existing dialog 
+ * the you probably want to look at QgsProjectionSelector rather.
  */
 
 class GUI_EXPORT QgsGenericProjectionSelector : public QDialog, private Ui::QgsGenericProjectionSelectorBase

diff --git a/src/gui/qgsmapcanvas.h b/src/gui/qgsmapcanvas.h
@@ -55,8 +55,10 @@ class QgsMapCanvasMap;
 class QgsMapOverviewCanvas;
 class QgsMapTool;
 
-/** \class QgsMapCanvasLayer
-  \brief class that stores additional layer's flags together with pointer to the layer
+/** \ingroup gui
+  * A class that stores visibility and presence in overview flags together 
+  * with pointer to the layer.
+  *
 */
 class GUI_EXPORT QgsMapCanvasLayer
 {

diff --git a/src/gui/qgsmapcanvasitem.h b/src/gui/qgsmapcanvasitem.h
@@ -23,6 +23,10 @@
 class QgsMapCanvas;
 class QPainter;
 
+/** \ingroup gui
+ * An abstract class for items that can be placed on the 
+ * map canvas.
+ */
 class GUI_EXPORT QgsMapCanvasItem : public QGraphicsItem
 {
   protected:

diff --git a/src/gui/qgsmapcanvasmap.h b/src/gui/qgsmapcanvasmap.h
@@ -24,6 +24,9 @@
 class QgsMapRenderer;
 class QgsMapCanvas;
 
+/** \ingroup gui
+ * A rectangular graphics item representing the map on the canvas.
+ */
 class GUI_EXPORT QgsMapCanvasMap : public QGraphicsRectItem
 {
   public:

diff --git a/src/gui/qgsmapcanvassnapper.h b/src/gui/qgsmapcanvassnapper.h
@@ -25,10 +25,12 @@ class QgsMapCanvas;
 class QPoint;
 class QgsSnapper;
 
-/**This class reads the snapping properties from the
- current project and configures a QgsSnapper to perform the snapping.
- Snapping can be done to the active layer  (usefull for selecting a vertex to manipulate)
- or to background layers*/
+/** \ingroup gui
+ * This class reads the snapping properties from the current project and
+ * configures a QgsSnapper to perform the snapping.
+ * Snapping can be done to the active layer  (usefull for selecting a vertex to
+ * manipulate) or to background layers
+ */
 class GUI_EXPORT QgsMapCanvasSnapper
 {
   public:

diff --git a/src/gui/qgsmapoverviewcanvas.h b/src/gui/qgsmapoverviewcanvas.h
@@ -32,6 +32,9 @@ class QgsMapRenderer;
 class QgsPanningWidget; // defined in .cpp
 class QgsRect;
 
+/** \ingroup gui
+ * A widget that displays an overview map.
+ */
 class GUI_EXPORT QgsMapOverviewCanvas : public QWidget
 {
     Q_OBJECT

diff --git a/src/gui/qgsmaptool.h b/src/gui/qgsmaptool.h
@@ -31,6 +31,12 @@ class QPoint;
 class QAction;
 class QAbstractButton;
 
+/** \ingroup gui
+ * Abstract base class for all map tools.
+ * Map tools are user interactive tools for manipulating the 
+ * map canvas. For example map pan and zoom features are 
+ * implemented as map tools.
+ */
 class GUI_EXPORT QgsMapTool : public QObject
 {
   public:

diff --git a/src/gui/qgsmaptoolemitpoint.h b/src/gui/qgsmaptoolemitpoint.h
@@ -22,6 +22,11 @@
 class QgsMapCanvas;
 
 
+/** \ingroup gui
+ * A map tool that simple emits a point when clicking on the map.
+ * Connecting a slot to its gotPoint() signal will 
+ * let you implement custom behaviour for the passed in point.
+ */
 class GUI_EXPORT QgsMapToolEmitPoint : public QgsMapTool
 {
     Q_OBJECT

diff --git a/src/gui/qgsmaptoolpan.h b/src/gui/qgsmaptoolpan.h
@@ -21,6 +21,10 @@
 class QgsMapCanvas;
 
 
+/** \ingroup gui
+ * A map tool for panning the map.
+ * @see QgsMapTool
+ */
 class GUI_EXPORT QgsMapToolPan : public QgsMapTool
 {
   public:

diff --git a/src/gui/qgsmaptoolzoom.h b/src/gui/qgsmaptoolzoom.h
@@ -23,6 +23,10 @@
 
 class QRubberBand;
 
+/** \ingroup gui
+ * A map tool for zooming into the map.
+ * @see QgsMapTool
+ */
 class GUI_EXPORT QgsMapToolZoom : public QgsMapTool
 {
   public:

diff --git a/src/gui/qgsmessageviewer.h b/src/gui/qgsmessageviewer.h
@@ -24,6 +24,10 @@
 
 #include <QString>
 
+
+/** \ingroup gui
+ * A generic message view for displaying QGIS messages.
+ */
 class GUI_EXPORT QgsMessageViewer: public QDialog, public QgsMessageOutput, private Ui::QgsMessageViewer
 {
     Q_OBJECT

diff --git a/src/gui/qgsprojectionselector.h b/src/gui/qgsprojectionselector.h
@@ -17,7 +17,9 @@
 
 class QResizeEvent;
 
-/**
+/** \ingroup gui
+ * A widget for selecting a Coordinate reference system from a tree.
+ * @see QgsGenericProjectionSelector.
   @author Tim Sutton
   */
 class GUI_EXPORT QgsProjectionSelector: public QWidget, private Ui::QgsProjectionSelectorBase

diff --git a/src/gui/qgsquickprint.h b/src/gui/qgsquickprint.h
@@ -29,9 +29,8 @@
 #include <qgsmapcanvas.h>
 
 
-/**
-* \class QgsQgsQuickPrint
-* \brief A convenience class for quickly printing a map.
+/** \ingroup gui
+* A convenience class for quickly printing a map.
 * Prints a map with a map title, scale bar, north arrow, legend etc.
 */
 class GUI_EXPORT QgsQuickPrint: public QObject

diff --git a/src/gui/qgsrubberband.h b/src/gui/qgsrubberband.h
@@ -26,6 +26,9 @@ class QgsGeometry;
 class QgsVectorLayer;
 class QPaintEvent;
 
+/** \ingroup gui
+ * A class for drawing transient features (e.g. digitising lines) on the map.
+ */
 class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem
 {
   public:

diff --git a/src/gui/qgsvertexmarker.h b/src/gui/qgsvertexmarker.h
@@ -22,6 +22,9 @@
 
 class QPainter;
 
+/** \ingroup gui
+ * A class for marking vertices of features using e.g. circles or 'x'.
+ */
 class GUI_EXPORT QgsVertexMarker : public QgsMapCanvasItem
 {
   public: