Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / osx / sound.h

diff --git a/include/wx/osx/sound.h b/include/wx/osx/sound.h
index 7b0329bdec3bc1e967d9ff7fc18feff7cd7e63fb..fd3978f616b040d1ae22ff01304eeba11e7ad4dd 100644 (file)
--- a/include/wx/osx/sound.h
+++ b/include/wx/osx/sound.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        sound.h
+// Name:        wx/osx/sound.h

 // Purpose:     wxSound class (loads and plays short Windows .wav files).
 //              Optional on non-Windows platforms.
 // Author:      Ryan Norton, Stefan Csomor
 // Purpose:     wxSound class (loads and plays short Windows .wav files).
 //              Optional on non-Windows platforms.
 // Author:      Ryan Norton, Stefan Csomor


@@ -24,7 +24,7 @@ class WXDLLIMPEXP_ADV wxSoundData
 public :
     wxSoundData();
     virtual ~wxSoundData();
 public :
     wxSoundData();
     virtual ~wxSoundData();

-    
+

     virtual bool Play(unsigned int flags) = 0;
     // stops the sound and deletes the optional timer
     virtual void Stop();
     virtual bool Play(unsigned int flags) = 0;
     // stops the sound and deletes the optional timer
     virtual void Stop();


@@ -33,12 +33,12 @@ public :
     // mark this to be deleted
     virtual void MarkForDeletion();
     virtual bool IsMarkedForDeletion() const { return m_markedForDeletion; }
     // mark this to be deleted
     virtual void MarkForDeletion();
     virtual bool IsMarkedForDeletion() const { return m_markedForDeletion; }

-    
+

     // does the true work of stopping and cleaning up
     virtual void DoStop() = 0;
 protected :
     void CreateAndStartTimer();
     // does the true work of stopping and cleaning up
     virtual void DoStop() = 0;
 protected :
     void CreateAndStartTimer();

-    
+

     unsigned int m_flags;
     wxSoundTimer* m_pTimer;
     bool m_markedForDeletion;
     unsigned int m_flags;
     wxSoundTimer* m_pTimer;
     bool m_markedForDeletion;


@@ -49,25 +49,25 @@ class WXDLLIMPEXP_ADV wxSound : public wxSoundBase
 public:
     wxSound();
     wxSound(const wxString& fileName, bool isResource = false);
 public:
     wxSound();
     wxSound(const wxString& fileName, bool isResource = false);

-    wxSound(int size, const wxByte* data);
+    wxSound(size_t size, const void* data);

     virtual ~wxSound();
 
     // Create from resource or file
     bool  Create(const wxString& fileName, bool isResource = false);
     // Create from data
     virtual ~wxSound();
 
     // Create from resource or file
     bool  Create(const wxString& fileName, bool isResource = false);
     // Create from data

-    bool Create(int size, const wxByte* data);
+    bool Create(size_t size, const void* data);

 
     bool IsOk() const { return m_data != NULL; }
 
     bool IsOk() const { return m_data != NULL; }

-    
+

     // Stop playing any sound
     static void Stop();
     // Stop playing any sound
     static void Stop();

-    
+

     // Returns true if a sound is being played
     static bool IsPlaying();
     // Returns true if a sound is being played
     static bool IsPlaying();

-    
+

     // Notification when a sound has stopped
     static void SoundStopped(const wxSoundData* data);
     // Notification when a sound has stopped
     static void SoundStopped(const wxSoundData* data);

-    
+

 protected:
     bool    DoPlay(unsigned flags) const;
     void    Init();
 protected:
     bool    DoPlay(unsigned flags) const;
     void    Init();


@@ -75,7 +75,7 @@ protected:
 private:
     // data of this object
     class wxSoundData *m_data;
 private:
     // data of this object
     class wxSoundData *m_data;

-    
+

     wxDECLARE_NO_COPY_CLASS(wxSound);
 };
 
     wxDECLARE_NO_COPY_CLASS(wxSound);
 };