Improve some documentation and ChangeLog entry

This commit is contained in:
Manuel Pégourié-Gonnard 2018-12-13 09:45:49 +01:00
parent a4251f4775
commit e7306d30a9
3 changed files with 18 additions and 5 deletions

View file

@ -292,6 +292,9 @@
* calls that function, but does not provide a default definition for it,
* - or provide a different definition of the macro MBEDTLS_PARAM_FAILED()
* below if the above mechanism is not flexible enough to suit your needs.
* Note that you may define it to expand to nothing if you're happy to be
* notified about invalid parameters only in non-void functions, and have
* void function just silently return early on invalid parameters.
*
* Uncomment to enable validation of application-controlled parameters.
*/
@ -3055,6 +3058,12 @@
* from within the library - you can ensure that by providing
* them in this file next to the macro definition).
*
* Note that you may define this macro to expand to nothing, in
* which case you don't have to worry about declarations or
* definitions. However, you will then be notified about invalid
* parameters only in non-void functions, and void function will
* just silently return early on invalid parameters.
*
* \param cond The expression that should evaluate to true, but doesn't.
*/
//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )