Commit 69de9963 authored by Max Kellermann's avatar Max Kellermann

OutputPlugin: update API documentation

parent afcff1fa
...@@ -64,9 +64,7 @@ struct AudioOutputPlugin { ...@@ -64,9 +64,7 @@ struct AudioOutputPlugin {
/** /**
* Enable the device. This may allocate resources, preparing * Enable the device. This may allocate resources, preparing
* for the device to be opened. Enabling a device cannot * for the device to be opened.
* fail: if an error occurs during that, it should be reported
* by the open() method.
* *
* @return true on success, false on error * @return true on success, false on error
*/ */
...@@ -137,8 +135,8 @@ struct AudioOutputPlugin { ...@@ -137,8 +135,8 @@ struct AudioOutputPlugin {
* disconnected. Plugins which do not support pausing will * disconnected. Plugins which do not support pausing will
* simply be closed, and have to be reopened when unpaused. * simply be closed, and have to be reopened when unpaused.
* *
* @return false on error (output will be closed then), true * @return false on error (output will be closed by caller),
* for continue to pause * true for continue to pause
*/ */
bool (*pause)(AudioOutput *data); bool (*pause)(AudioOutput *data);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment