Improve doc comments in BitInputArchive

rikyoz · Jul 12, 2024 · a681bd8 · a681bd8
1 parent 4fdfc36
commit a681bd8
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/include/bit7z/bitinputarchive.hpp b/include/bit7z/bitinputarchive.hpp
@@ -260,13 +260,17 @@ class BitInputArchive {
         /**
          * @brief Extracts the content of the archive to the given raw data callback.
          *
+         * @note You can set a FileCallback to check the file being extracted.
+         *
          * @param callback  a function providing the extracted raw data to the user.
          */
         void extractTo( RawDataCallback callback ) const;
 
         /**
          * @brief Extracts the raw content of the archive to the given callback.
          *
+         * @note You can set a FileCallback to check the file being extracted.
+         *
          * @param callback  a function providing the extracted raw data to the user.
          */
         void extractTo( RawDataCallback callback, const std::vector< uint32_t >& indices ) const;