Annotate core module members properly.

timlinux · timlinux · commit 2be43f8d454b · 2012-10-04T13:07:58.000+02:00
diff --git a/src/core/raster/qgsbilinearrasterresampler.h b/src/core/raster/qgsbilinearrasterresampler.h
@@ -21,6 +21,9 @@
 #include "qgsrasterresampler.h"
 #include <QColor>
 
+/** \ingroup core
+    Bilinear Raster Resampler
+*/
 class CORE_EXPORT QgsBilinearRasterResampler: public QgsRasterResampler
 {
   public:
diff --git a/src/core/raster/qgscubicrasterresampler.h b/src/core/raster/qgscubicrasterresampler.h
@@ -21,6 +21,9 @@
 #include "qgsrasterresampler.h"
 #include <QColor>
 
+/** \ingroup core
+    Cubic Raster Resampler
+*/
 class CORE_EXPORT QgsCubicRasterResampler: public QgsRasterResampler
 {
   public:
diff --git a/src/core/raster/qgspalettedrasterrenderer.h b/src/core/raster/qgspalettedrasterrenderer.h
@@ -23,6 +23,9 @@
 class QColor;
 class QDomElement;
 
+/** \ingroup core
+  * Renderer for paletted raster images.
+*/
 class CORE_EXPORT QgsPalettedRasterRenderer: public QgsRasterRenderer
 {
   public:
diff --git a/src/core/raster/qgsrasterdrawer.h b/src/core/raster/qgsrasterdrawer.h
@@ -27,6 +27,9 @@ class QgsMapToPixel;
 struct QgsRasterViewPort;
 class QgsRasterIterator;
 
+/** \ingroup core
+ * The drawing pipe for raster layers.
+ */
 class QgsRasterDrawer
 {
   public:
diff --git a/src/core/raster/qgsrasterfilewriter.h b/src/core/raster/qgsrasterfilewriter.h
@@ -26,6 +26,9 @@
 class QProgressDialog;
 class QgsRasterIterator;
 
+/** \ingroup core
+ * The raster file writer which allows you to save a raster to a new file.
+ */
 class CORE_EXPORT QgsRasterFileWriter
 {
   public:
diff --git a/src/core/raster/qgsrasteriterator.h b/src/core/raster/qgsrasteriterator.h
@@ -23,6 +23,9 @@ class QgsRasterInterface;
 class QgsRasterProjector;
 struct QgsRasterViewPort;
 
+/** \ingroup core
+ * Iterator for sequentially processing raster cells.
+ */
 class CORE_EXPORT QgsRasterIterator
 {
   public:
diff --git a/src/core/raster/qgsrasternuller.h b/src/core/raster/qgsrasternuller.h
@@ -23,6 +23,9 @@
 
 #include <QList>
 
+/** \ingroup core
+  * Raster pipe that deals with null values.
+*/
 class CORE_EXPORT QgsRasterNuller : public QgsRasterInterface
 {
   public:
diff --git a/src/core/raster/qgsrasterrenderer.h b/src/core/raster/qgsrasterrenderer.h
@@ -33,6 +33,9 @@ struct QgsRasterViewPort;
 
 class QDomElement;
 
+/** \ingroup core
+  * Raster renderer pipe that applies colours to a raster.
+  */
 class CORE_EXPORT QgsRasterRenderer : public QgsRasterInterface
 {
   public:
diff --git a/src/core/raster/qgsrasterrendererregistry.h b/src/core/raster/qgsrasterrendererregistry.h
@@ -32,6 +32,9 @@ class QgsRasterRendererWidget;
 typedef QgsRasterRenderer*( *QgsRasterRendererCreateFunc )( const QDomElement&, QgsRasterInterface* input );
 typedef QgsRasterRendererWidget*( *QgsRasterRendererWidgetCreateFunc )( QgsRasterLayer*, const QgsRectangle &extent );
 
+/** \ingroup core
+  * Registry for raster renderer entries.
+  */
 struct CORE_EXPORT QgsRasterRendererRegistryEntry
 {
   QgsRasterRendererRegistryEntry( const QString& theName, const QString& theVisibleName, QgsRasterRendererCreateFunc rendererFunction,
@@ -43,6 +46,9 @@ struct CORE_EXPORT QgsRasterRendererRegistryEntry
   QgsRasterRendererWidgetCreateFunc widgetCreateFunction; //pointer to create function for renderer widget
 };
 
+/** \ingroup core
+  * Registry for raster renderers.
+  */
 class CORE_EXPORT QgsRasterRendererRegistry
 {
   public:
diff --git a/src/core/raster/qgsrasterresamplefilter.h b/src/core/raster/qgsrasterresamplefilter.h
@@ -25,6 +25,9 @@ class QgsRasterResampler;
 
 class QDomElement;
 
+/** \ingroup core
+  * Resample filter pipe for rasters.
+  */
 class CORE_EXPORT QgsRasterResampleFilter : public QgsRasterInterface
 {
   public:
diff --git a/src/core/raster/qgsrasterresampler.h b/src/core/raster/qgsrasterresampler.h
@@ -22,7 +22,9 @@
 
 class QImage;
 
-/**Interface for resampling rasters (e.g. to have a smoother appearance)*/
+/** \ingroup core
+  * Interface for resampling rasters (e.g. to have a smoother appearance)
+  */
 class QgsRasterResampler
 {
   public:
diff --git a/src/core/raster/qgssinglebandcolordatarenderer.h b/src/core/raster/qgssinglebandcolordatarenderer.h
@@ -22,6 +22,9 @@
 
 class QDomElement;
 
+/** \ingroup core
+  * Raster renderer pipe for single band color.
+  */
 class CORE_EXPORT QgsSingleBandColorDataRenderer: public QgsRasterRenderer
 {
   public:
diff --git a/src/core/raster/qgssinglebandgrayrenderer.h b/src/core/raster/qgssinglebandgrayrenderer.h
@@ -23,6 +23,9 @@
 class QgsContrastEnhancement;
 class QDomElement;
 
+/** \ingroup core
+  * Raster renderer pipe for single band gray.
+  */
 class CORE_EXPORT QgsSingleBandGrayRenderer: public QgsRasterRenderer
 {
   public:
diff --git a/src/core/raster/qgssinglebandpseudocolorrenderer.h b/src/core/raster/qgssinglebandpseudocolorrenderer.h
@@ -23,6 +23,9 @@
 class QDomElement;
 class QgsRasterShader;
 
+/** \ingroup core
+  * Raster renderer pipe for single band pseudocolor.
+  */
 class CORE_EXPORT QgsSingleBandPseudoColorRenderer: public QgsRasterRenderer
 {
   public:

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,9 @@`
`21`	`21`	`#include "qgsrasterresampler.h"`
`22`	`22`	`#include <QColor>`
`23`	`23`
	`24`	`+/** \ingroup core`
	`25`	`+ Bilinear Raster Resampler`
	`26`	`+*/`
`24`	`27`	`class CORE_EXPORT QgsBilinearRasterResampler: public QgsRasterResampler`
`25`	`28`	`{`
`26`	`29`	`public:`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,9 @@`
`23`	`23`	`class QColor;`
`24`	`24`	`class QDomElement;`
`25`	`25`
	`26`	`+/** \ingroup core`
	`27`	`+ * Renderer for paletted raster images.`
	`28`	`+*/`
`26`	`29`	`class CORE_EXPORT QgsPalettedRasterRenderer: public QgsRasterRenderer`
`27`	`30`	`{`
`28`	`31`	`public:`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,9 @@ class QgsMapToPixel;`
`27`	`27`	`struct QgsRasterViewPort;`
`28`	`28`	`class QgsRasterIterator;`
`29`	`29`
	`30`	`+/** \ingroup core`
	`31`	`+ * The drawing pipe for raster layers.`
	`32`	`+ */`
`30`	`33`	`class QgsRasterDrawer`
`31`	`34`	`{`
`32`	`35`	`public:`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,9 @@`
`26`	`26`	`class QProgressDialog;`
`27`	`27`	`class QgsRasterIterator;`
`28`	`28`
	`29`	`+/** \ingroup core`
	`30`	`+ * The raster file writer which allows you to save a raster to a new file.`
	`31`	`+ */`
`29`	`32`	`class CORE_EXPORT QgsRasterFileWriter`
`30`	`33`	`{`
`31`	`34`	`public:`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,9 @@ class QgsRasterInterface;`
`23`	`23`	`class QgsRasterProjector;`
`24`	`24`	`struct QgsRasterViewPort;`
`25`	`25`
	`26`	`+/** \ingroup core`
	`27`	`+ * Iterator for sequentially processing raster cells.`
	`28`	`+ */`
`26`	`29`	`class CORE_EXPORT QgsRasterIterator`
`27`	`30`	`{`
`28`	`31`	`public:`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,9 @@ struct QgsRasterViewPort;`
`33`	`33`
`34`	`34`	`class QDomElement;`
`35`	`35`
	`36`	`+/** \ingroup core`
	`37`	`+ * Raster renderer pipe that applies colours to a raster.`
	`38`	`+ */`
`36`	`39`	`class CORE_EXPORT QgsRasterRenderer : public QgsRasterInterface`
`37`	`40`	`{`
`38`	`41`	`public:`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,9 @@ class QgsRasterResampler;`
`25`	`25`
`26`	`26`	`class QDomElement;`
`27`	`27`
	`28`	`+/** \ingroup core`
	`29`	`+ * Resample filter pipe for rasters.`
	`30`	`+ */`
`28`	`31`	`class CORE_EXPORT QgsRasterResampleFilter : public QgsRasterInterface`
`29`	`32`	`{`
`30`	`33`	`public:`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,9 @@`
`22`	`22`
`23`	`23`	`class QImage;`
`24`	`24`
`25`		`-/*Interface for resampling rasters (e.g. to have a smoother appearance)/`
	`25`	`+/** \ingroup core`
	`26`	`+ * Interface for resampling rasters (e.g. to have a smoother appearance)`
	`27`	`+ */`
`26`	`28`	`class QgsRasterResampler`
`27`	`29`	`{`
`28`	`30`	`public:`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,9 @@`
`22`	`22`
`23`	`23`	`class QDomElement;`
`24`	`24`
	`25`	`+/** \ingroup core`
	`26`	`+ * Raster renderer pipe for single band color.`
	`27`	`+ */`
`25`	`28`	`class CORE_EXPORT QgsSingleBandColorDataRenderer: public QgsRasterRenderer`
`26`	`29`	`{`
`27`	`30`	`public:`