secp256k1.h: clarify that by default arguments must be != NULL

jonasnick · jonasnick · commit 0881633dfd0c · 2021-04-29T10:21:26.000Z
The same file says that the illegal callback will only triger for violations
explicitly mentioned, which is not true without this commit because we often
don't mention that an argument is not allowed to be NULL.
diff --git a/include/secp256k1.h b/include/secp256k1.h
@@ -7,7 +7,9 @@ extern "C" {
 
 #include <stddef.h>
 
-/* These rules specify the order of arguments in API calls:
+/* Unless explicitly stated all pointer arguments must not be NULL.
+ *
+ * The following rules specify the order of arguments in API calls:
  *
  * 1. Context pointers go first, followed by output arguments, combined
  *    output/input arguments, and finally input-only arguments.

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,9 @@ extern "C" {`
`7`	`7`
`8`	`8`	`#include <stddef.h>`
`9`	`9`
`10`		`-/* These rules specify the order of arguments in API calls:`
	`10`	`+/* Unless explicitly stated all pointer arguments must not be NULL.`
	`11`	`+ *`
	`12`	`+ * The following rules specify the order of arguments in API calls:`
`11`	`13`	`*`
`12`	`14`	`* 1. Context pointers go first, followed by output arguments, combined`
`13`	`15`	`* output/input arguments, and finally input-only arguments.`