From 62b545128f37746c343760e464872655b5523c6f Mon Sep 17 00:00:00 2001
From: erihel <erihel@gmail.com>
Date: Sun, 12 Aug 2012 18:37:11 +0200
Subject: * Final changes to plugin interface * Added doxygen comments to
 plugin manager and plugin loader

---
 src/sound/plugins/oalsound/alsound.cpp | 9 +++++----
 src/sound/plugins/oalsound/alsound.h   | 4 ++--
 src/sound/sound.h                      | 8 ++++----
 3 files changed, 11 insertions(+), 10 deletions(-)

(limited to 'src/sound')

diff --git a/src/sound/plugins/oalsound/alsound.cpp b/src/sound/plugins/oalsound/alsound.cpp
index a1d4801..8cd8221 100644
--- a/src/sound/plugins/oalsound/alsound.cpp
+++ b/src/sound/plugins/oalsound/alsound.cpp
@@ -27,15 +27,15 @@
 PLUGIN_INTERFACE(ALSound)
 
 
-char* ALSound::PluginName()
+std::string ALSound::PluginName()
 {
-    return const_cast<char *>("Sound plugin using OpenAL library to play sounds.");
+    return "Sound plugin using OpenAL library to play sounds.";
 }
 
 
 int ALSound::PluginVersion()
 {
-    return 1;
+    return 2;
 }
 
 
@@ -47,12 +47,13 @@ void ALSound::InstallPlugin()
 }
 
 
-void ALSound::UninstallPlugin()
+bool ALSound::UninstallPlugin(std::string &reason)
 {
     auto pointer = CInstanceManager::GetInstancePointer();
     if (pointer != nullptr)
         CInstanceManager::GetInstancePointer()->DeleteInstance(CLASS_SOUND, this);
     CleanUp();
+    return true;
 }
 
 
diff --git a/src/sound/plugins/oalsound/alsound.h b/src/sound/plugins/oalsound/alsound.h
index 9265e2c..c1cdb81 100644
--- a/src/sound/plugins/oalsound/alsound.h
+++ b/src/sound/plugins/oalsound/alsound.h
@@ -74,10 +74,10 @@ class ALSound : public CSoundInterface
         bool IsPlayingMusic();
 
         // plugin interface
-        char* PluginName();
+        std::string PluginName();
         int PluginVersion();
         void InstallPlugin();
-        void UninstallPlugin();
+        bool UninstallPlugin(std::string &);
 
     private:
         void CleanUp();
diff --git a/src/sound/sound.h b/src/sound/sound.h
index f18a76a..45ec7e1 100644
--- a/src/sound/sound.h
+++ b/src/sound/sound.h
@@ -15,10 +15,10 @@
 // * You should have received a copy of the GNU General Public License
 // * along with this program. If not, see  http://www.gnu.org/licenses/.
 
-// soundinterface.h
+// sound.h
 
 /**
- *  @file sound/soundinterface.h
+ *  @file sound/sound.h
  *  @brief Sound plugin interface
  */
 
@@ -39,7 +39,7 @@
 
 /**
  * \public
- * \enum    Sound   sound/soundinterface.h
+ * \enum    Sound   sound/sound.h
  * \brief   Sound enum representing sound file
 **/
 enum Sound
@@ -131,7 +131,7 @@ enum Sound
 
 /**
  * \public
- * \enum    SoundNext   sound/soundinterface.h
+ * \enum    SoundNext   sound/sound.h
  * \brief   Enum representing operation that will be performend on a sound at given time
 **/
 enum SoundNext
-- 
cgit v1.2.3-1-g7c22