Skip to content

Commit

Permalink
Replace doxygen MapComposer group with core/gui
Browse files Browse the repository at this point in the history
Since the MapComposer group doesn't actually exist
  • Loading branch information
nyalldawson committed Jul 4, 2016
1 parent 9f299a6 commit a240cd8
Show file tree
Hide file tree
Showing 55 changed files with 66 additions and 66 deletions.
2 changes: 1 addition & 1 deletion python/core/composer/qgsatlascomposition.sip
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposerattributetable.sip
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** \ingroup MapComposer
/** \ingroup core
* Attribute table item for map composer.
*/

Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposeritem.sip
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** \ingroup MapComposer
/** \ingroup core
* A item that forms part of a map composition.
*/
class QgsComposerItem : QgsComposerObject, QGraphicsRectItem
Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposeritemcommand.sip
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** \ingroup MapComposer
/** \ingroup core
Undo command to undo/redo all composer item related changes*/
class QgsComposerItemCommand: QUndoCommand
{
Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposerlabel.sip
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** \ingroup MapComposer
/** \ingroup core
* A label that can be placed onto a map composition.
*/
class QgsComposerLabel : QgsComposerItem
Expand Down
4 changes: 2 additions & 2 deletions python/core/composer/qgscomposerlegend.sip
Original file line number Diff line number Diff line change
@@ -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.
*
Expand All @@ -20,7 +20,7 @@ class QgsLegendModelV2 : QgsLayerTreeModel
};


/** \ingroup MapComposer
/** \ingroup core
* A legend that can be placed onto a map composition
*/
class QgsComposerLegend : QgsComposerItem
Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposermap.sip
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** \ingroup MapComposer
/** \ingroup core
* \class QgsComposerMap
* \brief Object representing map window.
*/
Expand Down
4 changes: 2 additions & 2 deletions python/core/composer/qgscomposermapgrid.sip
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions python/core/composer/qgscomposermapitem.sip
Original file line number Diff line number Diff line change
@@ -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.
*/
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions python/core/composer/qgscomposermapoverview.sip
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposermodel.sip
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposerobject.sip
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** \ingroup MapComposer
/** \ingroup core
* A base class for objects which belong to a map composition.
*/
class QgsComposerObject : QObject
Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposerpicture.sip
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** \ingroup MapComposer
/** \ingroup core
* A composer class that displays svg files or raster format (jpg, png, ...)
* */
class QgsComposerPicture: QgsComposerItem
Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposerscalebar.sip
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** \ingroup MapComposer
/** \ingroup core
* A scale bar item that can be added to a map composition.
*/

Expand Down
4 changes: 2 additions & 2 deletions python/core/composer/qgscomposertablev2.sip
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposerutils.sip
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** \ingroup MapComposer
/** \ingroup core
* Utilities for compositions.
*/
class QgsComposerUtils
Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposition.sip
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgslegendmodel.sip
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** \ingroup MapComposer
/** \ingroup core
* A model that provides group, layer and classification items.
*/
class QgsLegendModel : QStandardItemModel
Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgsscalebarstyle.sip
Original file line number Diff line number Diff line change
@@ -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.
*/
Expand Down
2 changes: 1 addition & 1 deletion python/gui/qgscomposerview.sip
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/app/composer/qgsatlascompositionwidget.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class QgsMapLayer;
class QgsComposerMap;
class QgsComposerItem;

/** \ingroup MapComposer
/** \ingroup app
* Input widget for QgsAtlasComposition
*/
class QgsAtlasCompositionWidget:
Expand Down
2 changes: 1 addition & 1 deletion src/app/composer/qgscomposer.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/app/composer/qgscomposerlabelwidget.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/app/composer/qgscomposerlegenditemdialog.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/app/composer/qgscomposerlegendlayersdialog.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/app/composer/qgscomposerlegendwidget.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/app/composer/qgscomposermapwidget.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

class QgsMapLayer;

/** \ingroup MapComposer
/** \ingroup app
* Input widget for the configuration of QgsComposerMap
* */
class QgsComposerMapWidget: public QgsComposerItemBaseWidget, private Ui::QgsComposerMapWidgetBase
Expand Down
2 changes: 1 addition & 1 deletion src/app/composer/qgscomposerpicturewidget.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/app/composer/qgscomposerscalebarwidget.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/app/composer/qgscompositionwidget.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class QgsComposition;
class QgsComposerMap;
class QgsDataDefinedButton;

/** \ingroup MapComposer
/** \ingroup app
* Struct to hold map composer paper properties.
*/
struct QgsCompositionPaper
Expand All @@ -32,7 +32,7 @@ struct QgsCompositionPaper
double mHeight;
};

/** \ingroup MapComposer
/** \ingroup app
* Input widget for QgsComposition
*/
class QgsCompositionWidget: public QWidget, private Ui::QgsCompositionWidgetBase
Expand Down
2 changes: 1 addition & 1 deletion src/core/composer/qgsatlascomposition.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/core/composer/qgscomposeritem.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/core/composer/qgscomposeritemgroup.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/core/composer/qgscomposerlabel.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/core/composer/qgscomposerlegend.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/core/composer/qgscomposerlegendstyle.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
#include <QDomElement>
#include <QDomDocument>

/** \ingroup MapComposer
/** \ingroup core
* Composer legend components style
*/
class CORE_EXPORT QgsComposerLegendStyle
Expand Down
2 changes: 1 addition & 1 deletion src/core/composer/qgscomposermap.h