Manpages als reStructuredText erstellt
Unsere Manpages wurden mit einem LPC-Tool in
reStructuredText konvertiert und liegen jetzt
in diesem Verzeichnis als Quelldaten.
Aus diesen reStructuredText sollen dann per
Script die ASCII-Manpages und per Sphinx HTML u.a.
erzeugt werden.
Change-Id: I75d659a7b3f9863aecb11dbeb0037e6cae227c36
diff --git a/doc/sphinx/lfun/RingBufferPut.rst b/doc/sphinx/lfun/RingBufferPut.rst
new file mode 100644
index 0000000..4d35ad6
--- /dev/null
+++ b/doc/sphinx/lfun/RingBufferPut.rst
@@ -0,0 +1,49 @@
+RingBufferPut()
+===============
+
+FUNKTION
+--------
+::
+
+ protected void RingBufferPut(struct std_ringbuffer buf, mixed val);
+
+DEFINIERT IN
+------------
+::
+
+ /std/util/ringbuffer.c
+ /sys/util/ringbuffer.h
+
+ARGUMENTE
+---------
+::
+
+ buf - Ringpuffer, in den <val> geschrieben werden soll
+ val - neues Datum
+
+BESCHREIBUNG
+------------
+::
+
+ Diese Funktion schreibt <val> in den Ringpuffer <buf>. Hierbei wird ggf.
+ das aelteste im Puffer existierende Datum ueberschrieben. <buf> muss eine
+ von CreateRingBuffer() oder ResizeRingBuffer() zurueckgelieferter
+ Ringpuffer sein.
+
+BEISPIELE
+---------
+::
+
+ // Ringpuffer anlegen:
+ struct std_ringbuffer buffer = CreateRingBuffer(10, MODE_FIFO);
+ // 15 Werte reinschreiben:
+ foreach(int i: 15) RingBufferPut(buffer, i);
+
+SIEHE AUCH
+----------
+::
+
+ RingBufferGet(), CreateRingBuffer(), ResizeRingBuffer()
+
+23.05.2008, Zesstra
+