Changeset 5032:b2c8bbc7907f in roaraudio for doc/man3/roar_simple_close.3

Timestamp:

05/28/11 17:23:34 (13 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

some manpage correction

File:

• doc/man3/roar_simple_close.3 (modified) (3 diffs)

doc/man3/roar_simple_close.3

@@ -1 +1 @@
 .\" roar_simple_play.3:
 
-.TH "roar_simple_close" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"
+.TH "roar_simple_close" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio"
 
 .SH NAME
@@ -14 +14 @@
 .SH "DESCRIPTION"
 Closes a filehandle opened via \fBroar_simple_play\fR(3), \fBroar_simple_monitor\fR(3), \fBroar_simple_record\fR(3), \fBroar_simple_filter\fR(3) or \fBroar_simple_new_stream\fR(3).
+
+This function is marked obsolete and will be removed soon. Use \fBroar_vs_close\fR(3).
 
 .SH "PARAMETERS"
@@ -28 +30 @@
 
 .SH "SEE ALSO"
+\fBroar_vs_close\fR(3),
 \fBroar_simple_play\fR(3),
 \fBroar_simple_monitor\fR(3),