summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2020-03-09 09:58:19 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2020-03-09 09:58:41 +0100
commit0f03165fec90c462caad7f715c71477a82a65fb0 (patch)
tree33b355f144b7ec65fa019bc86d409c353ab372b0 /src
parentd60587c0989c0cbd8cbb17a0a19854f00495a702 (diff)
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
Diffstat (limited to 'src')
-rw-r--r--src/lib/eina/eina_safety_checks.h10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/lib/eina/eina_safety_checks.h b/src/lib/eina/eina_safety_checks.h
index cf29f27a21..27551290d6 100644
--- a/src/lib/eina/eina_safety_checks.h
+++ b/src/lib/eina/eina_safety_checks.h
@@ -29,16 +29,16 @@
29 * @defgroup Eina_Safety_Checks_Group Safety Checks 29 * @defgroup Eina_Safety_Checks_Group Safety Checks
30 * 30 *
31 * @warning @c eina_safety_checks.h should only be included by source 31 * @warning @c eina_safety_checks.h should only be included by source
32 * files, after all other includes and before the source file 32 * files after all other includes and before the source file
33 * specific includes. By source file specific includes we 33 * specific includes. By source file specific includes we
34 * mean those that define the functions that are being 34 * mean those that define the functions that are being
35 * checked. The reason for such complexity is the trick to 35 * checked. The reason for such complexity is the trick to
36 * avoid compiler optimizations. If compilers are told that 36 * avoid compiler optimizations. If compilers are told that
37 * some given function will never receive @c NULL 37 * some given function will never receive @c NULL
38 * (EINA_ARG_NONNULL(), then compiler will emit a warning if 38 * (EINA_ARG_NONNULL()), then the compiler will emit a warning if
39 * it detects so (good!) but will remove any checks for that 39 * it detects so (good!) and also will remove any checks for that
40 * condition as it believes it will never happen, removing 40 * condition as it believes it will never happen, removing
41 * all safety checks! By including @c eina_safety_checks.h it 41 * all safety checks! By including @c eina_safety_checks.h last it
42 * will redefine EINA_ARG_NONNULL() to void and compiler 42 * will redefine EINA_ARG_NONNULL() to void and compiler
43 * warning will not be emitted, but checks will be there. The 43 * warning will not be emitted, but checks will be there. The
44 * files already processed with the old macro 44 * files already processed with the old macro
@@ -69,7 +69,7 @@
69 * will log and return instead of abort() your program. 69 * will log and return instead of abort() your program.
70 * 70 *
71 * Since these cases should never happen, one may want to keep safety 71 * Since these cases should never happen, one may want to keep safety
72 * checks enabled during tests but disable then during deploy, not 72 * checks enabled during tests but disable them during deploy, not
73 * doing any checks at all. This is a common requirement for embedded 73 * doing any checks at all. This is a common requirement for embedded
74 * systems. When to check or not should be set during compile time 74 * systems. When to check or not should be set during compile time
75 * by using @c --disable-safety-checks or @c --enable-safety-checks 75 * by using @c --disable-safety-checks or @c --enable-safety-checks