aboutsummaryrefslogtreecommitdiff
path: root/pw_varint/docs.rst
diff options
context:
space:
mode:
Diffstat (limited to 'pw_varint/docs.rst')
-rw-r--r--pw_varint/docs.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/pw_varint/docs.rst b/pw_varint/docs.rst
index 3327ccdba..58c90f959 100644
--- a/pw_varint/docs.rst
+++ b/pw_varint/docs.rst
@@ -28,6 +28,11 @@ and unsigned integers.
Returns the size of a signed integer when ZigZag encoded as a varint.
+.. cpp:function:: uint64_t MaxValueInBytes(size_t bytes)
+
+Returns the maximum integer value that can be encoded as a varint into the
+specified number of bytes.
+
Dependencies
============
* ``pw_span``