From d1d9a72e3e7edf95665a351b98ea5ff61871c777 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Heikki=20Johannes=20Hild=C3=A9n?= Date: Sat, 23 Sep 2023 13:17:10 +0300 Subject: [PATCH] Update docblocks --- include/sqids/sqids.hpp | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/include/sqids/sqids.hpp b/include/sqids/sqids.hpp index 753a2f8..4ba68c9 100644 --- a/include/sqids/sqids.hpp +++ b/include/sqids/sqids.hpp @@ -252,9 +252,12 @@ inline bool Sqids::containsMultibyteCharacters(const std::string& input) cons /// /// Encode a sequence of integers into an ID. /// -/// TODO +/// These are the cases where encoding might fail: +/// - One of the numbers passed is smaller than 0 or greater than `maxValue` +/// - An /n/ number of attempts has been made to re-generated the ID, where +/// /n/ is the length of the alphabet + 1 /// -/// @throws std::runtime_error TODO +/// @throws std::runtime_error When encoding fails /// /// @param numbers The integers to encode into an ID /// @return The generated ID