Annotate core module members properly.

qgis · Oct 4, 2012 · 2be43f8 · 2be43f8
1 parent 2ceb1ab
commit 2be43f8
Show file tree

Hide file tree

Showing 14 changed files with 45 additions and 1 deletion.
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: