forked from enlightenment/efl
eina: Docs/Comments: eina_safety_checks: Correct grammar, spelling mistakes and be more clearer
Summary: This just corrects the comments grammar, spelling mistakes and is a little bit clearer. Reviewers: segfaultxavi, barbieri Reviewed By: segfaultxavi Tags: #efl Differential Revision: https://phab.enlightenment.org/D11472
This commit is contained in:
parent
d60587c098
commit
0f03165fec
|
@ -29,16 +29,16 @@
|
||||||
* @defgroup Eina_Safety_Checks_Group Safety Checks
|
* @defgroup Eina_Safety_Checks_Group Safety Checks
|
||||||
*
|
*
|
||||||
* @warning @c eina_safety_checks.h should only be included by source
|
* @warning @c eina_safety_checks.h should only be included by source
|
||||||
* files, after all other includes and before the source file
|
* files after all other includes and before the source file
|
||||||
* specific includes. By source file specific includes we
|
* specific includes. By source file specific includes we
|
||||||
* mean those that define the functions that are being
|
* mean those that define the functions that are being
|
||||||
* checked. The reason for such complexity is the trick to
|
* checked. The reason for such complexity is the trick to
|
||||||
* avoid compiler optimizations. If compilers are told that
|
* avoid compiler optimizations. If compilers are told that
|
||||||
* some given function will never receive @c NULL
|
* some given function will never receive @c NULL
|
||||||
* (EINA_ARG_NONNULL(), then compiler will emit a warning if
|
* (EINA_ARG_NONNULL()), then the compiler will emit a warning if
|
||||||
* it detects so (good!) but will remove any checks for that
|
* it detects so (good!) and also will remove any checks for that
|
||||||
* condition as it believes it will never happen, removing
|
* condition as it believes it will never happen, removing
|
||||||
* all safety checks! By including @c eina_safety_checks.h it
|
* all safety checks! By including @c eina_safety_checks.h last it
|
||||||
* will redefine EINA_ARG_NONNULL() to void and compiler
|
* will redefine EINA_ARG_NONNULL() to void and compiler
|
||||||
* warning will not be emitted, but checks will be there. The
|
* warning will not be emitted, but checks will be there. The
|
||||||
* files already processed with the old macro
|
* files already processed with the old macro
|
||||||
|
@ -69,7 +69,7 @@
|
||||||
* will log and return instead of abort() your program.
|
* will log and return instead of abort() your program.
|
||||||
*
|
*
|
||||||
* Since these cases should never happen, one may want to keep safety
|
* Since these cases should never happen, one may want to keep safety
|
||||||
* checks enabled during tests but disable then during deploy, not
|
* checks enabled during tests but disable them during deploy, not
|
||||||
* doing any checks at all. This is a common requirement for embedded
|
* doing any checks at all. This is a common requirement for embedded
|
||||||
* systems. When to check or not should be set during compile time
|
* systems. When to check or not should be set during compile time
|
||||||
* by using @c --disable-safety-checks or @c --enable-safety-checks
|
* by using @c --disable-safety-checks or @c --enable-safety-checks
|
||||||
|
|
Loading…
Reference in New Issue