Skip to content

Commit fa41d9d

Browse files
nehebneheb
committed
fix Doxygen comments to be more consistent
Signed-off-by: Rosen Penev <[email protected]>
1 parent ae6c02e commit fa41d9d

File tree

12 files changed

+68
-68
lines changed

12 files changed

+68
-68
lines changed

‎include/exiv2/image_types.hpp‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,30 +11,30 @@ enum class ImageType {
1111
asf,
1212
bigtiff,
1313
bmff,
14-
bmp, ///< Windows bitmap
14+
bmp, //!< Windows bitmap
1515
cr2,
1616
crw,
1717
dng,
1818
eps,
1919
exv,
20-
gif, ///< GIF
21-
jp2, ///< JPEG-2000
20+
gif, //!< GIF
21+
jp2, //!< JPEG-2000
2222
jpeg,
2323
mrw,
2424
nef,
2525
orf,
2626
pef,
2727
png,
2828
pgf,
29-
psd, ///< Photoshop (PSD)
29+
psd, //!< Photoshop (PSD)
3030
raf,
3131
rw2,
3232
sr2,
3333
srw,
3434
tga,
3535
tiff,
3636
webp,
37-
xmp, ///< XMP sidecar files
37+
xmp, //!< XMP sidecar files
3838
qtime,
3939
riff,
4040
mkv,

‎include/exiv2/jpgimage.hpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ class EXIV2API JpegImage : public JpegBase {
175175

176176
private:
177177
// Constant data
178-
static const byte blank_[]; ///< Minimal Jpeg image
178+
static const byte blank_[]; //!< Minimal Jpeg image
179179
};
180180

181181
//! Helper class to access %Exiv2 files

‎src/asfvideo.cpp‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -95,15 +95,15 @@ bool AsfVideo::GUIDTag::operator<(const GUIDTag& other) const {
9595
const AsfVideo::GUIDTag Header(0x75B22630, 0x668E, 0x11CF, {0xA6, 0xD9, 0x00, 0xAA, 0x00, 0x62, 0xCE, 0x6C});
9696

9797
const std::map<AsfVideo::GUIDTag, std::string> GUIDReferenceTags = {
98-
///< Top-level ASF object GUIDS
98+
//!< Top-level ASF object GUIDS
9999
{Header, "Header"},
100100
{{0x75B22636, 0x668E, 0x11CF, {0xA6, 0xD9, 0x00, 0xAA, 0x00, 0x62, 0xCE, 0x6C}}, "Data"},
101101
{{0x33000890, 0xE5B1, 0x11CF, {0x89, 0xF4, 0x00, 0xA0, 0xC9, 0x03, 0x49, 0xCB}}, "Simple_Index"},
102102
{{0xD6E229D3, 0x35DA, 0x11D1, {0x90, 0x34, 0x00, 0xA0, 0xC9, 0x03, 0x49, 0xBE}}, "Index"},
103103
{{0xFEB103F8, 0x12AD, 0x4C64, {0x84, 0x0F, 0x2A, 0x1D, 0x2F, 0x7A, 0xD4, 0x8C}}, "Media_Index"},
104104
{{0x3CB73FD0, 0x0C4A, 0x4803, {0x95, 0x3D, 0xED, 0xF7, 0xB6, 0x22, 0x8F, 0x0C}}, "Timecode_Index"},
105105

106-
///< Header Object GUIDs
106+
//!< Header Object GUIDs
107107
{{0x8CABDCA1, 0xA947, 0x11CF, {0x8E, 0xE4, 0x00, 0xC0, 0x0C, 0x20, 0x53, 0x65}}, "File_Properties"},
108108
{{0xB7DC0791, 0xA9B7, 0x11CF, {0x8E, 0xE6, 0x00, 0xC0, 0x0C, 0x20, 0x53, 0x65}}, "Stream_Properties"},
109109
{{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 = {
121121
{{0x2211B3FC, 0xBD23, 0x11D2, {0xB4, 0xB7, 0x00, 0xA0, 0xC9, 0x55, 0xFC, 0x6E}}, "Digital_Signature"},
122122
{{0x1806D474, 0xCADF, 0x4509, {0xA4, 0xBA, 0x9A, 0xAB, 0xCB, 0x96, 0xAA, 0xE8}}, "Padding"},
123123

124-
///< Header Extension Object GUIDs
124+
//!< Header Extension Object GUIDs
125125
{{0x14E6A5CB, 0xC672, 0x4332, {0x83, 0x99, 0xA9, 0x69, 0x52, 0x06, 0x5B, 0x5A}}, "Extended_Stream_Properties"},
126126
{{0xA08649CF, 0x4775, 0x4670, {0x8A, 0x16, 0x6E, 0x35, 0x35, 0x75, 0x66, 0xCD}}, "Advanced_Mutual_Exclusion"},
127127
{{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 = {
136136
{{0x26F18B5D, 0x4584, 0x47EC, {0x9F, 0x5F, 0x0E, 0x65, 0x1F, 0x04, 0x52, 0xC9}}, "Compatibility"},
137137
{{0x43058533, 0x6981, 0x49E6, {0x9B, 0x74, 0xAD, 0x12, 0xCB, 0x86, 0xD5, 0x8C}}, "Advanced_Content_Encryption"},
138138

139-
///< Stream Properties Object Stream Type GUIDs
139+
//!< Stream Properties Object Stream Type GUIDs
140140
{{0xF8699E40, 0x5B4D, 0x11CF, {0xA8, 0xFD, 0x00, 0x80, 0x5F, 0x5C, 0x44, 0x2B}}, "Audio_Media"},
141141
{{0xBC19EFC0, 0x5B4D, 0x11CF, {0xA8, 0xFD, 0x00, 0x80, 0x5F, 0x5C, 0x44, 0x2B}}, "Video_Media"},
142142
{{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 = {
145145
{{0x91BD222C, 0xF21C, 0x497A, {0x8B, 0x6D, 0x5A, 0xA8, 0x6B, 0xFC, 0x01, 0x85}}, "File_Transfer_Media"},
146146
{{0x3AFB65E2, 0x47EF, 0x40F2, {0xAC, 0x2C, 0x70, 0xA9, 0x0D, 0x71, 0xD3, 0x43}}, "Binary_Media"},
147147

148-
///< Web stream Type-Specific Data GUIDs
148+
//!< Web stream Type-Specific Data GUIDs
149149
{{0x776257D4, 0xC627, 0x41CB, {0x8F, 0x81, 0x7A, 0xC7, 0xFF, 0x1C, 0x40, 0xCC}}, "Web_Stream_Media_Subtype"},
150150
{{0xDA1E6B13, 0x8359, 0x4050, {0xB3, 0x98, 0x38, 0x8E, 0x96, 0x5B, 0xF0, 0x0C}}, "Web_Stream_Format"},
151151

152-
///< Stream Properties Object Error Correction Type GUIDs
152+
//!< Stream Properties Object Error Correction Type GUIDs
153153
{{0x20FB5700, 0x5B55, 0x11CF, {0xA8, 0xFD, 0x00, 0x80, 0x5F, 0x5C, 0x44, 0x2B}}, "No_Error_Correction"},
154154
{{0xBFC3CD50, 0x618F, 0x11CF, {0x8B, 0xB2, 0x00, 0xAA, 0x00, 0xB4, 0xE2, 0x20}}, "Audio_Spread"},
155-
///< Header Extension Object GUIDs
155+
//!< Header Extension Object GUIDs
156156
{{0xABD3D211, 0xA9BA, 0x11CF, {0x8E, 0xE6, 0x00, 0xC0, 0x0C, 0x20, 0x53, 0x65}}, "Reserved_1"},
157157

158-
///< Advanced Content Encryption Object System ID GUIDs
158+
//!< Advanced Content Encryption Object System ID GUIDs
159159
{{0x7A079BB6, 0xDAA4, 0x4E12, {0xA5, 0xCA, 0x91, 0xD3, 0x8D, 0xC1, 0x1A, 0x8D}},
160160
"Content_Encryption_System_Windows_Media_DRM_Network_Devices"},
161161

162-
///< Codec List Object GUIDs
162+
//!< Codec List Object GUIDs
163163
{{0x86D15241, 0x311D, 0x11D0, {0xA3, 0xA4, 0x00, 0xA0, 0xC9, 0x03, 0x48, 0xF6}}, "Reserved_2"},
164164

165-
///< Script Command Object GUIDs
165+
//!< Script Command Object GUIDs
166166
{{0x4B1ACBE3, 0x100B, 0x11D0, {0xA3, 0x9B, 0x00, 0xA0, 0xC9, 0x03, 0x48, 0xF6}}, "Reserved_3"},
167167

168-
///< Marker Object GUIDs
168+
//!< Marker Object GUIDs
169169
{{0x4CFEDB20, 0x75F6, 0x11CF, {0x9C, 0x0F, 0x00, 0xA0, 0xC9, 0x03, 0x49, 0xCB}}, "Reserved_4"},
170170

171-
///< Mutual Exclusion Object Exclusion Type GUIDs
171+
//!< Mutual Exclusion Object Exclusion Type GUIDs
172172
{{0xD6E22A00, 0x35DA, 0x11D1, {0x90, 0x34, 0x00, 0xA0, 0xC9, 0x03, 0x49, 0xBE}}, "Mutex_Language"},
173173
{{0xD6E22A01, 0x35DA, 0x11D1, {0x90, 0x34, 0x00, 0xA0, 0xC9, 0x03, 0x49, 0xBE}}, "Mutex_Bitrate"},
174174
{{0xD6E22A02, 0x35DA, 0x11D1, {0x90, 0x34, 0x00, 0xA0, 0xC9, 0x03, 0x49, 0xBE}}, "Mutex_Unknown"},
175-
///< Bandwidth Sharing Object GUID
175+
//!< Bandwidth Sharing Object GUID
176176
{{0xAF6060AA, 0x5197, 0x11D2, {0xB6, 0xAF, 0x00, 0xC0, 0x4F, 0xD9, 0x08, 0xE9}}, "Bandwidth_Sharing_Exclusive"},
177177
{{0xAF6060AB, 0x5197, 0x11D2, {0xB6, 0xAF, 0x00, 0xC0, 0x4F, 0xD9, 0x08, 0xE9}}, "Bandwidth_Sharing_Partial"},
178178

179-
///< Standard Payload Extension System GUIDs
179+
//!< Standard Payload Extension System GUIDs
180180
{{0x399595EC, 0x8667, 0x4E2D, {0x8F, 0xDB, 0x98, 0x81, 0x4C, 0xE7, 0x6C, 0x1E}},
181181
"Payload_Extension_System_Timecode"},
182182
{{0xE165EC0E, 0x19ED, 0x45D7, {0xB4, 0xA7, 0x25, 0xCB, 0xD1, 0xE2, 0x8E, 0x9B}},

‎src/basicio.cpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ namespace fs = std::experimental::filesystem;
5151
// *****************************************************************************
5252
// class member definitions
5353
namespace {
54-
///< @brief replace each substring of the subject that matches the given search string with the given replacement.
54+
/// @brief replace each substring of the subject that matches the given search string with the given replacement.
5555
void ReplaceStringInPlace(std::string& subject, std::string_view search, std::string_view replace) {
5656
auto pos = subject.find(search);
5757
while (pos != std::string::npos) {

‎src/bmffimage.cpp‎

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -28,40 +28,40 @@
2828
#include <string>
2929

3030
enum {
31-
TAG_ftyp = 0x66747970U, ///< "ftyp" File type box */
32-
TAG_avif = 0x61766966U, ///< "avif" AVIF */
33-
TAG_avio = 0x6176696fU, ///< "avio" AVIF */
34-
TAG_avis = 0x61766973U, ///< "avis" AVIF */
35-
TAG_heic = 0x68656963U, ///< "heic" HEIC */
36-
TAG_heif = 0x68656966U, ///< "heif" HEIF */
37-
TAG_heim = 0x6865696dU, ///< "heim" HEIC */
38-
TAG_heis = 0x68656973U, ///< "heis" HEIC */
39-
TAG_heix = 0x68656978U, ///< "heix" HEIC */
40-
TAG_mif1 = 0x6d696631U, ///< "mif1" HEIF */
41-
TAG_crx = 0x63727820U, ///< "crx " Canon CR3 */
42-
TAG_jxl = 0x6a786c20U, ///< "jxl " JPEG XL file type */
43-
TAG_moov = 0x6d6f6f76U, ///< "moov" Movie */
44-
TAG_meta = 0x6d657461U, ///< "meta" Metadata */
45-
TAG_mdat = 0x6d646174U, ///< "mdat" Media data */
46-
TAG_uuid = 0x75756964U, ///< "uuid" UUID */
47-
TAG_dinf = 0x64696e66U, ///< "dinf" Data information */
48-
TAG_iprp = 0x69707270U, ///< "iprp" Item properties */
49-
TAG_ipco = 0x6970636fU, ///< "ipco" Item property container */
50-
TAG_iinf = 0x69696e66U, ///< "iinf" Item info */
51-
TAG_iloc = 0x696c6f63U, ///< "iloc" Item location */
52-
TAG_ispe = 0x69737065U, ///< "ispe" Image spatial extents */
53-
TAG_infe = 0x696e6665U, ///< "infe" Item Info Extension */
54-
TAG_ipma = 0x69706d61U, ///< "ipma" Item Property Association */
55-
TAG_cmt1 = 0x434d5431U, ///< "CMT1" ifd0Id */
56-
TAG_cmt2 = 0x434D5432U, ///< "CMD2" exifID */
57-
TAG_cmt3 = 0x434D5433U, ///< "CMT3" canonID */
58-
TAG_cmt4 = 0x434D5434U, ///< "CMT4" gpsID */
59-
TAG_colr = 0x636f6c72U, ///< "colr" Colour information */
60-
TAG_exif = 0x45786966U, ///< "Exif" Used by JXL */
61-
TAG_xml = 0x786d6c20U, ///< "xml " Used by JXL */
62-
TAG_brob = 0x62726f62U, ///< "brob" Used by JXL (brotli box) */
63-
TAG_thmb = 0x54484d42U, ///< "THMB" Canon thumbnail */
64-
TAG_prvw = 0x50525657U, ///< "PRVW" Canon preview image */
31+
TAG_ftyp = 0x66747970U, //!< "ftyp" File type box */
32+
TAG_avif = 0x61766966U, //!< "avif" AVIF */
33+
TAG_avio = 0x6176696fU, //!< "avio" AVIF */
34+
TAG_avis = 0x61766973U, //!< "avis" AVIF */
35+
TAG_heic = 0x68656963U, //!< "heic" HEIC */
36+
TAG_heif = 0x68656966U, //!< "heif" HEIF */
37+
TAG_heim = 0x6865696dU, //!< "heim" HEIC */
38+
TAG_heis = 0x68656973U, //!< "heis" HEIC */
39+
TAG_heix = 0x68656978U, //!< "heix" HEIC */
40+
TAG_mif1 = 0x6d696631U, //!< "mif1" HEIF */
41+
TAG_crx = 0x63727820U, //!< "crx " Canon CR3 */
42+
TAG_jxl = 0x6a786c20U, //!< "jxl " JPEG XL file type */
43+
TAG_moov = 0x6d6f6f76U, //!< "moov" Movie */
44+
TAG_meta = 0x6d657461U, //!< "meta" Metadata */
45+
TAG_mdat = 0x6d646174U, //!< "mdat" Media data */
46+
TAG_uuid = 0x75756964U, //!< "uuid" UUID */
47+
TAG_dinf = 0x64696e66U, //!< "dinf" Data information */
48+
TAG_iprp = 0x69707270U, //!< "iprp" Item properties */
49+
TAG_ipco = 0x6970636fU, //!< "ipco" Item property container */
50+
TAG_iinf = 0x69696e66U, //!< "iinf" Item info */
51+
TAG_iloc = 0x696c6f63U, //!< "iloc" Item location */
52+
TAG_ispe = 0x69737065U, //!< "ispe" Image spatial extents */
53+
TAG_infe = 0x696e6665U, //!< "infe" Item Info Extension */
54+
TAG_ipma = 0x69706d61U, //!< "ipma" Item Property Association */
55+
TAG_cmt1 = 0x434d5431U, //!< "CMT1" ifd0Id */
56+
TAG_cmt2 = 0x434D5432U, //!< "CMD2" exifID */
57+
TAG_cmt3 = 0x434D5433U, //!< "CMT3" canonID */
58+
TAG_cmt4 = 0x434D5434U, //!< "CMT4" gpsID */
59+
TAG_colr = 0x636f6c72U, //!< "colr" Colour information */
60+
TAG_exif = 0x45786966U, //!< "Exif" Used by JXL */
61+
TAG_xml = 0x786d6c20U, //!< "xml " Used by JXL */
62+
TAG_brob = 0x62726f62U, //!< "brob" Used by JXL (brotli box) */
63+
TAG_thmb = 0x54484d42U, //!< "THMB" Canon thumbnail */
64+
TAG_prvw = 0x50525657U, //!< "PRVW" Canon preview image */
6565
};
6666

6767
// *****************************************************************************

‎src/convert.cpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ class Converter {
272272
std::string computeExifDigest(bool tiff);
273273

274274
// DATA
275-
static const Conversion conversion_[]; ///< Conversion rules
275+
static const Conversion conversion_[]; //!< Conversion rules
276276
bool erase_{false};
277277
bool overwrite_{true};
278278
ExifData* exifData_;

‎src/futils.cpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,11 @@ namespace Exiv2 {
5959
constexpr std::array<const char*, 2> ENVARDEF{
6060
"/exiv2.php",
6161
"40",
62-
}; //!< @brief default URL for http exiv2 handler and time-out
62+
}; /// @brief default URL for http exiv2 handler and time-out
6363
constexpr std::array<const char*, 2> ENVARKEY{
6464
"EXIV2_HTTP_POST",
6565
"EXIV2_TIMEOUT",
66-
}; //!< @brief request keys for http exiv2 handler and time-out
66+
}; /// @brief request keys for http exiv2 handler and time-out
6767

6868
// *****************************************************************************
6969
// free functions

‎src/jp2image_int.hpp‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ struct Jp2ImageHeaderBox {
1717
uint32_t imageHeight;
1818
uint32_t imageWidth;
1919
uint16_t componentCount;
20-
uint8_t bpc; ///< Bits per component
21-
uint8_t c; ///< Compression type
22-
uint8_t unkC; ///< Colourspace unknown
23-
uint8_t ipr; ///< Intellectual property
20+
uint8_t bpc; //!< Bits per component
21+
uint8_t c; //!< Compression type
22+
uint8_t unkC; //!< Colourspace unknown
23+
uint8_t ipr; //!< Intellectual property
2424
};
2525

2626
struct Jp2UuidBox {

‎src/jpgimage.cpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ constexpr byte app13_ = 0xed; //!< JPEG APP13 marker
4343
constexpr byte com_ = 0xfe; //!< JPEG Comment marker
4444

4545
// Markers without payload
46-
constexpr byte soi_ = 0xd8; ///!< SOI marker
46+
constexpr byte soi_ = 0xd8; //!< SOI marker
4747
constexpr byte eoi_ = 0xd9; //!< JPEG EOI marker
4848
constexpr byte rst1_ = 0xd0; //!< JPEG Restart 0 Marker (from 0xD0 to 0xD7 there might be 8 of these markers)
4949

‎src/makernote_int.hpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ class TiffMnCreator {
8585
TiffMnCreator& operator=(const TiffComponent&) = delete;
8686

8787
private:
88-
static const TiffMnRegistry registry_[]; ///< List of makernotes
88+
static const TiffMnRegistry registry_[]; //!< List of makernotes
8989
};
9090

9191
//! Makernote header interface. This class is used with TIFF makernotes.

0 commit comments

Comments
 (0)