Skip to content

Commit 3d1144e

Browse files
author
timlinux
committed
Updates for doxygen for gui module
git-svn-id: http://svn.osgeo.org/qgis/trunk/qgis@9221 c8812cc2-4d05-0410-92ff-de0c093fc19c
1 parent 630ee1b commit 3d1144e

25 files changed

+87
-17
lines changed

src/gui/qgisgui.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818

1919
#include <Qt>
2020

21-
/*!
21+
/** \ingroup gui
2222
* /namespace QgisGui
23-
* /brief The QgisGui namespace contains constants used throughout the QGIS GUI.
23+
* The QgisGui namespace contains constants used throughout the QGIS GUI.
2424
*/
2525
namespace QgisGui
2626
{

src/gui/qgisinterface.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ class QgsMapCanvas;
3434
class QgsRasterLayer;
3535
class QgsVectorLayer;
3636

37-
/**
38-
* \class QgisInterface
39-
* \brief Abstract base class defining interfaces exposed by QgisApp and
37+
/** \ingroup gui
38+
* QgisInterface
39+
* Abstract base class defining interfaces exposed by QgisApp and
4040
* made available to plugins.
4141
*
4242
* Only functionality exposed by QgisInterface can be used in plugins.

src/gui/qgscolorbutton.h

+3
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@
1818

1919
#include <QToolButton>
2020

21+
/** \ingroup gui
22+
* A cross platform button subclass for selecting colors.
23+
*/
2124
class GUI_EXPORT QgsColorButton: public QToolButton
2225
{
2326
public:

src/gui/qgscomposerview.h

+1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ class QgsComposerPicture;
3131
class QgsComposerScaleBar;
3232

3333
/** \ingroup MapComposer
34+
* \ingroup gui
3435
* Widget to display the composer items. Manages the composer tools and the
3536
* mouse/key events.
3637
* Creates the composer items according to the current map tools and keeps track

src/gui/qgscursors.h

+3
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@
1818
#ifndef QGSCURSORS_H
1919
#define QGSCURSORS_H
2020

21+
/** \ingroup gui
22+
* Bitmap cursors for map operations.
23+
*/
2124
extern GUI_EXPORT const char *zoom_in[];
2225
extern GUI_EXPORT const char *zoom_out[];
2326

src/gui/qgsdetaileditemdata.h

+2-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@
2323
#include <QString>
2424
#include <QPixmap>
2525

26-
/** This class is the data only representation of a
26+
/** \ingroup gui
27+
* This class is the data only representation of a
2728
* QgsDetailedItemWidget, designed to be used in custom views.
2829
*/
2930
class GUI_EXPORT QgsDetailedItemData

src/gui/qgsdetaileditemdelegate.h

+5
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@ class QgsDetailedItemData;
2727
class QFontMetrics;
2828
class QFont;
2929

30+
/** \ingroup gui
31+
* A custom model/view delegate that can display an icon, heading
32+
* and detail sections.
33+
* @see also QgsDetailedItemData
34+
*/
3035
class GUI_EXPORT QgsDetailedItemDelegate :
3136
public QAbstractItemDelegate
3237
{

src/gui/qgsdetaileditemwidget.h

+4
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@
2121
#include <ui_qgsdetaileditemwidgetbase.h>
2222
#include <qgsdetaileditemdata.h>
2323

24+
/** \ingroup gui
25+
* A widget renderer for detailed item views.
26+
* @see also QgsDetailedItem and QgsDetailedItemData.
27+
*/
2428
class QgsDetailedItemWidget :
2529
public QWidget, private Ui::QgsDetailedItemWidgetBase
2630
{

src/gui/qgsencodingfiledialog.h

+3-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@
1919
#include <QFileDialog>
2020
class QComboBox;
2121

22-
/**A file dialog which lets the user select the prefered encoding type for a data provider*/
22+
/** \ingroup gui
23+
* A file dialog which lets the user select the prefered encoding type for a data provider.
24+
**/
2325
class GUI_EXPORT QgsEncodingFileDialog: public QFileDialog
2426
{
2527
Q_OBJECT

src/gui/qgsfiledropedit.h

+4
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@
1818

1919
#include <QLineEdit>
2020

21+
/** \ingroup gui
22+
* A line edit for capturing file names that can have files dropped onto
23+
* it via drag & drop.
24+
*/
2125
class GUI_EXPORT QgsFileDropEdit: public QLineEdit
2226
{
2327
public:

src/gui/qgsgenericprojectionselector.h

+3
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@
3838
* mEpsgId = mySelector.getSelectedEpsg();
3939
* }
4040
* \endcode
41+
*
42+
* If you wish to embed the projection selector into an existing dialog
43+
* the you probably want to look at QgsProjectionSelector rather.
4144
*/
4245

4346
class GUI_EXPORT QgsGenericProjectionSelector : public QDialog, private Ui::QgsGenericProjectionSelectorBase

src/gui/qgsmapcanvas.h

+4-2
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,10 @@ class QgsMapCanvasMap;
5555
class QgsMapOverviewCanvas;
5656
class QgsMapTool;
5757

58-
/** \class QgsMapCanvasLayer
59-
\brief class that stores additional layer's flags together with pointer to the layer
58+
/** \ingroup gui
59+
* A class that stores visibility and presence in overview flags together
60+
* with pointer to the layer.
61+
*
6062
*/
6163
class GUI_EXPORT QgsMapCanvasLayer
6264
{

src/gui/qgsmapcanvasitem.h

+4
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@
2323
class QgsMapCanvas;
2424
class QPainter;
2525

26+
/** \ingroup gui
27+
* An abstract class for items that can be placed on the
28+
* map canvas.
29+
*/
2630
class GUI_EXPORT QgsMapCanvasItem : public QGraphicsItem
2731
{
2832
protected:

src/gui/qgsmapcanvasmap.h

+3
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@
2424
class QgsMapRenderer;
2525
class QgsMapCanvas;
2626

27+
/** \ingroup gui
28+
* A rectangular graphics item representing the map on the canvas.
29+
*/
2730
class GUI_EXPORT QgsMapCanvasMap : public QGraphicsRectItem
2831
{
2932
public:

src/gui/qgsmapcanvassnapper.h

+6-4
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,12 @@ class QgsMapCanvas;
2525
class QPoint;
2626
class QgsSnapper;
2727

28-
/**This class reads the snapping properties from the
29-
current project and configures a QgsSnapper to perform the snapping.
30-
Snapping can be done to the active layer (usefull for selecting a vertex to manipulate)
31-
or to background layers*/
28+
/** \ingroup gui
29+
* This class reads the snapping properties from the current project and
30+
* configures a QgsSnapper to perform the snapping.
31+
* Snapping can be done to the active layer (usefull for selecting a vertex to
32+
* manipulate) or to background layers
33+
*/
3234
class GUI_EXPORT QgsMapCanvasSnapper
3335
{
3436
public:

src/gui/qgsmapoverviewcanvas.h

+3
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ class QgsMapRenderer;
3232
class QgsPanningWidget; // defined in .cpp
3333
class QgsRect;
3434

35+
/** \ingroup gui
36+
* A widget that displays an overview map.
37+
*/
3538
class GUI_EXPORT QgsMapOverviewCanvas : public QWidget
3639
{
3740
Q_OBJECT

src/gui/qgsmaptool.h

+6
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ class QPoint;
3131
class QAction;
3232
class QAbstractButton;
3333

34+
/** \ingroup gui
35+
* Abstract base class for all map tools.
36+
* Map tools are user interactive tools for manipulating the
37+
* map canvas. For example map pan and zoom features are
38+
* implemented as map tools.
39+
*/
3440
class GUI_EXPORT QgsMapTool : public QObject
3541
{
3642
public:

src/gui/qgsmaptoolemitpoint.h

+5
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@
2222
class QgsMapCanvas;
2323

2424

25+
/** \ingroup gui
26+
* A map tool that simple emits a point when clicking on the map.
27+
* Connecting a slot to its gotPoint() signal will
28+
* let you implement custom behaviour for the passed in point.
29+
*/
2530
class GUI_EXPORT QgsMapToolEmitPoint : public QgsMapTool
2631
{
2732
Q_OBJECT

src/gui/qgsmaptoolpan.h

+4
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@
2121
class QgsMapCanvas;
2222

2323

24+
/** \ingroup gui
25+
* A map tool for panning the map.
26+
* @see QgsMapTool
27+
*/
2428
class GUI_EXPORT QgsMapToolPan : public QgsMapTool
2529
{
2630
public:

src/gui/qgsmaptoolzoom.h

+4
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@
2323

2424
class QRubberBand;
2525

26+
/** \ingroup gui
27+
* A map tool for zooming into the map.
28+
* @see QgsMapTool
29+
*/
2630
class GUI_EXPORT QgsMapToolZoom : public QgsMapTool
2731
{
2832
public:

src/gui/qgsmessageviewer.h

+4
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@
2424

2525
#include <QString>
2626

27+
28+
/** \ingroup gui
29+
* A generic message view for displaying QGIS messages.
30+
*/
2731
class GUI_EXPORT QgsMessageViewer: public QDialog, public QgsMessageOutput, private Ui::QgsMessageViewer
2832
{
2933
Q_OBJECT

src/gui/qgsprojectionselector.h

+3-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@
1717

1818
class QResizeEvent;
1919

20-
/**
20+
/** \ingroup gui
21+
* A widget for selecting a Coordinate reference system from a tree.
22+
* @see QgsGenericProjectionSelector.
2123
@author Tim Sutton
2224
*/
2325
class GUI_EXPORT QgsProjectionSelector: public QWidget, private Ui::QgsProjectionSelectorBase

src/gui/qgsquickprint.h

+2-3
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,8 @@
2929
#include <qgsmapcanvas.h>
3030

3131

32-
/**
33-
* \class QgsQgsQuickPrint
34-
* \brief A convenience class for quickly printing a map.
32+
/** \ingroup gui
33+
* A convenience class for quickly printing a map.
3534
* Prints a map with a map title, scale bar, north arrow, legend etc.
3635
*/
3736
class GUI_EXPORT QgsQuickPrint: public QObject

src/gui/qgsrubberband.h

+3
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ class QgsGeometry;
2626
class QgsVectorLayer;
2727
class QPaintEvent;
2828

29+
/** \ingroup gui
30+
* A class for drawing transient features (e.g. digitising lines) on the map.
31+
*/
2932
class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem
3033
{
3134
public:

src/gui/qgsvertexmarker.h

+3
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@
2222

2323
class QPainter;
2424

25+
/** \ingroup gui
26+
* A class for marking vertices of features using e.g. circles or 'x'.
27+
*/
2528
class GUI_EXPORT QgsVertexMarker : public QgsMapCanvasItem
2629
{
2730
public:

0 commit comments

Comments
 (0)