Minor doxygen improvements

qgis · Oct 24, 2016 · 3ef8e6a · 3ef8e6a
1 parent af55c02
commit 3ef8e6a
Showing 1 changed file with 18 additions and 20 deletions.
diff --git a/src/core/qgis.h b/src/core/qgis.h
@@ -42,13 +42,13 @@ class CORE_EXPORT Qgis
   public:
     // Version constants
     //
-    // Version string
+    //! Version string
     static QString QGIS_VERSION;
-    // Version number used for comparing versions using the "Check QGIS Version" function
+    //! Version number used for comparing versions using the "Check QGIS Version" function
     static const int QGIS_VERSION_INT;
-    // Release name
+    //! Release name
     static QString QGIS_RELEASE_NAME;
-    // The development version
+    //! The development version
     static const char* QGIS_DEV_VERSION;
 
     // Enumerations
@@ -59,22 +59,20 @@ class CORE_EXPORT Qgis
      */
     enum DataType
     {
-      /** Unknown or unspecified type */                UnknownDataType = 0,
-      /** Eight bit unsigned integer (quint8) */        Byte = 1,
-      /** Sixteen bit unsigned integer (quint16) */     UInt16 = 2,
-      /** Sixteen bit signed integer (qint16) */        Int16 = 3,
-      /** Thirty two bit unsigned integer (quint32) */  UInt32 = 4,
-      /** Thirty two bit signed integer (qint32) */     Int32 = 5,
-      /** Thirty two bit floating point (float) */      Float32 = 6,
-      /** Sixty four bit floating point (double) */     Float64 = 7,
-      /** Complex Int16 */                              CInt16 = 8,
-      /** Complex Int32 */                              CInt32 = 9,
-      /** Complex Float32 */                            CFloat32 = 10,
-      /** Complex Float64 */                            CFloat64 = 11,
-      /** Color, alpha, red, green, blue, 4 bytes the same as
-          QImage::Format_ARGB32 */                      ARGB32 = 12,
-      /** Color, alpha, red, green, blue, 4 bytes  the same as
-          QImage::Format_ARGB32_Premultiplied */        ARGB32_Premultiplied = 13
+      UnknownDataType = 0, //!< Unknown or unspecified type
+      Byte = 1, //!< Eight bit unsigned integer (quint8)
+      UInt16 = 2, //!< Sixteen bit unsigned integer (quint16)
+      Int16 = 3, //!< Sixteen bit signed integer (qint16)
+      UInt32 = 4, //!< Thirty two bit unsigned integer (quint32)
+      Int32 = 5, //!< Thirty two bit signed integer (qint32)
+      Float32 = 6, //!< Thirty two bit floating point (float)
+      Float64 = 7, //!< Sixty four bit floating point (double)
+      CInt16 = 8, //!< Complex Int16
+      CInt32 = 9, //!< Complex Int32
+      CFloat32 = 10, //!< Complex Float32
+      CFloat64 = 11, //!< Complex Float64
+      ARGB32 = 12, //!< Color, alpha, red, green, blue, 4 bytes the same as QImage::Format_ARGB32
+      ARGB32_Premultiplied = 13 //!< Color, alpha, red, green, blue, 4 bytes  the same as QImage::Format_ARGB32_Premultiplied
     };
 
     //! User defined event types