summaryrefslogtreecommitdiff
path: root/portaudio/doc/src/tutorial/terminating_portaudio.dox
diff options
context:
space:
mode:
authorsanine <sanine.not@pm.me>2022-08-25 14:54:53 -0500
committersanine <sanine.not@pm.me>2022-08-25 14:54:53 -0500
commit37c97e345d12f95dde44e1d1a4c2f2aadd4615bc (patch)
treee1bb25bc855883062bdd7847ff2c04290f71c840 /portaudio/doc/src/tutorial/terminating_portaudio.dox
parent5634c7b04da619669f2f29f6798c03982be05180 (diff)
add initial structure
Diffstat (limited to 'portaudio/doc/src/tutorial/terminating_portaudio.dox')
-rw-r--r--portaudio/doc/src/tutorial/terminating_portaudio.dox20
1 files changed, 20 insertions, 0 deletions
diff --git a/portaudio/doc/src/tutorial/terminating_portaudio.dox b/portaudio/doc/src/tutorial/terminating_portaudio.dox
new file mode 100644
index 0000000..67f74f6
--- /dev/null
+++ b/portaudio/doc/src/tutorial/terminating_portaudio.dox
@@ -0,0 +1,20 @@
+/** @page terminating_portaudio Closing a Stream and Terminating PortAudio
+@ingroup tutorial
+
+When you are done with a stream, you should close it to free up resources:
+
+@code
+ err = Pa_CloseStream( stream );
+ if( err != paNoError ) goto error;
+@endcode
+
+We've already mentioned this in \ref initializing_portaudio, but in case you forgot, be sure to terminate PortAudio when you are done:
+
+@code
+ err = Pa_Terminate( );
+ if( err != paNoError ) goto error;
+@endcode
+
+Previous: \ref start_stop_abort | Next: \ref utility_functions
+
+*/ \ No newline at end of file