Replace doxygen MapComposer group with core/gui

Since the MapComposer group doesn't actually exist
qgis · Jul 4, 2016 · a240cd8 · a240cd8
1 parent 9f299a6
commit a240cd8
Show file tree

Hide file tree

Showing 55 changed files with 66 additions and 66 deletions.
diff --git a/python/core/composer/qgsatlascomposition.sip b/python/core/composer/qgsatlascomposition.sip
@@ -1,4 +1,4 @@
-/** \ingroup MapComposer
+/** \ingroup core
  * Class used to render an Atlas, iterating over geometry features.
  * prepareForFeature() modifies the atlas map's extent to zoom on the given feature.
  * This class is used for printing, exporting to PDF and images.

diff --git a/python/core/composer/qgscomposerattributetable.sip b/python/core/composer/qgscomposerattributetable.sip
@@ -1,4 +1,4 @@
-/** \ingroup MapComposer
+/** \ingroup core
  * Attribute table item for map composer.
  */
 

diff --git a/python/core/composer/qgscomposeritem.sip b/python/core/composer/qgscomposeritem.sip
@@ -1,4 +1,4 @@
-/** \ingroup MapComposer
+/** \ingroup core
  * A item that forms part of a map composition.
  */
 class QgsComposerItem : QgsComposerObject, QGraphicsRectItem

diff --git a/python/core/composer/qgscomposeritemcommand.sip b/python/core/composer/qgscomposeritemcommand.sip
@@ -1,4 +1,4 @@
-/** \ingroup MapComposer
+/** \ingroup core
 Undo command to undo/redo all composer item related changes*/
 class QgsComposerItemCommand: QUndoCommand
 {

diff --git a/python/core/composer/qgscomposerlabel.sip b/python/core/composer/qgscomposerlabel.sip
@@ -1,4 +1,4 @@
-/** \ingroup MapComposer
+/** \ingroup core
  * A label that can be placed onto a map composition.
  */
 class QgsComposerLabel : QgsComposerItem

diff --git a/python/core/composer/qgscomposerlegend.sip b/python/core/composer/qgscomposerlegend.sip
@@ -1,5 +1,5 @@
 
-/** \ingroup MapComposer
+/** \ingroup core
  * Item model implementation based on layer tree model for composer legend.
  * Overrides some functionality of QgsLayerTreeModel to better fit the needs of composer legend.
  *
@@ -20,7 +20,7 @@ class QgsLegendModelV2 : QgsLayerTreeModel
 };
 
 
-/** \ingroup MapComposer
+/** \ingroup core
  * A legend that can be placed onto a map composition
  */
 class QgsComposerLegend : QgsComposerItem

diff --git a/python/core/composer/qgscomposermap.sip b/python/core/composer/qgscomposermap.sip
@@ -1,4 +1,4 @@
-/** \ingroup MapComposer
+/** \ingroup core
  *  \class QgsComposerMap
  *  \brief Object representing map window.
  */

diff --git a/python/core/composer/qgscomposermapgrid.sip b/python/core/composer/qgscomposermapgrid.sip
@@ -1,4 +1,4 @@
-/** \ingroup MapComposer
+/** \ingroup core
  * \class QgsComposerMapGridStack
  * \brief A collection of grids which is drawn above the map content in a
  * QgsComposerMap. The grid stack controls which grids are drawn and the
@@ -121,7 +121,7 @@ class QgsComposerMapGridStack : QgsComposerMapItemStack
 // QgsComposerMapGrid
 //
 
-/** \ingroup MapComposer
+/** \ingroup core
  * \class QgsComposerMapGrid
  * \brief An individual grid which is drawn above the map content in a
  * QgsComposerMap.

diff --git a/python/core/composer/qgscomposermapitem.sip b/python/core/composer/qgscomposermapitem.sip
@@ -1,4 +1,4 @@
-/** \ingroup MapComposer
+/** \ingroup core
  *  \class QgsComposerMapItem
  *  \brief An item which is drawn inside a QgsComposerMap, eg a grid or map overview.
  */
@@ -87,7 +87,7 @@ class QgsComposerMapItem : QgsComposerObject
 
 
 
-/** \ingroup MapComposer
+/** \ingroup core
  * \class QgsComposerMapItemStack
  * \brief A collection of map items which are drawn above the map content in a
  * QgsComposerMap. The item stack controls which items are drawn and the

diff --git a/python/core/composer/qgscomposermapoverview.sip b/python/core/composer/qgscomposermapoverview.sip
@@ -1,4 +1,4 @@
-/** \ingroup MapComposer
+/** \ingroup core
  * \class QgsComposerMapOverviewStack
  * \brief A collection of overviews which are drawn above the map content in a
  * QgsComposerMap. The overview stack controls which overviews are drawn and the
@@ -98,7 +98,7 @@ class QgsComposerMapOverviewStack : QgsComposerMapItemStack
 
 };
 
-/** \ingroup MapComposer
+/** \ingroup core
  * \class QgsComposerMapOverview
  * \brief An individual overview which is drawn above the map content in a
  * QgsComposerMap, and shows the extent of another QgsComposerMap.

diff --git a/python/core/composer/qgscomposermodel.sip b/python/core/composer/qgscomposermodel.sip
@@ -1,6 +1,6 @@
 /**
  * \class QgsComposerModel
- * \ingroup MapComposer
+ * \ingroup core
  *
  * A model for items attached to a composition. The model also maintains the z-order for the
  * composition, and must be notified whenever item stacking changes.

diff --git a/python/core/composer/qgscomposerobject.sip b/python/core/composer/qgscomposerobject.sip
@@ -1,4 +1,4 @@
-/** \ingroup MapComposer
+/** \ingroup core
  * A base class for objects which belong to a map composition.
  */
 class QgsComposerObject : QObject

diff --git a/python/core/composer/qgscomposerpicture.sip b/python/core/composer/qgscomposerpicture.sip
@@ -1,4 +1,4 @@
-/** \ingroup MapComposer
+/** \ingroup core
  * A composer class that displays svg files or raster format (jpg, png, ...)
  * */
 class QgsComposerPicture: QgsComposerItem

diff --git a/python/core/composer/qgscomposerscalebar.sip b/python/core/composer/qgscomposerscalebar.sip
@@ -1,4 +1,4 @@
-/** \ingroup MapComposer
+/** \ingroup core
  * A scale bar item that can be added to a map composition.
  */
 

diff --git a/python/core/composer/qgscomposertablev2.sip b/python/core/composer/qgscomposertablev2.sip
@@ -16,7 +16,7 @@ typedef QList< QList< QVariant > > QgsComposerTableContents;
 typedef QList<QgsComposerTableColumn*> QgsComposerTableColumns;
 
 
-/** \ingroup MapComposer
+/** \ingroup core
  *  \class QgsComposerTableStyle
  *  \brief Styling option for a composer table cell
  *  \note added in QGIS 2.12
@@ -54,7 +54,7 @@ class QgsComposerTableStyle
 
 /** A class to display a table in the print composer, and allow
  * the table to span over multiple frames
- * \ingroup MapComposer
+ * \ingroup core
  * @note added in QGIS 2.5
  */
 class QgsComposerTableV2: QgsComposerMultiFrame

diff --git a/python/core/composer/qgscomposerutils.sip b/python/core/composer/qgscomposerutils.sip
@@ -1,4 +1,4 @@
-/** \ingroup MapComposer
+/** \ingroup core
  * Utilities for compositions.
  */
 class QgsComposerUtils

diff --git a/python/core/composer/qgscomposition.sip b/python/core/composer/qgscomposition.sip
@@ -1,4 +1,4 @@
-/** \ingroup MapComposer
+/** \ingroup core
  * Graphics scene for map printing. The class manages the paper item which always
  * is the item in the back (z-value 0). It maintains the z-Values of the items and stores
  * them in a list in ascending z-Order. This list can be changed to lower/raise items one position

diff --git a/python/core/composer/qgslegendmodel.sip b/python/core/composer/qgslegendmodel.sip
@@ -1,4 +1,4 @@
-/** \ingroup MapComposer
+/** \ingroup core
  * A model that provides group, layer and classification items.
  */
 class QgsLegendModel : QStandardItemModel

diff --git a/python/core/composer/qgsscalebarstyle.sip b/python/core/composer/qgsscalebarstyle.sip
@@ -1,4 +1,4 @@
-/** \ingroup MapComposer
+/** \ingroup core
  * Abstraction of composer scale bar style. Subclasses draw themselves, have the
 possibility to implement custom labeling and calculate corresponding box size.
 */

diff --git a/python/gui/qgscomposerview.sip b/python/gui/qgscomposerview.sip
@@ -1,4 +1,4 @@
-/** \ingroup MapComposer
+/** \ingroup core
  * 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/app/composer/qgsatlascompositionwidget.h b/src/app/composer/qgsatlascompositionwidget.h
@@ -22,7 +22,7 @@ class QgsMapLayer;
 class QgsComposerMap;
 class QgsComposerItem;
 
-/** \ingroup MapComposer
+/** \ingroup app
   * Input widget for QgsAtlasComposition
   */
 class QgsAtlasCompositionWidget:

diff --git a/src/app/composer/qgscomposer.h b/src/app/composer/qgscomposer.h
@@ -55,7 +55,7 @@ class QLabel;
 class QTreeView;
 class QPrinter;
 
-/** \ingroup MapComposer
+/** \ingroup app
  * \brief A gui for composing a printable map.
  */
 class QgsComposer: public QMainWindow, private Ui::QgsComposerBase

diff --git a/src/app/composer/qgscomposerlabelwidget.h b/src/app/composer/qgscomposerlabelwidget.h
@@ -23,7 +23,7 @@
 
 class QgsComposerLabel;
 
-/** \ingroup MapComposer
+/** \ingroup app
   * A widget to enter text, font size, box yes/no for composer labels
   */
 class QgsComposerLabelWidget: public QgsComposerItemBaseWidget, private Ui::QgsComposerLabelWidgetBase

diff --git a/src/app/composer/qgscomposerlegenditemdialog.h b/src/app/composer/qgscomposerlegenditemdialog.h
@@ -23,7 +23,7 @@
 
 class QStandardItem;
 
-/** \ingroup MapComposer
+/** \ingroup app
  * A dialog to enter properties of composer legend items (currently only item text)
  * */
 class QgsComposerLegendItemDialog: public QDialog, private Ui::QgsComposerLegendItemDialogBase

diff --git a/src/app/composer/qgscomposerlegendlayersdialog.h b/src/app/composer/qgscomposerlegendlayersdialog.h
@@ -18,7 +18,7 @@
 #include "ui_qgscomposerlegendlayersdialogbase.h"
 #include "qgsmaplayer.h"
 
-/** \ingroup MapComposer
+/** \ingroup app
  * A dialog to add new layers to the legend.
  * */
 class QgsComposerLegendLayersDialog: public QDialog, private Ui::QgsComposerLegendLayersDialogBase

diff --git a/src/app/composer/qgscomposerlegendwidget.h b/src/app/composer/qgscomposerlegendwidget.h
@@ -26,7 +26,7 @@
 class QgsComposerLegend;
 
 
-/** \ingroup MapComposer
+/** \ingroup app
  * A widget for setting properties relating to a composer legend.
  */
 class QgsComposerLegendWidget: public QgsComposerItemBaseWidget, private Ui::QgsComposerLegendWidgetBase

diff --git a/src/app/composer/qgscomposermapwidget.h b/src/app/composer/qgscomposermapwidget.h
@@ -25,7 +25,7 @@
 
 class QgsMapLayer;
 
-/** \ingroup MapComposer
+/** \ingroup app
  * Input widget for the configuration of QgsComposerMap
  * */
 class QgsComposerMapWidget: public QgsComposerItemBaseWidget, private Ui::QgsComposerMapWidgetBase

diff --git a/src/app/composer/qgscomposerpicturewidget.h b/src/app/composer/qgscomposerpicturewidget.h
@@ -23,7 +23,7 @@
 
 class QgsComposerPicture;
 
-/** \ingroup MapComposer
+/** \ingroup app
  * A widget for adding an image to a map composition.
  */
 class QgsComposerPictureWidget: public QgsComposerItemBaseWidget, private Ui::QgsComposerPictureWidgetBase

diff --git a/src/app/composer/qgscomposerscalebarwidget.h b/src/app/composer/qgscomposerscalebarwidget.h
@@ -22,7 +22,7 @@
 
 class QgsComposerScaleBar;
 
-/** \ingroup MapComposer
+/** \ingroup app
  * A widget to define the properties of a QgsComposerScaleBarItem.
  */
 class QgsComposerScaleBarWidget: public QgsComposerItemBaseWidget, private Ui::QgsComposerScaleBarWidgetBase

diff --git a/src/app/composer/qgscompositionwidget.h b/src/app/composer/qgscompositionwidget.h
@@ -21,7 +21,7 @@ class QgsComposition;
 class QgsComposerMap;
 class QgsDataDefinedButton;
 
-/** \ingroup MapComposer
+/** \ingroup app
  * Struct to hold map composer paper properties.
  */
 struct QgsCompositionPaper
@@ -32,7 +32,7 @@ struct QgsCompositionPaper
   double mHeight;
 };
 
-/** \ingroup MapComposer
+/** \ingroup app
   * Input widget for QgsComposition
   */
 class QgsCompositionWidget: public QWidget, private Ui::QgsCompositionWidgetBase

diff --git a/src/core/composer/qgsatlascomposition.h b/src/core/composer/qgsatlascomposition.h
@@ -32,7 +32,7 @@ class QgsVectorLayer;
 class QgsExpression;
 class QgsExpressionContext;
 
-/** \ingroup MapComposer
+/** \ingroup core
  * Class used to render an Atlas, iterating over geometry features.
  * prepareForFeature() modifies the atlas map's extent to zoom on the given feature.
  * This class is used for printing, exporting to PDF and images.

diff --git a/src/core/composer/qgscomposeritem.h b/src/core/composer/qgscomposeritem.h
@@ -33,7 +33,7 @@ class QgsDataDefined;
 class QgsComposition;
 class QgsExpressionContext;
 
-/** \ingroup MapComposer
+/** \ingroup core
  * A item that forms part of a map composition.
  */
 class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRectItem

diff --git a/src/core/composer/qgscomposeritemgroup.h b/src/core/composer/qgscomposeritemgroup.h
@@ -20,7 +20,7 @@
 #include "qgscomposeritem.h"
 #include <QSet>
 
-/** \ingroup MapComposer
+/** \ingroup core
  * A container for grouping several QgsComposerItems
  */
 class CORE_EXPORT QgsComposerItemGroup: public QgsComposerItem

diff --git a/src/core/composer/qgscomposerlabel.h b/src/core/composer/qgscomposerlabel.h
@@ -25,7 +25,7 @@ class QgsFeature;
 class QgsDistanceArea;
 class QgsWebPage;
 
-/** \ingroup MapComposer
+/** \ingroup core
  * A label that can be placed onto a map composition.
  */
 class CORE_EXPORT QgsComposerLabel: public QgsComposerItem

diff --git a/src/core/composer/qgscomposerlegend.h b/src/core/composer/qgscomposerlegend.h
@@ -33,7 +33,7 @@ class QgsComposerMap;
 class QgsLegendRenderer;
 
 
-/** \ingroup MapComposer
+/** \ingroup core
  * Item model implementation based on layer tree model for composer legend.
  * Overrides some functionality of QgsLayerTreeModel to better fit the needs of composer legend.
  *
@@ -52,7 +52,7 @@ class CORE_EXPORT QgsLegendModelV2 : public QgsLayerTreeModel
 };
 
 
-/** \ingroup MapComposer
+/** \ingroup core
  * A legend that can be placed onto a map composition
  */
 class CORE_EXPORT QgsComposerLegend : public QgsComposerItem

diff --git a/src/core/composer/qgscomposerlegendstyle.h b/src/core/composer/qgscomposerlegendstyle.h
@@ -24,7 +24,7 @@
 #include <QDomElement>
 #include <QDomDocument>
 
-/** \ingroup MapComposer
+/** \ingroup core
  * Composer legend components style
  */
 class CORE_EXPORT QgsComposerLegendStyle

diff --git a/src/core/composer/qgscomposermap.h b/src/core/composer/qgscomposermap.h
@@ -38,7 +38,7 @@ class QgsFillSymbolV2;
 class QgsLineSymbolV2;
 class QgsVectorLayer;
 
-/** \ingroup MapComposer
+/** \ingroup core
  *  \class QgsComposerMap
  *  \brief Object representing map window.
  */

diff --git a/src/core/composer/qgscomposermapgrid.h b/src/core/composer/qgscomposermapgrid.h
@@ -34,7 +34,7 @@ class QDomDocument;
 class QDomElement;
 class QPainter;
 
-/** \ingroup MapComposer
+/** \ingroup core
  * \class QgsComposerMapGridStack
  * \brief A collection of grids which is drawn above the map content in a
  * QgsComposerMap. The grid stack controls which grids are drawn and the
@@ -153,7 +153,7 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack
 // QgsComposerMapGrid
 //
 
-/** \ingroup MapComposer
+/** \ingroup core
  * \class QgsComposerMapGrid
  * \brief An individual grid which is drawn above the map content in a
  * QgsComposerMap.

diff --git a/src/core/composer/qgscomposermapitem.h b/src/core/composer/qgscomposermapitem.h
@@ -21,7 +21,7 @@
 
 class QgsComposerMap;
 
-/** \ingroup MapComposer
+/** \ingroup core
  *  \class QgsComposerMapItem
  *  \brief An item which is drawn inside a QgsComposerMap, eg a grid or map overview.
  */
@@ -122,7 +122,7 @@ class CORE_EXPORT QgsComposerMapItem : public QgsComposerObject
 
 
 
-/** \ingroup MapComposer
+/** \ingroup core
  * \class QgsComposerMapItemStack
  * \brief A collection of map items which are drawn above the map content in a
  * QgsComposerMap. The item stack controls which items are drawn and the

diff --git a/src/core/composer/qgscomposermapoverview.h b/src/core/composer/qgscomposermapoverview.h
@@ -28,7 +28,7 @@ class QDomElement;
 class QgsFillSymbolV2;
 class QgsComposerMapOverview;
 
-/** \ingroup MapComposer
+/** \ingroup core
  * \class QgsComposerMapOverviewStack
  * \brief A collection of overviews which are drawn above the map content in a
  * QgsComposerMap. The overview stack controls which overviews are drawn and the
@@ -125,7 +125,7 @@ class CORE_EXPORT QgsComposerMapOverviewStack : public QgsComposerMapItemStack
 
 };
 
-/** \ingroup MapComposer
+/** \ingroup core
  * \class QgsComposerMapOverview
  * \brief An individual overview which is drawn above the map content in a
  * QgsComposerMap, and shows the extent of another QgsComposerMap.