Eobj: added warnings to eobj_ref's docs.

git-svn-id: http://svn.enlightenment.org/svn/e/trunk/PROTO/eobj@70416 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

diff --git a/lib/Eobj.h b/lib/Eobj.h
index d8a508c..224d6cf 100644 (file)
--- a/lib/Eobj.h
+++ b/lib/Eobj.h
@@ -463,6 +463,13 @@ EAPI void *eobj_data_get(const Eobj *obj, const Eobj_Class *klass);
  * @param obj the object to work on.
  * @return The object passed.
  *
+ * It's very easy to get a refcount leak and start leaking memory because
+ * of a forgotten unref or an extra ref. That is why there are eobj_xref
+ * and eobj_xunref that will make debugging easier in such a case.
+ * Therefor, these functions should only be used in small scopes, i.e at the
+ * start of some section in which the object may get freed, or if you know
+ * what you are doing.
+ *
  * @see eobj_unref()
  * @see eobj_ref_get()
  */