]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/sound.h
fixing file paths after renaming
[wxWidgets.git] / interface / sound.h
index 2fff9caf3adfc86fa637f1268c64904688d23db5..2d22a5b76cb260e0a06a9fd4734e8becf281f261 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        sound.h
-// Purpose:     documentation for wxSound class
+// Purpose:     interface of wxSound
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -27,7 +27,7 @@ public:
         Constructs a wave object from a file or, under Windows, from a Windows
         resource. Call IsOk() to determine whether this
         succeeded.
-        
+
         @param fileName
             The filename or Windows resource.
         @param isResource
@@ -44,13 +44,13 @@ public:
 
     /**
         Constructs a wave object from a file or resource.
-        
+
         @param fileName
             The filename or Windows resource.
         @param isResource
             @true if fileName is a resource, @false if it is a filename.
-        
-        @returns @true if the call was successful, @false otherwise.
+
+        @return @true if the call was successful, @false otherwise.
     */
     bool Create(const wxString& fileName, bool isResource = false);
 
@@ -75,23 +75,23 @@ public:
         calling this function and the sound would continue playing, however this
         currently doesn't work under Windows for sound objects loaded from memory data.
         The possible values for @a flags are:
-        
+
         wxSOUND_SYNC
-        
+
         @c Play will block and wait until the sound is
         replayed.
-        
+
         wxSOUND_ASYNC
-        
+
         Sound is played asynchronously,
         @c Play returns immediately
-        
+
         wxSOUND_ASYNC | wxSOUND_LOOP
-        
+
         Sound is played asynchronously
         and loops until another sound is played,
         Stop() is called or the program terminates.
-        
+
         The static form is shorthand for this code:
     */
     bool Play(unsigned flags = wxSOUND_ASYNC);
@@ -104,3 +104,4 @@ public:
     */
     static void Stop();
 };
+