Document _talloc
authorVolker Lendecke <vl@samba.org>
Sat, 21 Mar 2009 19:02:42 +0000 (20:02 +0100)
committerVolker Lendecke <vl@samba.org>
Sat, 21 Mar 2009 19:04:17 +0000 (20:04 +0100)
lib/talloc/talloc.h

index f3aa6def63eef49fbeb4e93798ecd755ce6b5765..01e7326ccc602edd6f754a04134d5f67d629ba33 100644 (file)
@@ -635,7 +635,16 @@ typedef void TALLOC_CTX;
 
 #define TALLOC_FREE(ctx) do { talloc_free(ctx); ctx=NULL; } while(0)
 
-/* The following definitions come from talloc.c  */
+/**
+ * \brief Allocate untyped, unnamed memory
+ * \param context The talloc context to hang the result off
+ * \param size Number of char's that you want to allocate
+ * \return The allocated memory chunk
+ * \ingroup talloc_internal
+ *
+ * Essentially the same as talloc_size() without setting the chunk name to the
+ * current file/line number.
+ */
 void *_talloc(const void *context, size_t size);
 
 /**