From c6ba836ad1fbda247d9622b2f372a0c9c0cdbfd9 Mon Sep 17 00:00:00 2001
From: Marti Bolivar <mbolivar@leaflabs.com>
Date: Mon, 22 Aug 2011 23:37:16 -0400
Subject: Better document libmaple proper APIs.

Instead of using doxygenfile, add finely-grained documentation for
each libmaple proper header that we guarantee an API for.  These new
files are in keeping with the template provided in
/tmpl/libmaple-proper-page.rst.tmpl.

Breathe still has to be taught how to do doxygenunion to get some of
this right, but I'm committing this now in anticipation of that
happening.
---
 source/libmaple/api/ring_buffer.rst | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)

(limited to 'source/libmaple/api/ring_buffer.rst')

diff --git a/source/libmaple/api/ring_buffer.rst b/source/libmaple/api/ring_buffer.rst
index a014fa4..e9b6637 100644
--- a/source/libmaple/api/ring_buffer.rst
+++ b/source/libmaple/api/ring_buffer.rst
@@ -4,9 +4,24 @@
 ``ring_buffer.h``
 =================
 
-[Stub] support.
+Simple circular byte buffer.  This implementation is not thread-safe.
+In particular, none of these functions is guaranteed to be re-entrant.
 
-Library Documentation
----------------------
+Ring Buffer Type
+----------------
 
-.. doxygenfile:: ring_buffer.h
+.. doxygenstruct:: ring_buffer
+
+Ring Buffer Operations
+----------------------
+
+.. doxygenfunction:: rb_init
+.. doxygenfunction:: rb_full_count
+.. doxygenfunction:: rb_is_full
+.. doxygenfunction:: rb_is_empty
+.. doxygenfunction:: rb_insert
+.. doxygenfunction:: rb_remove
+.. doxygenfunction:: rb_safe_remove
+.. doxygenfunction:: rb_safe_insert
+.. doxygenfunction:: rb_push_insert
+.. doxygenfunction:: rb_reset
-- 
cgit v1.2.3