From 939600d2adf1f4a61ad030ddbb35d5b45e7e25da Mon Sep 17 00:00:00 2001 From: John Scipione Date: Mon, 24 Dec 2012 16:05:51 -0500 Subject: [PATCH] Update SetPaused() and add IsPaused() documentation --- docs/user/game/FileGameSound.dox | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/user/game/FileGameSound.dox b/docs/user/game/FileGameSound.dox index 9b9b06475ae..3936639ef7f 100644 --- a/docs/user/game/FileGameSound.dox +++ b/docs/user/game/FileGameSound.dox @@ -121,7 +121,18 @@ take to complete in microseconds. Set to 0 for an instantaneous change. - \returns A status code indicating the current playback status. - \retval B_OK The operating was successful. + \returns A status code. + \retval B_OK The playback state was updated. \retval EALREADY Already in the requested playback state. */ + + +/*! + \fn int32 BFileGameSound::IsPaused() + \brief Returns the current playback status. + + \returns An integer indicating the current playback status. + \retval B_NOT_PAUSED Sound is playing. + \retval B_PAUSE_IN_PROGRESS The sound is transitioning to or from a paused state. + \retval B_PAUSED Sound is paused. +*/