summaryrefslogtreecommitdiff
path: root/src/lib/eina/eina_types.h
diff options
context:
space:
mode:
authorJeff Grimshaw <jeffrey.w.grimshaw@gmail.com>2014-03-20 16:35:41 +0900
committerCedric BAIL <cedric.bail@samsung.com>2014-03-20 16:35:42 +0900
commitcf5192025f3aa21115580aa6577eb0f12c2f6ec2 (patch)
treec026947ef3c482b58096c797001061c31d270afd /src/lib/eina/eina_types.h
parentb87cbf8fe42865a5b9d0b62efd3517ef599fb526 (diff)
efl/eina: General cleanup of Eina documentation
Summary: I've combed through the Eina source files and made enhancements to the documentation, including: - Document the undocumented - Fixed some errors in Doxygen markup - Moved some function documentation from implementation (.c or .x) to definition (.h) - Edited some of the entries to improve clarity Test Plan: Reviewers Reviewers: cedric Reviewed By: cedric CC: cedric Differential Revision: https://phab.enlightenment.org/D639
Diffstat (limited to 'src/lib/eina/eina_types.h')
-rw-r--r--src/lib/eina/eina_types.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/lib/eina/eina_types.h b/src/lib/eina/eina_types.h
index d37b20f71f..b0ce44b3ea 100644
--- a/src/lib/eina/eina_types.h
+++ b/src/lib/eina/eina_types.h
@@ -226,6 +226,11 @@
226/** 226/**
227 * @def EINA_ARG_NONNULL 227 * @def EINA_ARG_NONNULL
228 * Used to warn when the specified arguments of the function are @c NULL. 228 * Used to warn when the specified arguments of the function are @c NULL.
229 *
230 * @param ... Oridnals of the parameters to check for nullity (1..n)
231 *
232 * @returns Nothing, but Doxygen will complain if it's not documented :-P
233 *
229 */ 234 */
230# define EINA_ARG_NONNULL(...) 235# define EINA_ARG_NONNULL(...)
231 236