[QGIS Commit] r9070 - in branches/advanced_printing_branch: . doc
src/app/composer
svn_qgis at osgeo.org
svn_qgis at osgeo.org
Mon Aug 18 09:23:07 EDT 2008
Author: timlinux
Date: 2008-08-18 09:23:07 -0400 (Mon, 18 Aug 2008)
New Revision: 9070
Modified:
branches/advanced_printing_branch/Doxyfile
branches/advanced_printing_branch/doc/modules.dox
branches/advanced_printing_branch/src/app/composer/qgscomposer.h
branches/advanced_printing_branch/src/app/composer/qgscomposeritem.h
branches/advanced_printing_branch/src/app/composer/qgscomposeritemgroup.h
branches/advanced_printing_branch/src/app/composer/qgscomposerlabel.h
branches/advanced_printing_branch/src/app/composer/qgscomposerlabelwidget.h
branches/advanced_printing_branch/src/app/composer/qgscomposerlegend.h
branches/advanced_printing_branch/src/app/composer/qgscomposerlegenditemdialog.h
branches/advanced_printing_branch/src/app/composer/qgscomposerlegendwidget.h
branches/advanced_printing_branch/src/app/composer/qgscomposermap.h
branches/advanced_printing_branch/src/app/composer/qgscomposermapwidget.h
branches/advanced_printing_branch/src/app/composer/qgscomposerpicture.h
branches/advanced_printing_branch/src/app/composer/qgscomposerpicturewidget.h
branches/advanced_printing_branch/src/app/composer/qgscomposerscalebar.h
branches/advanced_printing_branch/src/app/composer/qgscomposerscalebarwidget.h
branches/advanced_printing_branch/src/app/composer/qgscomposervectorlegend.h
branches/advanced_printing_branch/src/app/composer/qgscomposerview.h
branches/advanced_printing_branch/src/app/composer/qgscomposition.h
branches/advanced_printing_branch/src/app/composer/qgscompositionwidget.h
branches/advanced_printing_branch/src/app/composer/qgsdoubleboxscalebarstyle.h
branches/advanced_printing_branch/src/app/composer/qgslegendmodel.h
branches/advanced_printing_branch/src/app/composer/qgsnumericscalebarstyle.h
branches/advanced_printing_branch/src/app/composer/qgsscalebarstyle.h
branches/advanced_printing_branch/src/app/composer/qgssingleboxscalebarstyle.h
branches/advanced_printing_branch/src/app/composer/qgsticksscalebarstyle.h
Log:
Added a new doxygen module 'MapComposer'
Set doxygen to use javadoc style brief descriptions.
Ensire that all composer classes are in mapcomposer group and have brief descriptions.
Modified: branches/advanced_printing_branch/Doxyfile
===================================================================
--- branches/advanced_printing_branch/Doxyfile 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/Doxyfile 2008-08-18 13:23:07 UTC (rev 9070)
@@ -150,7 +150,7 @@
# comments will behave just like the Qt-style comments (thus requiring an
# explicit @brief command for a brief description.
-JAVADOC_AUTOBRIEF = NO
+JAVADOC_AUTOBRIEF = YES
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
Modified: branches/advanced_printing_branch/doc/modules.dox
===================================================================
--- branches/advanced_printing_branch/doc/modules.dox 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/doc/modules.dox 2008-08-18 13:23:07 UTC (rev 9070)
@@ -1,4 +1,5 @@
/** @defgroup library */
/** @defgroup gui */
/** @defgroup core*/
+/** @defgroup MapComposer*/
/** @defgroup UnitTests*/
Modified: branches/advanced_printing_branch/src/app/composer/qgscomposer.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgscomposer.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgscomposer.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -39,7 +39,9 @@
class QFile;
class QSizeGrip;
-/* The constructor creates empty composer, without compositions and mFirstTime set to true.
+/** \ingroup MapComposer
+ * \brief A gui for composing a printable map.
+ * The constructor creates empty composer, without compositions and mFirstTime set to true.
* - if signal projectRead() is recieved all old compositions are deleted and
* - if the composition exists in project it is created from project settings (mFirstTime set to false)
* - if the composition does not exist in project
Modified: branches/advanced_printing_branch/src/app/composer/qgscomposeritem.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgscomposeritem.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgscomposeritem.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -26,6 +26,9 @@
class QqsComposition;
+/** \ingroup MapComposer
+ * A item that forms part of a map composition.
+ */
class QgsComposerItem: public QGraphicsRectItem
{
Modified: branches/advanced_printing_branch/src/app/composer/qgscomposeritemgroup.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgscomposeritemgroup.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgscomposeritemgroup.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -21,6 +21,9 @@
class QgsComposition;
+/** \ingroup MapComposer
+ * A container for grouping several QgsComposerItems
+ */
class QgsComposerItemGroup: public QObject, public QgsComposerItem
{
Q_OBJECT
Modified: branches/advanced_printing_branch/src/app/composer/qgscomposerlabel.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgscomposerlabel.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgscomposerlabel.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -19,6 +19,9 @@
#include "qgscomposeritem.h"
+/** \ingroup MapComposer
+ * A label that can be placed onto a map composition.
+ */
class QgsComposerLabel: public QgsComposerItem
{
public:
Modified: branches/advanced_printing_branch/src/app/composer/qgscomposerlabelwidget.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgscomposerlabelwidget.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgscomposerlabelwidget.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -22,7 +22,9 @@
class QgsComposerLabel;
-/**A widget to enter text, font size, box yes/no for composer labels*/
+/** \ingroup MapComposer
+ * A widget to enter text, font size, box yes/no for composer labels
+ */
class QgsComposerLabelWidget: public QWidget, private Ui::QgsComposerLabelWidgetBase
{
Q_OBJECT
Modified: branches/advanced_printing_branch/src/app/composer/qgscomposerlegend.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgscomposerlegend.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgscomposerlegend.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -23,7 +23,9 @@
#include <QObject>
class QgsSymbol;
-
+/** \ingroup MapComposer
+ * A legend that can be placed onto a map composition
+ */
class QgsComposerLegend: public QObject, public QgsComposerItem
{
Q_OBJECT
Modified: branches/advanced_printing_branch/src/app/composer/qgscomposerlegenditemdialog.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgscomposerlegenditemdialog.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgscomposerlegenditemdialog.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -22,7 +22,9 @@
class QStandardItem;
-/**A dialog to enter properties of composer legend items (currently only item text)*/
+/** \ingroup MapComposer
+ * A dialog to enter properties of composer legend items (currently only item text)
+ * */
class QgsComposerLegendItemDialog: private Ui::QgsComposerLegendItemDialogBase, public QDialog
{
public:
Modified: branches/advanced_printing_branch/src/app/composer/qgscomposerlegendwidget.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgscomposerlegendwidget.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgscomposerlegendwidget.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -23,6 +23,9 @@
class QgsComposerLegend;
+/** \ingroup MapComposer
+ * A widget for setting properties relating to a composer legend.
+ */
class QgsComposerLegendWidget: public QWidget, private Ui::QgsComposerLegendWidgetBase
{
Q_OBJECT
Modified: branches/advanced_printing_branch/src/app/composer/qgscomposermap.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgscomposermap.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgscomposermap.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -31,7 +31,8 @@
class QDomDocument;
class QPainter;
-/** \class QgsComposerMap
+/** \ingroup MapComposer
+ * \class QgsComposerMap
* \brief Object representing map window.
*/
// NOTE: QgsComposerMapBase must be first, otherwise does not compile
Modified: branches/advanced_printing_branch/src/app/composer/qgscomposermapwidget.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgscomposermapwidget.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgscomposermapwidget.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -22,7 +22,9 @@
class QgsComposerMap;
-/**Input widget for the configuration of QgsComposerMap*/
+/** \ingroup MapComposer
+ * Input widget for the configuration of QgsComposerMap
+ * */
class QgsComposerMapWidget: public QWidget, private Ui::QgsComposerMapWidgetBase
{
Q_OBJECT
Modified: branches/advanced_printing_branch/src/app/composer/qgscomposerpicture.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgscomposerpicture.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgscomposerpicture.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -22,7 +22,9 @@
#include <QImage>
#include <QObject>
-/**A composer class that displays svg files or raster format (jpg, png, ...)*/
+/** \ingroup MapComposer
+ * A composer class that displays svg files or raster format (jpg, png, ...)
+ * */
class QgsComposerPicture: public QObject, public QgsComposerItem
{
Q_OBJECT
Modified: branches/advanced_printing_branch/src/app/composer/qgscomposerpicturewidget.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgscomposerpicturewidget.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgscomposerpicturewidget.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -22,6 +22,9 @@
class QgsComposerPicture;
+/** \ingroup MapComposer
+ * A widget for adding an image to a map composition.
+ */
class QgsComposerPictureWidget: public QWidget, private Ui::QgsComposerPictureWidgetBase
{
Q_OBJECT
Modified: branches/advanced_printing_branch/src/app/composer/qgscomposerscalebar.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgscomposerscalebar.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgscomposerscalebar.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -22,6 +22,9 @@
class QgsComposerMap;
class QgsScaleBarStyle;
+/** \ingroup MapComposer
+ * A scale bar item that can be added to a map composition.
+ */
class QgsComposerScaleBar: public QObject, public QgsComposerItem
{
Modified: branches/advanced_printing_branch/src/app/composer/qgscomposerscalebarwidget.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgscomposerscalebarwidget.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgscomposerscalebarwidget.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -21,6 +21,9 @@
class QgsComposerScaleBar;
+/** \ingroup MapComposer
+ * A widget to define the properties of a QgsComposerScaleBarItem.
+ */
class QgsComposerScaleBarWidget: public QWidget, private Ui::QgsComposerScaleBarWidgetBase
{
Q_OBJECT
Modified: branches/advanced_printing_branch/src/app/composer/qgscomposervectorlegend.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgscomposervectorlegend.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgscomposervectorlegend.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -31,7 +31,7 @@
* -- | +-----+ | __
* mSymbolHeight | | | | Item Label | __| - mFont->pointSize()
* -- | +-----+ | --
- * | | | - mSymbolSpace (vertical space between symbo, boxes)
+ * | | | - mSymbolSpace (vertical space between symbol, boxes)
* | +-----+ | --
* | | | Item Label |
* | +-----+ |
@@ -43,19 +43,20 @@
*
*/
+
#include "ui_qgscomposervectorlegendbase.h"
#include "qgscomposeritem.h"
#include <QGraphicsRectItem>
#include <QPen>
-
class QgsComposition;
class QgsMapCanvas;
class QDomNode;
class QDomDocument;
class QTreeWidgetItem;
-/** \class QgsComposerVectorLegend
+/** \ingroup MapComposer
+ * \class QgsComposerVectorLegend
* \brief Object representing map window.
*/
// NOTE: QgsComposerVectorLegendBase must be first, otherwise does not compile
Modified: branches/advanced_printing_branch/src/app/composer/qgscomposerview.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgscomposerview.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgscomposerview.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -30,8 +30,12 @@
class QgsComposerPicture;
class QgsComposerScaleBar;
-/**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 off the rubber band item*/
+/** \ingroup MapComposer
+ * 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
+ * of the rubber band item.
+ */
class QgsComposerView: public QGraphicsView
{
Q_OBJECT
Modified: branches/advanced_printing_branch/src/app/composer/qgscomposition.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgscomposition.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgscomposition.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -26,7 +26,10 @@
class QDomDocument;
class QDomElement;
-/**Graphics scene for map printing. It manages the paper item which always is the item in the back (z-value 0)*/
+/** \ingroup MapComposer
+ * Graphics scene for map printing. It manages the paper item which always
+ * is the item in the back (z-value 0).
+ * */
class QgsComposition: public QGraphicsScene
{
public:
Modified: branches/advanced_printing_branch/src/app/composer/qgscompositionwidget.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgscompositionwidget.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgscompositionwidget.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -18,6 +18,9 @@
class QgsComposition;
+/** \ingroup MapComposer
+ * Struct to hold map composer paper properties.
+ */
struct QgsCompositionPaper
{
QgsCompositionPaper(QString name, double width, double height){mName = name; mWidth = width; mHeight = height;}
@@ -26,7 +29,9 @@
double mHeight;
};
-/**Input widget for QgsComposition*/
+/** \ingroup MapComposer
+ * Input widget for QgsComposition
+ */
class QgsCompositionWidget: public QWidget, private Ui::QgsCompositionWidgetBase
{
Q_OBJECT
Modified: branches/advanced_printing_branch/src/app/composer/qgsdoubleboxscalebarstyle.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgsdoubleboxscalebarstyle.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgsdoubleboxscalebarstyle.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -19,7 +19,9 @@
#include "qgsscalebarstyle.h"
-/**Double box with alternating colors*/
+/** \ingroup MapComposer
+ * Double box with alternating colors
+ */
class QgsDoubleBoxScaleBarStyle: public QgsScaleBarStyle
{
public:
Modified: branches/advanced_printing_branch/src/app/composer/qgslegendmodel.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgslegendmodel.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgslegendmodel.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -27,7 +27,10 @@
class QgsMapLayer;
class QgsSymbol;
-/**A model that provides layers as root items. The classification items are children of the layer items*/
+/** \ingroup MapComposer
+ * A model that provides layers as root items. The classification items are
+ * children of the layer items.
+ */
class QgsLegendModel: public QStandardItemModel
{
Q_OBJECT
Modified: branches/advanced_printing_branch/src/app/composer/qgsnumericscalebarstyle.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgsnumericscalebarstyle.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgsnumericscalebarstyle.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -19,7 +19,9 @@
#include "qgsscalebarstyle.h"
-/**A scale bar style that draws text in the form of '1:XXXXX'*/
+/** \ingroup MapComposer
+ * A scale bar style that draws text in the form of '1:XXXXX'
+ */
class QgsNumericScaleBarStyle: public QgsScaleBarStyle
{
public:
Modified: branches/advanced_printing_branch/src/app/composer/qgsscalebarstyle.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgsscalebarstyle.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgsscalebarstyle.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -23,8 +23,10 @@
class QgsComposerScaleBar;
class QPainter;
-/**Abstraction of composer scale bar style. Subclasses draw themselves, have the
-possibility to implement custom labeling and calculate corresponding box size*/
+/** \ingroup MapComposer
+ * Abstraction of composer scale bar style. Subclasses draw themselves, have the
+possibility to implement custom labeling and calculate corresponding box size.
+*/
class QgsScaleBarStyle
{
public:
Modified: branches/advanced_printing_branch/src/app/composer/qgssingleboxscalebarstyle.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgssingleboxscalebarstyle.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgssingleboxscalebarstyle.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -19,8 +19,10 @@
#include "qgsscalebarstyle.h"
-/**Scalebar style that draws a single box with alternating
- color for the segments*/
+/** \ingroup MapComposer
+ * Scalebar style that draws a single box with alternating
+ * color for the segments.
+ */
class QgsSingleBoxScaleBarStyle: public QgsScaleBarStyle
{
public:
Modified: branches/advanced_printing_branch/src/app/composer/qgsticksscalebarstyle.h
===================================================================
--- branches/advanced_printing_branch/src/app/composer/qgsticksscalebarstyle.h 2008-08-18 08:25:02 UTC (rev 9069)
+++ branches/advanced_printing_branch/src/app/composer/qgsticksscalebarstyle.h 2008-08-18 13:23:07 UTC (rev 9070)
@@ -19,6 +19,9 @@
#include "qgsscalebarstyle.h"
+/** \ingroup MapComposer
+ * A scale bar that draws segments using short ticks.
+ */
class QgsTicksScaleBarStyle: public QgsScaleBarStyle
{
public:
More information about the QGIS-commit
mailing list