Updating the docs. (#101)

matheusgomes28 · May 10, 2023 · 9515cd6 · 9515cd6
1 parent 9c8321e
commit 9515cd6
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/base64pp/include/base64pp/base64pp.h b/base64pp/include/base64pp/base64pp.h
@@ -27,6 +27,8 @@ namespace base64pp
     //! @param encoded_str - the base64 encoded string
     //! @return an optional containing a valid blob of data, if
     //! decoding was successful. Otherwise, returns std::nullopt
+    //! @note this function accepts unpadded strings, if they are valid
+    //! otherwise. It rejects odd-sized unpadded strings.
     std::optional<std::vector<std::uint8_t>> BASE64PP_EXPORT decode(std::string_view const encoded_str);
 } // namespace base64pp