Revert "Document talloc_pool()"

[ira/wip.git] / lib / talloc / talloc.h

diff --git a/lib/talloc/talloc.h b/lib/talloc/talloc.h
index 523a4840d34dbecf8bfe9ab46ec5fffb445ec59b..4adc67b7fd3f2b454a0fa61c34407eaa1b841c2b 100644 (file)
--- a/lib/talloc/talloc.h
+++ b/lib/talloc/talloc.h
@@ -56,6 +56,9 @@
  * If you think about this, then what this effectively gives you is an n-ary
  * tree, where you can free any part of the tree with talloc_free().
  *
+ * To start, you should probably first look at the definitions of
+ * ::TALLOC_CTX, talloc_init(), talloc() and talloc_free().
+ *
  * \section named_blocks Named blocks
  *
  * Every talloc chunk has a name that can be used as a dynamic type-checking
@@ -96,28 +99,33 @@
  * programming.
  */
 
-/** \defgroup talloc_ref Talloc References
+/**
+ * \defgroup talloc_ref Talloc References
  *
  * This module contains the definitions around talloc references
  */
 
-/** \defgroup talloc_array Array routines
+/**
+ * \defgroup talloc_array Array routines
  *
  * Talloc contains some handy helpers for handling Arrays conveniently
  */
 
-/** \defgroup talloc_string String handling routines
+/**
+ * \defgroup talloc_string String handling routines
  *
  * Talloc contains some handy string handling functions
  */
 
-/** \defgroup talloc_debug Debugging support routines
+/**
+ * \defgroup talloc_debug Debugging support routines
  *
  * To aid memory debugging, talloc contains routines to inspect the currently
  * allocated memory hierarchy.
  */
 
-/** \defgroup todo Default group of undocumented stuff
+/**
+ * \defgroup talloc_undoc Default group of undocumented stuff
  *
  * This should be empty...
  */