diff --git a/docs/hacking.html.in b/docs/hacking.html.in index ae4d14e7b7..f3ad43eee7 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -985,6 +985,25 @@ BAD: it points to, or it is aliased to another pointer that is.

+

Attribute annotations

+

+ Use the following annotations to help the compiler and/or static + analysis tools understand the code better: +

+ + + + + + + + + + + + +
MacroMeaning
ATTRIBUTE_NONNULLpassing NULL for this parameter is not allowed
ATTRIBUTE_PACKEDforce a structure to be packed
G_GNUC_FALLTHROUGHallow code reuse by multiple switch cases
G_GNUC_NO_INLINEthe function is mocked in the test suite
G_GNUC_NORETURNthe function never returns
G_GNUC_NULL_TERMINATEDlast parameter must be NULL
G_GNUC_PRINTFvalidate that the formatting string matches parameters
G_GNUC_UNUSEDparameter is unused in this implementation of the function
G_GNUC_WARN_UNUSED_RESULTthe return value must be checked
+

Adoption of GLib APIs