Commit 32da9fe5 authored by David Reid's avatar David Reid

Simplify some documentation for clarity.

parent 400e3c9a
...@@ -914,11 +914,7 @@ mal_result mal_context_uninit(mal_context* pContext); ...@@ -914,11 +914,7 @@ mal_result mal_context_uninit(mal_context* pContext);
// Some backends and platforms may only support default playback and capture devices. // Some backends and platforms may only support default playback and capture devices.
// //
// Return Value: // Return Value:
// - MAL_SUCCESS if successful. // MAL_SUCCESS if successful; any other error code otherwise.
// - MAL_INVALID_ARGS
// One or more of the input arguments is invalid.
// - MAL_NO_BACKEND
// There is no supported backend, or there was an error loading it (such as a missing dll/so).
// //
// Thread Safety: SAFE, SEE NOTES. // Thread Safety: SAFE, SEE NOTES.
// This API uses an application-defined buffer for output. This is thread-safe so long as the // This API uses an application-defined buffer for output. This is thread-safe so long as the
...@@ -954,19 +950,7 @@ mal_result mal_enumerate_devices(mal_context* pContext, mal_device_type type, ma ...@@ -954,19 +950,7 @@ mal_result mal_enumerate_devices(mal_context* pContext, mal_device_type type, ma
// to the official documentation for ActivateAudioInterfaceAsync() for more information. // to the official documentation for ActivateAudioInterfaceAsync() for more information.
// //
// Return Value: // Return Value:
// - MAL_SUCCESS if successful. // MAL_SUCCESS if successful; any other error code otherwise.
// - MAL_INVALID_ARGS
// One or more of the input arguments is invalid.
// - MAL_NO_BACKEND
// There is no supported backend, or there was an error loading it (such as a missing dll/so).
// - MAL_OUT_OF_MEMORY
// A necessary memory allocation failed, likely due to running out of memory.
// - MAL_FORMAT_NOT_SUPPORTED
// The specified format is not supported by the backend. mini_al does not currently do any
// software format conversions which means initialization must fail if the backend does not
// natively support it.
// - MAL_FAILED_TO_INIT_BACKEND
// There was a backend-specific error during initialization.
// //
// Thread Safety: UNSAFE // Thread Safety: UNSAFE
// It is not safe to call this function simultaneously for different devices because some backends // It is not safe to call this function simultaneously for different devices because some backends
...@@ -985,11 +969,7 @@ mal_result mal_device_init(mal_context* pContext, mal_device_type type, mal_devi ...@@ -985,11 +969,7 @@ mal_result mal_device_init(mal_context* pContext, mal_device_type type, mal_devi
// harmless if you do. // harmless if you do.
// //
// Return Value: // Return Value:
// - MAL_SUCCESS if successful. // MAL_SUCCESS if successful; any other error code otherwise.
// - MAL_INVALID_ARGS
// pDevice is NULL.
// - MAL_DEVICE_NOT_INITIALIZED
// The device is not currently or was never initialized.
// //
// Thread Safety: UNSAFE // Thread Safety: UNSAFE
// As soon as this API is called the device should be considered undefined. All bets are off if you // As soon as this API is called the device should be considered undefined. All bets are off if you
...@@ -1039,7 +1019,7 @@ void mal_device_set_stop_callback(mal_device* pDevice, mal_stop_proc proc); ...@@ -1039,7 +1019,7 @@ void mal_device_set_stop_callback(mal_device* pDevice, mal_stop_proc proc);
// to be done _before_ the device begins playback. // to be done _before_ the device begins playback.
// //
// Return Value: // Return Value:
// - MAL_SUCCESS if successful. // - MAL_SUCCESS if successful; any other error code otherwise.
// - MAL_INVALID_ARGS // - MAL_INVALID_ARGS
// One or more of the input arguments is invalid. // One or more of the input arguments is invalid.
// - MAL_DEVICE_NOT_INITIALIZED // - MAL_DEVICE_NOT_INITIALIZED
...@@ -1070,7 +1050,7 @@ mal_result mal_device_start(mal_device* pDevice); ...@@ -1070,7 +1050,7 @@ mal_result mal_device_start(mal_device* pDevice);
// Puts the device to sleep, but does not uninitialize it. Use mal_device_start() to start it up again. // Puts the device to sleep, but does not uninitialize it. Use mal_device_start() to start it up again.
// //
// Return Value: // Return Value:
// - MAL_SUCCESS if successful. // - MAL_SUCCESS if successful; any other error code otherwise.
// - MAL_INVALID_ARGS // - MAL_INVALID_ARGS
// One or more of the input arguments is invalid. // One or more of the input arguments is invalid.
// - MAL_DEVICE_NOT_INITIALIZED // - MAL_DEVICE_NOT_INITIALIZED
......
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