Summarize the API listing in the wmem README. Doxygen in the header files will

be much easier to keep in sync with the actual code.

svn path=/trunk/; revision=49040

1 files changed, 28 insertions, 42 deletions

diff --git a/doc/README.wmem b/doc/README.wmem
index b90c5d960a..d8d5b1d846 100644
--- a/doc/README.wmem
+++ b/doc/README.wmem
@@ -73,48 +73,34 @@ next packet is dissected. This is effectively the scope of Wireshark's pinfo
 structure, so the pinfo struct has a 'pool' member which is a wmem pool scoped
 to the lifetime of the pinfo struct.
 
-2.2 Core API
-
- - wmem_alloc
- - wmem_alloc0
- - wmem_new
- - wmem_new0
- - wmem_realloc
- - wmem_free
-
-2.3 String Utilities
-
- - wmem_strdup
- - wmem_strndup
- - wmem_strdup_printf
- - wmem_strdup_vprintf
-
-2.4 Stack
-
- - wmem_stack_new
- - wmem_stack_push
- - wmem_stack_pop
- - wmem_stack_peek
- - wmem_stack_count
-
-2.5 Singly-Linked List
-
- - wmem_slist_new
- - wmem_slist_prepend
- - wmem_slist_remove
- - wmem_slist_front
- - wmem_slist_frame_next
- - wmem_slist_frame_data
- - wmem_slist_count
-
-2.6 String-Buffers
-
- - wmem_strbuf_new
- - wmem_strbuf_sized_new
- - wmem_strbuf_append
- - wmem_strbuf_append_printf
- - wmem_strbuf_get_str
- - wmem_strbuf_get_len
+2.2 API
+
+Full documentation for each function (parameters, return values, behaviours)
+lives (or will live) in Doxygen-format in the header files for those functions.
+This is just an overview of which header files you should be looking at.
+
+2.2.1 Core API
+
+wmem_core.h
+ - Basic memory management functions like malloc, realloc and free.
+
+2.2.2 Strings
+
+wmem_strutl.h
+ - Utility functions for manipulating null-terminated C-style strings.
+   Functions like strdup and strdup_printf.
+
+wmem_strbuf.h
+ - A managed string object implementation, similar to std::string in C++ or
+   GString from Glib.
+
+2.2.3 Container Data Structures
+
+wmem_slist.h
+ - A singly-linked list implementation.
+
+wmem_stack.h
+ - A stack implementation (push, pop, etc).
 
 3. Usage for Producers