Better documenting EINA_MAGIC_SET()'s use.

Patch by Jonas Gastal.

git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/eina@50744 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

diff --git a/src/lib/eina_magic.c b/src/lib/eina_magic.c
index 8de668d..be10303 100644 (file)
--- a/src/lib/eina_magic.c
+++ b/src/lib/eina_magic.c
@@ -255,6 +255,12 @@ eina_magic_string_shutdown(void)
  *    free(ptr->name);
  *    free(ptr);
  * }
+ * struct base *base_new(int id, const char *name) {
+ *    struct base *ptr = malloc(sizeof(struct base));
+ *    EINA_MAGIC_SET(ptr, BASE_MAGIC);
+ *    ptr->id = id;
+ *    ptr->name = strdup(name);
+ * }
  *
  * struct subtype {
  *    struct base base;