From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Mon, 20 Feb 2012 21:56:22 +0000 (+0000)
Subject: Add @onlyfor tag for wxSound::IsPlaying() documentation.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/f85d2074fb7623087b04b1921b91942ff4943958?ds=inline

Add @onlyfor tag for wxSound::IsPlaying() documentation.

This is not totally precise as the method is available in all Unix-based ports
but currently there doesn't seem to be any way to specify this so just mention
its availability in wxGTK which is what counts.

Closes #14002.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70643 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/interface/wx/sound.h b/interface/wx/sound.h
index 5f2c78300b..36502095e2 100644
--- a/interface/wx/sound.h
+++ b/interface/wx/sound.h
@@ -72,7 +72,12 @@ public:
 
     /**
         Returns @true if a sound is played at the moment.
-        This method is currently not implemented under Windows.
+
+        This method is currently not available under Windows and may not be
+        always implemented in Unix ports depending on the compilation options
+        used (in this case it just always returns @false).
+
+        @onlyfor{wxgtk,wxosx}
     */
     static bool IsPlaying();