doxygen documentation

2019-02-20 13:35:12 +01:00
parent a46266d32f
commit 8e858d9376
23 changed files with 1247 additions and 975 deletions
@@ -1,3 +1,8 @@
+/*!
+ \file cimage.h
+
+*/
+
 #ifndef CIMAGE_H
 #define CIMAGE_H

@@ -5,111 +10,123 @@
 #include <QImage>


-/**
- * @brief
- *
- */
+/*!
+ \brief
+
+ \class cImage cimage.h "cimage.h"
+*/
 class cImage : public QImage
 {
 public:
 	cImage();
-	/**
-	 * @brief
-	 *
-	 * @param size
-	 * @param format
-	 */
+	/*!
+	 \brief
+
+	 \fn cImage
+	 \param size
+	 \param format
+	*/
 	cImage(const QSize &size, QImage::Format format);
-	/**
-	 * @brief
-	 *
-	 * @param width
-	 * @param height
-	 * @param format
-	 */
+	/*!
+	 \brief
+
+	 \fn cImage
+	 \param width
+	 \param height
+	 \param format
+	*/
 	cImage(int width, int height, QImage::Format format);
-	/**
-	 * @brief
-	 *
-	 * @param data
-	 * @param width
-	 * @param height
-	 * @param format
-	 * @param cleanupFunction
-	 * @param cleanupInfo
-	 */
+	/*!
+	 \brief
+
+	 \fn cImage
+	 \param data
+	 \param width
+	 \param height
+	 \param format
+	 \param cleanupFunction
+	 \param cleanupInfo
+	*/
 	cImage(uchar *data, int width, int height, QImage::Format format, QImageCleanupFunction cleanupFunction = nullptr, void *cleanupInfo = nullptr);
-	/**
-	 * @brief
-	 *
-	 * @param data
-	 * @param width
-	 * @param height
-	 * @param format
-	 * @param cleanupFunction
-	 * @param cleanupInfo
-	 */
+	/*!
+	 \brief
+
+	 \fn cImage
+	 \param data
+	 \param width
+	 \param height
+	 \param format
+	 \param cleanupFunction
+	 \param cleanupInfo
+	*/
 	cImage(const uchar *data, int width, int height, QImage::Format format, QImageCleanupFunction cleanupFunction = nullptr, void *cleanupInfo = nullptr);
-	/**
-	 * @brief
-	 *
-	 * @param data
-	 * @param width
-	 * @param height
-	 * @param bytesPerLine
-	 * @param format
-	 * @param cleanupFunction
-	 * @param cleanupInfo
-	 */
+	/*!
+	 \brief
+
+	 \fn cImage
+	 \param data
+	 \param width
+	 \param height
+	 \param bytesPerLine
+	 \param format
+	 \param cleanupFunction
+	 \param cleanupInfo
+	*/
 	cImage(uchar *data, int width, int height, int bytesPerLine, QImage::Format format, QImageCleanupFunction cleanupFunction = nullptr, void *cleanupInfo = nullptr);
-	/**
-	 * @brief
-	 *
-	 * @param data
-	 * @param width
-	 * @param height
-	 * @param bytesPerLine
-	 * @param format
-	 * @param cleanupFunction
-	 * @param cleanupInfo
-	 */
+	/*!
+	 \brief
+
+	 \fn cImage
+	 \param data
+	 \param width
+	 \param height
+	 \param bytesPerLine
+	 \param format
+	 \param cleanupFunction
+	 \param cleanupInfo
+	*/
 	cImage(const uchar *data, int width, int height, int bytesPerLine, QImage::Format format, QImageCleanupFunction cleanupFunction = nullptr, void *cleanupInfo = nullptr);
-	/**
-	 * @brief
-	 *
-	 * @param fileName
-	 * @param format
-	 */
+	/*!
+	 \brief
+
+	 \fn cImage
+	 \param fileName
+	 \param format
+	*/
 	cImage(const QString &fileName, const char *format = nullptr);
-	/**
-	 * @brief
-	 *
-	 * @param image
-	 */
+	/*!
+	 \brief
+
+	 \fn cImage
+	 \param image
+	*/
 	cImage(const QImage &image);
-	/**
-	 * @brief
-	 *
-	 * @param other
-	 */
+	/*!
+	 \brief
+
+	 \fn cImage
+	 \param other
+	*/
 	cImage(QImage &&other);

-	/**
-	 * @brief
-	 *
-	 * @param fileName
-	 * @param format
-	 * @return bool
-	 */
+	/*!
+	 \brief
+
+	 \fn load
+	 \param fileName
+	 \param format
+	 \return bool
+	*/
 	bool	load(const QString &fileName, const char *format = nullptr);

 private:
-	/**
-	 * @brief
-	 *
-	 * @param fileName
-	 * @return bool
-	 */
+	/*!
+	 \brief
+
+	 \fn loadRAW
+	 \param fileName
+	 \return bool
+	*/
 	bool	loadRAW(const QString &fileName);
 };