fix Doxygen comments to be more consistent

Signed-off-by: Rosen Penev <[email protected]>

include/exiv2/image_types.hpp

@@ -11,30 +11,30 @@ enum class ImageType {
   asf,
   bigtiff,
   bmff,
-  bmp,  ///< Windows bitmap
+  bmp,  //!< Windows bitmap
   cr2,
   crw,
   dng,
   eps,
   exv,
-  gif,  ///< GIF
-  jp2,  ///< JPEG-2000
+  gif,  //!< GIF
+  jp2,  //!< JPEG-2000
   jpeg,
   mrw,
   nef,
   orf,
   pef,
   png,
   pgf,
-  psd,  ///< Photoshop (PSD)
+  psd,  //!< Photoshop (PSD)
   raf,
   rw2,
   sr2,
   srw,
   tga,
   tiff,
   webp,
-  xmp,  ///< XMP sidecar files
+  xmp,  //!< XMP sidecar files
   qtime,
   riff,
   mkv,

include/exiv2/jpgimage.hpp

@@ -175,7 +175,7 @@ class EXIV2API JpegImage : public JpegBase {
 
  private:
   // Constant data
-  static const byte blank_[];  ///< Minimal Jpeg image
+  static const byte blank_[];  //!< Minimal Jpeg image
 };
 
 //! Helper class to access %Exiv2 files

src/asfvideo.cpp

@@ -95,15 +95,15 @@ bool AsfVideo::GUIDTag::operator<(const GUIDTag& other) const {
 const AsfVideo::GUIDTag Header(0x75B22630, 0x668E, 0x11CF, {0xA6, 0xD9, 0x00, 0xAA, 0x00, 0x62, 0xCE, 0x6C});
 
 const std::map<AsfVideo::GUIDTag, std::string> GUIDReferenceTags = {
-    ///< Top-level ASF object GUIDS
+    //!< Top-level ASF object GUIDS
     {Header, "Header"},
     {{0x75B22636, 0x668E, 0x11CF, {0xA6, 0xD9, 0x00, 0xAA, 0x00, 0x62, 0xCE, 0x6C}}, "Data"},
     {{0x33000890, 0xE5B1, 0x11CF, {0x89, 0xF4, 0x00, 0xA0, 0xC9, 0x03, 0x49, 0xCB}}, "Simple_Index"},
     {{0xD6E229D3, 0x35DA, 0x11D1, {0x90, 0x34, 0x00, 0xA0, 0xC9, 0x03, 0x49, 0xBE}}, "Index"},
     {{0xFEB103F8, 0x12AD, 0x4C64, {0x84, 0x0F, 0x2A, 0x1D, 0x2F, 0x7A, 0xD4, 0x8C}}, "Media_Index"},
     {{0x3CB73FD0, 0x0C4A, 0x4803, {0x95, 0x3D, 0xED, 0xF7, 0xB6, 0x22, 0x8F, 0x0C}}, "Timecode_Index"},
 
-    ///< Header Object GUIDs
+    //!< Header Object GUIDs
     {{0x8CABDCA1, 0xA947, 0x11CF, {0x8E, 0xE4, 0x00, 0xC0, 0x0C, 0x20, 0x53, 0x65}}, "File_Properties"},
     {{0xB7DC0791, 0xA9B7, 0x11CF, {0x8E, 0xE6, 0x00, 0xC0, 0x0C, 0x20, 0x53, 0x65}}, "Stream_Properties"},
     {{0x5FBF03B5, 0xA92E, 0x11CF, {0x8E, 0xE3, 0x00, 0xC0, 0x0C, 0x20, 0x53, 0x65}}, "Header_Extension"},
@@ -121,7 +121,7 @@ const std::map<AsfVideo::GUIDTag, std::string> GUIDReferenceTags = {
     {{0x2211B3FC, 0xBD23, 0x11D2, {0xB4, 0xB7, 0x00, 0xA0, 0xC9, 0x55, 0xFC, 0x6E}}, "Digital_Signature"},
     {{0x1806D474, 0xCADF, 0x4509, {0xA4, 0xBA, 0x9A, 0xAB, 0xCB, 0x96, 0xAA, 0xE8}}, "Padding"},
 
-    ///< Header Extension Object GUIDs
+    //!< Header Extension Object GUIDs
     {{0x14E6A5CB, 0xC672, 0x4332, {0x83, 0x99, 0xA9, 0x69, 0x52, 0x06, 0x5B, 0x5A}}, "Extended_Stream_Properties"},
     {{0xA08649CF, 0x4775, 0x4670, {0x8A, 0x16, 0x6E, 0x35, 0x35, 0x75, 0x66, 0xCD}}, "Advanced_Mutual_Exclusion"},
     {{0xD1465A40, 0x5A79, 0x4338, {0xB7, 0x1B, 0xE3, 0x6B, 0x8F, 0xD6, 0xC2, 0x49}}, "Group_Mutual_Exclusion"},
@@ -136,7 +136,7 @@ const std::map<AsfVideo::GUIDTag, std::string> GUIDReferenceTags = {
     {{0x26F18B5D, 0x4584, 0x47EC, {0x9F, 0x5F, 0x0E, 0x65, 0x1F, 0x04, 0x52, 0xC9}}, "Compatibility"},
     {{0x43058533, 0x6981, 0x49E6, {0x9B, 0x74, 0xAD, 0x12, 0xCB, 0x86, 0xD5, 0x8C}}, "Advanced_Content_Encryption"},
 
-    ///< Stream Properties Object Stream Type GUIDs
+    //!< Stream Properties Object Stream Type GUIDs
     {{0xF8699E40, 0x5B4D, 0x11CF, {0xA8, 0xFD, 0x00, 0x80, 0x5F, 0x5C, 0x44, 0x2B}}, "Audio_Media"},
     {{0xBC19EFC0, 0x5B4D, 0x11CF, {0xA8, 0xFD, 0x00, 0x80, 0x5F, 0x5C, 0x44, 0x2B}}, "Video_Media"},
     {{0x59DACFC0, 0x59E6, 0x11D0, {0xA3, 0xAC, 0x00, 0xA0, 0xC9, 0x03, 0x48, 0xF6}}, "Command_Media"},
@@ -145,38 +145,38 @@ const std::map<AsfVideo::GUIDTag, std::string> GUIDReferenceTags = {
     {{0x91BD222C, 0xF21C, 0x497A, {0x8B, 0x6D, 0x5A, 0xA8, 0x6B, 0xFC, 0x01, 0x85}}, "File_Transfer_Media"},
     {{0x3AFB65E2, 0x47EF, 0x40F2, {0xAC, 0x2C, 0x70, 0xA9, 0x0D, 0x71, 0xD3, 0x43}}, "Binary_Media"},
 
-    ///< Web stream Type-Specific Data GUIDs
+    //!< Web stream Type-Specific Data GUIDs
     {{0x776257D4, 0xC627, 0x41CB, {0x8F, 0x81, 0x7A, 0xC7, 0xFF, 0x1C, 0x40, 0xCC}}, "Web_Stream_Media_Subtype"},
     {{0xDA1E6B13, 0x8359, 0x4050, {0xB3, 0x98, 0x38, 0x8E, 0x96, 0x5B, 0xF0, 0x0C}}, "Web_Stream_Format"},
 
-    ///< Stream Properties Object Error Correction Type GUIDs
+    //!< Stream Properties Object Error Correction Type GUIDs
     {{0x20FB5700, 0x5B55, 0x11CF, {0xA8, 0xFD, 0x00, 0x80, 0x5F, 0x5C, 0x44, 0x2B}}, "No_Error_Correction"},
     {{0xBFC3CD50, 0x618F, 0x11CF, {0x8B, 0xB2, 0x00, 0xAA, 0x00, 0xB4, 0xE2, 0x20}}, "Audio_Spread"},
-    ///< Header Extension Object GUIDs
+    //!< Header Extension Object GUIDs
     {{0xABD3D211, 0xA9BA, 0x11CF, {0x8E, 0xE6, 0x00, 0xC0, 0x0C, 0x20, 0x53, 0x65}}, "Reserved_1"},
 
-    ///< Advanced Content Encryption Object System ID GUIDs
+    //!< Advanced Content Encryption Object System ID GUIDs
     {{0x7A079BB6, 0xDAA4, 0x4E12, {0xA5, 0xCA, 0x91, 0xD3, 0x8D, 0xC1, 0x1A, 0x8D}},
      "Content_Encryption_System_Windows_Media_DRM_Network_Devices"},
 
-    ///< Codec List Object GUIDs
+    //!< Codec List Object GUIDs
     {{0x86D15241, 0x311D, 0x11D0, {0xA3, 0xA4, 0x00, 0xA0, 0xC9, 0x03, 0x48, 0xF6}}, "Reserved_2"},
 
-    ///< Script Command Object GUIDs
+    //!< Script Command Object GUIDs
     {{0x4B1ACBE3, 0x100B, 0x11D0, {0xA3, 0x9B, 0x00, 0xA0, 0xC9, 0x03, 0x48, 0xF6}}, "Reserved_3"},
 
-    ///< Marker Object GUIDs
+    //!< Marker Object GUIDs
     {{0x4CFEDB20, 0x75F6, 0x11CF, {0x9C, 0x0F, 0x00, 0xA0, 0xC9, 0x03, 0x49, 0xCB}}, "Reserved_4"},
 
-    ///< Mutual Exclusion Object Exclusion Type GUIDs
+    //!< Mutual Exclusion Object Exclusion Type GUIDs
     {{0xD6E22A00, 0x35DA, 0x11D1, {0x90, 0x34, 0x00, 0xA0, 0xC9, 0x03, 0x49, 0xBE}}, "Mutex_Language"},
     {{0xD6E22A01, 0x35DA, 0x11D1, {0x90, 0x34, 0x00, 0xA0, 0xC9, 0x03, 0x49, 0xBE}}, "Mutex_Bitrate"},
     {{0xD6E22A02, 0x35DA, 0x11D1, {0x90, 0x34, 0x00, 0xA0, 0xC9, 0x03, 0x49, 0xBE}}, "Mutex_Unknown"},
-    ///< Bandwidth Sharing Object GUID
+    //!< Bandwidth Sharing Object GUID
     {{0xAF6060AA, 0x5197, 0x11D2, {0xB6, 0xAF, 0x00, 0xC0, 0x4F, 0xD9, 0x08, 0xE9}}, "Bandwidth_Sharing_Exclusive"},
     {{0xAF6060AB, 0x5197, 0x11D2, {0xB6, 0xAF, 0x00, 0xC0, 0x4F, 0xD9, 0x08, 0xE9}}, "Bandwidth_Sharing_Partial"},
 
-    ///< Standard Payload Extension System GUIDs
+    //!< Standard Payload Extension System GUIDs
     {{0x399595EC, 0x8667, 0x4E2D, {0x8F, 0xDB, 0x98, 0x81, 0x4C, 0xE7, 0x6C, 0x1E}},
      "Payload_Extension_System_Timecode"},
     {{0xE165EC0E, 0x19ED, 0x45D7, {0xB4, 0xA7, 0x25, 0xCB, 0xD1, 0xE2, 0x8E, 0x9B}},

src/basicio.cpp

@@ -51,7 +51,7 @@ namespace fs = std::experimental::filesystem;
 // *****************************************************************************
 // class member definitions
 namespace {
-///< @brief replace each substring of the subject that matches the given search string with the given replacement.
+/// @brief replace each substring of the subject that matches the given search string with the given replacement.
 void ReplaceStringInPlace(std::string& subject, std::string_view search, std::string_view replace) {
   auto pos = subject.find(search);
   while (pos != std::string::npos) {

src/bmffimage.cpp

@@ -28,40 +28,40 @@
 #include <string>
 
 enum {
-  TAG_ftyp = 0x66747970U,  ///< "ftyp" File type box */
-  TAG_avif = 0x61766966U,  ///< "avif" AVIF */
-  TAG_avio = 0x6176696fU,  ///< "avio" AVIF */
-  TAG_avis = 0x61766973U,  ///< "avis" AVIF */
-  TAG_heic = 0x68656963U,  ///< "heic" HEIC */
-  TAG_heif = 0x68656966U,  ///< "heif" HEIF */
-  TAG_heim = 0x6865696dU,  ///< "heim" HEIC */
-  TAG_heis = 0x68656973U,  ///< "heis" HEIC */
-  TAG_heix = 0x68656978U,  ///< "heix" HEIC */
-  TAG_mif1 = 0x6d696631U,  ///< "mif1" HEIF */
-  TAG_crx = 0x63727820U,   ///< "crx " Canon CR3 */
-  TAG_jxl = 0x6a786c20U,   ///< "jxl " JPEG XL file type */
-  TAG_moov = 0x6d6f6f76U,  ///< "moov" Movie */
-  TAG_meta = 0x6d657461U,  ///< "meta" Metadata */
-  TAG_mdat = 0x6d646174U,  ///< "mdat" Media data */
-  TAG_uuid = 0x75756964U,  ///< "uuid" UUID */
-  TAG_dinf = 0x64696e66U,  ///< "dinf" Data information */
-  TAG_iprp = 0x69707270U,  ///< "iprp" Item properties */
-  TAG_ipco = 0x6970636fU,  ///< "ipco" Item property container */
-  TAG_iinf = 0x69696e66U,  ///< "iinf" Item info */
-  TAG_iloc = 0x696c6f63U,  ///< "iloc" Item location */
-  TAG_ispe = 0x69737065U,  ///< "ispe" Image spatial extents */
-  TAG_infe = 0x696e6665U,  ///< "infe" Item Info Extension */
-  TAG_ipma = 0x69706d61U,  ///< "ipma" Item Property Association */
-  TAG_cmt1 = 0x434d5431U,  ///< "CMT1" ifd0Id */
-  TAG_cmt2 = 0x434D5432U,  ///< "CMD2" exifID */
-  TAG_cmt3 = 0x434D5433U,  ///< "CMT3" canonID */
-  TAG_cmt4 = 0x434D5434U,  ///< "CMT4" gpsID */
-  TAG_colr = 0x636f6c72U,  ///< "colr" Colour information */
-  TAG_exif = 0x45786966U,  ///< "Exif" Used by JXL */
-  TAG_xml = 0x786d6c20U,   ///< "xml " Used by JXL */
-  TAG_brob = 0x62726f62U,  ///< "brob" Used by JXL (brotli box) */
-  TAG_thmb = 0x54484d42U,  ///< "THMB" Canon thumbnail */
-  TAG_prvw = 0x50525657U,  ///< "PRVW" Canon preview image */
+  TAG_ftyp = 0x66747970U,  //!< "ftyp" File type box */
+  TAG_avif = 0x61766966U,  //!< "avif" AVIF */
+  TAG_avio = 0x6176696fU,  //!< "avio" AVIF */
+  TAG_avis = 0x61766973U,  //!< "avis" AVIF */
+  TAG_heic = 0x68656963U,  //!< "heic" HEIC */
+  TAG_heif = 0x68656966U,  //!< "heif" HEIF */
+  TAG_heim = 0x6865696dU,  //!< "heim" HEIC */
+  TAG_heis = 0x68656973U,  //!< "heis" HEIC */
+  TAG_heix = 0x68656978U,  //!< "heix" HEIC */
+  TAG_mif1 = 0x6d696631U,  //!< "mif1" HEIF */
+  TAG_crx = 0x63727820U,   //!< "crx " Canon CR3 */
+  TAG_jxl = 0x6a786c20U,   //!< "jxl " JPEG XL file type */
+  TAG_moov = 0x6d6f6f76U,  //!< "moov" Movie */
+  TAG_meta = 0x6d657461U,  //!< "meta" Metadata */
+  TAG_mdat = 0x6d646174U,  //!< "mdat" Media data */
+  TAG_uuid = 0x75756964U,  //!< "uuid" UUID */
+  TAG_dinf = 0x64696e66U,  //!< "dinf" Data information */
+  TAG_iprp = 0x69707270U,  //!< "iprp" Item properties */
+  TAG_ipco = 0x6970636fU,  //!< "ipco" Item property container */
+  TAG_iinf = 0x69696e66U,  //!< "iinf" Item info */
+  TAG_iloc = 0x696c6f63U,  //!< "iloc" Item location */
+  TAG_ispe = 0x69737065U,  //!< "ispe" Image spatial extents */
+  TAG_infe = 0x696e6665U,  //!< "infe" Item Info Extension */
+  TAG_ipma = 0x69706d61U,  //!< "ipma" Item Property Association */
+  TAG_cmt1 = 0x434d5431U,  //!< "CMT1" ifd0Id */
+  TAG_cmt2 = 0x434D5432U,  //!< "CMD2" exifID */
+  TAG_cmt3 = 0x434D5433U,  //!< "CMT3" canonID */
+  TAG_cmt4 = 0x434D5434U,  //!< "CMT4" gpsID */
+  TAG_colr = 0x636f6c72U,  //!< "colr" Colour information */
+  TAG_exif = 0x45786966U,  //!< "Exif" Used by JXL */
+  TAG_xml = 0x786d6c20U,   //!< "xml " Used by JXL */
+  TAG_brob = 0x62726f62U,  //!< "brob" Used by JXL (brotli box) */
+  TAG_thmb = 0x54484d42U,  //!< "THMB" Canon thumbnail */
+  TAG_prvw = 0x50525657U,  //!< "PRVW" Canon preview image */
 };
 
 // *****************************************************************************

src/convert.cpp

@@ -272,7 +272,7 @@ class Converter {
   std::string computeExifDigest(bool tiff);
 
   // DATA
-  static const Conversion conversion_[];  ///< Conversion rules
+  static const Conversion conversion_[];  //!< Conversion rules
   bool erase_{false};
   bool overwrite_{true};
   ExifData* exifData_;

src/futils.cpp

@@ -59,11 +59,11 @@ namespace Exiv2 {
 constexpr std::array<const char*, 2> ENVARDEF{
     "/exiv2.php",
     "40",
-};  //!< @brief default URL for http exiv2 handler and time-out
+};  /// @brief default URL for http exiv2 handler and time-out
 constexpr std::array<const char*, 2> ENVARKEY{
     "EXIV2_HTTP_POST",
     "EXIV2_TIMEOUT",
-};  //!< @brief request keys for http exiv2 handler and time-out
+};  /// @brief request keys for http exiv2 handler and time-out
 
 // *****************************************************************************
 // free functions

src/jp2image_int.hpp

@@ -17,10 +17,10 @@ struct Jp2ImageHeaderBox {
   uint32_t imageHeight;
   uint32_t imageWidth;
   uint16_t componentCount;
-  uint8_t bpc;   ///< Bits per component
-  uint8_t c;     ///< Compression type
-  uint8_t unkC;  ///< Colourspace unknown
-  uint8_t ipr;   ///< Intellectual property
+  uint8_t bpc;   //!< Bits per component
+  uint8_t c;     //!< Compression type
+  uint8_t unkC;  //!< Colourspace unknown
+  uint8_t ipr;   //!< Intellectual property
 };
 
 struct Jp2UuidBox {

src/jpgimage.cpp

@@ -43,7 +43,7 @@ constexpr byte app13_ = 0xed;  //!< JPEG APP13 marker
 constexpr byte com_ = 0xfe;    //!< JPEG Comment marker
 
 // Markers without payload
-constexpr byte soi_ = 0xd8;   ///!< SOI marker
+constexpr byte soi_ = 0xd8;   //!< SOI marker
 constexpr byte eoi_ = 0xd9;   //!< JPEG EOI marker
 constexpr byte rst1_ = 0xd0;  //!< JPEG Restart 0 Marker (from 0xD0 to 0xD7 there might be 8 of these markers)
 

src/makernote_int.hpp

@@ -85,7 +85,7 @@ class TiffMnCreator {
   TiffMnCreator& operator=(const TiffComponent&) = delete;
 
  private:
-  static const TiffMnRegistry registry_[];  ///< List of makernotes
+  static const TiffMnRegistry registry_[];  //!< List of makernotes
 };
 
 //! Makernote header interface. This class is used with TIFF makernotes.

src/orfimage_int.hpp

@@ -35,7 +35,7 @@ class OrfHeader : public TiffHeaderBase {
   //@}
  private:
   // DATA
-  uint16_t sig_{0x4f52};  ///< The actual magic number
+  uint16_t sig_{0x4f52};  //!< The actual magic number
 };
 
 }  // namespace Exiv2::Internal

src/tiffimage_int.hpp

@@ -172,8 +172,8 @@ class TiffCreator {
   static TiffPath getPath(uint32_t extendedTag, IfdId group, uint32_t root);
 
  private:
-  static const TiffTreeTable tiffTreeTable_;    ///< TIFF tree structure
-  static const TiffGroupTable tiffGroupTable_;  ///< TIFF group structure
+  static const TiffTreeTable tiffTreeTable_;    //!< TIFF tree structure
+  static const TiffGroupTable tiffGroupTable_;  //!< TIFF group structure
 };
 
 /*!
@@ -283,7 +283,7 @@ class TiffMapping {
   static EncoderFct findEncoder(const std::string& make, uint32_t extendedTag, IfdId group);
 
  private:
-  static const TiffMappingInfo tiffMappingInfo_[];  ///< TIFF mapping table
+  static const TiffMappingInfo tiffMappingInfo_[];  //!< TIFF mapping table
 };
 
 /*!