From: Chris Rienzo <chris@signalwire.com>
Date: Fri, 15 Jan 2021 14:27:33 +0000 (+0000)
Subject: [core] fix documentation error for switch_core_media_bug_read()
X-Git-Tag: v1.10.6^2~102
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=caca7a66d622397a6ca3f26c1a673cce8d08dd73;p=thirdparty%2Ffreeswitch.git

[core] fix documentation error for switch_core_media_bug_read()
---

diff --git a/src/include/switch_core.h b/src/include/switch_core.h
index 34bb1d84bd..92e1452aa0 100644
--- a/src/include/switch_core.h
+++ b/src/include/switch_core.h
@@ -421,7 +421,7 @@ SWITCH_DECLARE(switch_status_t) switch_core_media_bug_transfer_callback(switch_c
   \brief Read a frame from the bug
   \param bug the bug to read from
   \param frame the frame to write the data to
-  \return the amount of data
+  \return SWITCH_STATUS_SUCCESS if the operation was a success
 */
 SWITCH_DECLARE(switch_status_t) switch_core_media_bug_read(_In_ switch_media_bug_t *bug, _In_ switch_frame_t *frame, switch_bool_t fill);