Changeset 85870 in vbox for trunk/include

Timestamp:

Aug 21, 2020 4:56:23 PM (4 years ago)

Author:

vboxsync

Message:

iprt/formats/bmp.h: doxygen fixes and a couple of adjustments.

File:

• trunk/include/iprt/formats/bmp.h (modified) (4 diffs)

trunk/include/iprt/formats/bmp.h

@@ -1 +1 @@
 /* $Id$ */
 /** @file
- * Bitmap (BMP) format defines.
+ * IPRT - Microsoft Bitmap Formats (BMP).
  */
 
 /*
- * Copyright (C) 2020 Oracle Corporation
+ * Copyright (C) 2006-2020 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -34 +34 @@
 #include <iprt/assertcompile.h>
 
+
+/** @defgroup grp_rt_fmt_bmp  Microsoft Bitmaps Formats (BMP)
+ * @ingroup grp_rt_formats
+ * @{
+ */
+
 /** @name BMP header sizes (in bytes).
- * @{ . */
+ * @{ */
 #define BMP_HDR_SIZE_FILE      14
 #define BMP_HDR_SIZE_OS21      12
 #define BMP_HDR_SIZE_OS22      64
 #define BMP_HDR_SIZE_WIN3X     40
-/** @} . */
+/** @} */
 
-#pragma pack(1)
 
 /** BMP format file header. */
+#pragma pack(1)
 typedef struct BMPFILEHDR
 {
@@ -58 +64 @@
     uint32_t      offBits;
 } BMPFILEHDR;
+#pragma pack()
 AssertCompileSize(BMPFILEHDR, BMP_HDR_SIZE_FILE);
 /** Pointer to a BMP format file header. */
 typedef BMPFILEHDR *PBMPFILEHDR;
+
+/** BMP file magic number for BMP / DIB. */
+#define BMP_HDR_MAGIC (RT_H2LE_U16_C(0x4d42))
 
 /** OS/2 1.x BMP core header,
@@ -158 +168 @@
 typedef BMPWIN3XINFOHDR *PBMPWIN3XINFOHDR;
 
-#pragma pack()
 
-/** BMP file magic number for BMP / DIB. */
-#define BMP_HDR_MAGIC (RT_H2LE_U16_C(0x4d42))
 
 /** @name BMP compression types.
- * @{ . */
-typedef enum BMP_COMPRESSION_TYPE
-{
-    BMP_COMPRESSION_TYPE_NONE = 0,
-    BMP_COMPRESSION_TYPE_RLE8 = 1,
-    BMP_COMPRESSION_TYPE_RLE4 = 2
-} BMP_COMPRESSION_TYPE;
-/** @} . */
+ * @{  */
+#define BMP_COMPRESSION_TYPE_NONE  0
+#define BMP_COMPRESSION_TYPE_RLE8  1
+#define BMP_COMPRESSION_TYPE_RLE4  2
+/** @} */
+
+/** @} */
 
 #endif /* !IPRT_INCLUDED_formats_bmp_h */