diff --git a/include/exiv2/asfvideo.hpp b/include/exiv2/asfvideo.hpp index 8b56d0bc..fa5efc15 100644 --- a/include/exiv2/asfvideo.hpp +++ b/include/exiv2/asfvideo.hpp @@ -135,7 +135,6 @@ class EXIV2API AsfVideo : public Image { /*! @brief Interpret Content_Description tag information, and save it in the respective XMP container. - @param size Size of the data block used to store Tag Data. */ void contentDescription(); /*! diff --git a/include/exiv2/bmffimage.hpp b/include/exiv2/bmffimage.hpp index df91095c..92ffa666 100644 --- a/include/exiv2/bmffimage.hpp +++ b/include/exiv2/bmffimage.hpp @@ -60,6 +60,7 @@ class EXIV2API BmffImage : public Image { //@} //@{ + void parseTiff(uint32_t root_tag, uint64_t length); /*! @brief parse embedded tiff file (Exif metadata) @param root_tag root of parse tree Tag::root, Tag::cmt2 etc. @@ -67,7 +68,6 @@ class EXIV2API BmffImage : public Image { @param start offset in file (default, io_->tell()) @ */ - void parseTiff(uint32_t root_tag, uint64_t length); void parseTiff(uint32_t root_tag, uint64_t length, uint64_t start); //@} diff --git a/include/exiv2/futils.hpp b/include/exiv2/futils.hpp index 312391d9..46a29289 100644 --- a/include/exiv2/futils.hpp +++ b/include/exiv2/futils.hpp @@ -18,7 +18,7 @@ enum Protocol { pFile = 0, pHttp, pFtp, pHttps, pSftp, pFileUri, pDataUri, pStdi // free functions /*! @brief Return the value of environmental variable. - @param[in] var The name of environmental variable. Must be a member of the enumeration @ref EnVar. + @param[in] env_var The name of environmental variable. Must be a member of the enumeration @ref EnVar. @return the value of environmental variable. If it's empty, the default value is returned. @throws std::out_of_range when an unexpected EnVar is given as input. */ @@ -74,7 +74,6 @@ EXIV2API Protocol fileProtocol(const std::string& path); @brief Test if a file exists. @param path Name of file to verify. - @param ct Flag to check if path is a regular file. @return true if path exists and, if ct is set, is a regular file, else false. diff --git a/include/exiv2/jp2image.hpp b/include/exiv2/jp2image.hpp index b46fe41d..9fc41acb 100644 --- a/include/exiv2/jp2image.hpp +++ b/include/exiv2/jp2image.hpp @@ -68,16 +68,16 @@ class EXIV2API Jp2Image : public Image { /*! @brief Provides the main implementation of writeMetadata() by writing all buffered metadata to the provided BasicIo. - @param oIo BasicIo instance to write to (a temporary location). + @throw Error on input-output errors or when the image data is not valid. + @param outIo BasicIo instance to write to (a temporary location). - @return 4 if opening or writing to the associated BasicIo fails */ void doWriteMetadata(BasicIo& outIo); /*! @brief reformats the Jp2Header to store iccProfile - @param oldData DataBufRef to data in the file. - @param newData DataBufRef with updated data + @param boxBuf DataBufRef to data in the file. + @param outBuf DataBufRef with updated data */ void encodeJp2Header(const DataBuf& boxBuf, DataBuf& outBuf); //@} diff --git a/include/exiv2/jpgimage.hpp b/include/exiv2/jpgimage.hpp index 6c2c8953..770d3c27 100644 --- a/include/exiv2/jpgimage.hpp +++ b/include/exiv2/jpgimage.hpp @@ -100,9 +100,9 @@ class EXIV2API JpegBase : public Image { /*! @brief Provides the main implementation of writeMetadata() by writing all buffered metadata to the provided BasicIo. - @param oIo BasicIo instance to write to (a temporary location). + @throw Error on input-output errors or when the image data is not valid. + @param outIo BasicIo instance to write to (a temporary location). - @return 4 if opening or writing to the associated BasicIo fails */ void doWriteMetadata(BasicIo& outIo); //@} @@ -164,7 +164,7 @@ class EXIV2API JpegImage : public JpegBase { //@{ /*! @brief Writes a Jpeg header (aka signature) to the BasicIo instance. - @param oIo BasicIo instance that the header is written to. + @param outIo BasicIo instance that the header is written to. @return 0 if successful;
2 if the input image is invalid or can not be read;
4 if the temporary image can not be written to;
diff --git a/include/exiv2/matroskavideo.hpp b/include/exiv2/matroskavideo.hpp index f2f5bc6a..be26eb37 100644 --- a/include/exiv2/matroskavideo.hpp +++ b/include/exiv2/matroskavideo.hpp @@ -144,7 +144,7 @@ class EXIV2API MatroskaVideo : public Image { void decodeBlock(); /*! @brief Interpret tag information, and save it in the respective XMP container. - @param mt Pointer to current tag, + @param tag Pointer to current tag, @param buf Pointer to the memory area with the tag information. @param size Size of \em buf. */ diff --git a/include/exiv2/pgfimage.hpp b/include/exiv2/pgfimage.hpp index 7855d484..ffd74917 100644 --- a/include/exiv2/pgfimage.hpp +++ b/include/exiv2/pgfimage.hpp @@ -59,9 +59,9 @@ class EXIV2API PgfImage : public Image { /*! @brief Provides the main implementation of writeMetadata() by writing all buffered metadata to the provided BasicIo. - @param oIo BasicIo instance to write to (a temporary location). + @throw Error on input-output errors or when the image data is not valid. + @param outIo BasicIo instance to write to (a temporary location). - @return 4 if opening or writing to the associated BasicIo fails */ void doWriteMetadata(BasicIo& outIo); //! Read Magick number. Only version >= 6 is supported. diff --git a/include/exiv2/pngimage.hpp b/include/exiv2/pngimage.hpp index 16fd2384..723e4c0c 100644 --- a/include/exiv2/pngimage.hpp +++ b/include/exiv2/pngimage.hpp @@ -65,7 +65,7 @@ class EXIV2API PngImage : public Image { @brief Provides the main implementation of writeMetadata() by writing all buffered metadata to the provided BasicIo. @throw Error on input-output errors or when the image data is not valid. - @param oIo BasicIo instance to write to (a temporary location). + @param outIo BasicIo instance to write to (a temporary location). */ void doWriteMetadata(BasicIo& outIo); diff --git a/include/exiv2/psdimage.hpp b/include/exiv2/psdimage.hpp index 4d082444..8fe17b20 100644 --- a/include/exiv2/psdimage.hpp +++ b/include/exiv2/psdimage.hpp @@ -70,9 +70,9 @@ class EXIV2API PsdImage : public Image { /*! @brief Provides the main implementation of writeMetadata() by writing all buffered metadata to the provided BasicIo. + @throw Error on input-output errors or when the image data is not valid. @param outIo BasicIo instance to write to (a temporary location). - @return 4 if opening or writing to the associated BasicIo fails */ void doWriteMetadata(BasicIo& outIo); uint32_t writeExifData(const ExifData& exifData, BasicIo& out); diff --git a/include/exiv2/riffvideo.hpp b/include/exiv2/riffvideo.hpp index cbe4a18b..55d7d0a6 100644 --- a/include/exiv2/riffvideo.hpp +++ b/include/exiv2/riffvideo.hpp @@ -70,7 +70,6 @@ class EXIV2API RiffVideo : public Image { /*! @brief Interpret MainAVIHeader (avih) structure, and save it in the respective XMP container. - @param size Size of the data block used to store Tag Information. */ void readAviHeader(); @@ -81,52 +80,52 @@ class EXIV2API RiffVideo : public Image { /*! @brief Interpret stream header list element (strf), and save it in the respective XMP container. - @param size Size of the data block used to store Tag Information. + @param size_ Size of the data block used to store Tag Information. */ void readStreamFormat(uint64_t size_); /*! @brief Interpret Additional header data (strd), and save it in the respective XMP container. - @param size Size of the data block used to store Tag Information. + @param size_ Size of the data block used to store Tag Information. */ void readStreamData(uint64_t size_); /*! @brief Interpret stream header list element (strn) , and save it in the respective XMP container. - @param size Size of the data block used to store Tag Information. + @param size_ Size of the data block used to store Tag Information. */ void StreamName(uint64_t size_); /*! @brief Interpret INFO List Chunk, and save it in the respective XMP container. - @param size Size of the data block used to store Tag Information. + @param size_ Size of the data block used to store Tag Information. */ void readInfoListChunk(uint64_t size_); /*! @brief Interpret Riff Stream Data tag information, and save it in the respective XMP container. The Movi - Lists contain Video, Audio, Subtitle and (secondary) index data. Those can be grouped into rec - Lists. - @param size Size of the data block used to store Tag Information. + @param size_ Size of the data block used to store Tag Information. */ void readMoviList(uint64_t size_); /*! @brief Interpret Video Properties Header chunk, and save it in the respective XMP container. The video properties header identifies video signal properties associated with a digital video stream in an AVI file - @param size Size of the data block used to store Tag Information. + @param size_ Size of the data block used to store Tag Information. */ void readVPRPChunk(uint64_t size_); /*! @brief Interpret Riff INdex Chunk, and save it in the respective XMP container. - @param size Size of the data block used to store Tag Information. + @param size_ Size of the data block used to store Tag Information. */ void readIndexChunk(uint64_t size_); /*! @brief Interpret Riff Stream Chunk, and save it in the respective XMP container. - @param size Size of the data block used to store Tag Information. + @param size_ Size of the data block used to store Tag Information. */ void readDataChunk(uint64_t size_); /*! @brief Interpret Junk Chunk and save it in the respective XMP container. - @param size Size of the data block used to store Tag Information. + @param size_ Size of the data block used to store Tag Information. */ void readJunk(uint64_t size_); diff --git a/include/exiv2/types.hpp b/include/exiv2/types.hpp index 85949e70..6b06aedb 100644 --- a/include/exiv2/types.hpp +++ b/include/exiv2/types.hpp @@ -215,10 +215,12 @@ struct EXIV2API DataBuf { /*! * @brief Create a new Slice from a DataBuf given the bounds. * - * @param[in] begin, end Bounds of the new Slice. `begin` must be smaller - * than `end` and both must not be larger than LONG_MAX. * @param[in] buf The DataBuf from which' data the Slice will be * constructed + * @param[in] begin Beginning bound of the new Slice. Must be smaller + * than `end` and both must not be larger than LONG_MAX. + * @param[in] end End bound of the new Slice. Must be smaller + * than `end` and both must not be larger than LONG_MAX. * * @throw std::invalid_argument when `end` is larger than `LONG_MAX` or * anything that the constructor of @ref Slice throws diff --git a/src/convert.cpp b/src/convert.cpp index 8c54e86c..7cde4b43 100644 --- a/src/convert.cpp +++ b/src/convert.cpp @@ -273,7 +273,7 @@ class Converter { std::string computeExifDigest(bool tiff); // DATA - static const Conversion conversion_[]; //