Some more Doxygen API documentation (X.509 processing).

[BearSSL] / inc / bearssl.h

diff --git a/inc/bearssl.h b/inc/bearssl.h
index 6258e92..a9f1db7 100644 (file)
--- a/inc/bearssl.h
+++ b/inc/bearssl.h
@@ -75,6 +75,16 @@
  * total code footprint ligther.
  *
  *
  * total code footprint ligther.
  *
  *

+ * ## `NULL` values
+ *
+ * Function parameters with a pointer type shall not be `NULL` unless
+ * explicitly authorised by the documentation. As an exception, then
+ * the pointer aims at a sequence of bytes and is accompanied with
+ * a length parameter, and the length is zero (meaning that there is
+ * no byte at all to retrieve), then the pointer may be `NULL` even if
+ * not explicitly allowed.
+ *
+ *

  * ## Memory Allocation
  *
  * BearSSL does not perform dynamic memory allocation. This implies that
  * ## Memory Allocation
  *
  * BearSSL does not perform dynamic memory allocation. This implies that