Recover some documentation strings

Exiv2 · Feb 4, 2022 · a425018 · a425018
1 parent 3ed696a
commit a425018
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/include/exiv2/bmpimage.hpp b/include/exiv2/bmpimage.hpp
@@ -79,24 +79,24 @@ namespace Exiv2 {
         //! @name Manipulators
         //@{
         void readMetadata() override;
-        /*!
-          @brief Todo: Write metadata back to the image. This method is not
-              yet(?) implemented. Calling it will throw an Error(kerWritingImageFormatUnsupported).
-         */
+
+        /// @throws Error(kerWritingImageFormatUnsupported).
         void writeMetadata() override;
 
+        /// @throws Error(kerInvalidSettingForImage)
         void setExifData(const ExifData& exifData) override;
 
+        /// @throws Error(kerInvalidSettingForImage)
         void setIptcData(const IptcData& iptcData) override;
 
+        /// @throws Error(kerInvalidSettingForImage)
         void setComment(const std::string& comment) override;
         //@}
 
         //! @name Accessors
         //@{
         std::string mimeType() const override;
         //@}
-
     }; // class BmpImage
 
 // *****************************************************************************

diff --git a/src/bmpimage.cpp b/src/bmpimage.cpp
@@ -114,7 +114,7 @@ namespace Exiv2
 
     void BmpImage::writeMetadata()
     {
-        // Todo: implement me!
+        /// \todo implement me!
         throw(Error(kerWritingImageFormatUnsupported, "BMP"));
     }