From a681bd857bf6f1106e4cec0d66ba884eb9e407a6 Mon Sep 17 00:00:00 2001 From: Oz Date: Fri, 12 Jul 2024 18:08:02 +0200 Subject: [PATCH] Improve doc comments in BitInputArchive --- include/bit7z/bitinputarchive.hpp | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/include/bit7z/bitinputarchive.hpp b/include/bit7z/bitinputarchive.hpp index bf277dbd..d4c1fea9 100644 --- a/include/bit7z/bitinputarchive.hpp +++ b/include/bit7z/bitinputarchive.hpp @@ -260,6 +260,8 @@ 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; @@ -267,6 +269,8 @@ class BitInputArchive { /** * @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;