diff options
author | Piotr Dziwinski <piotrdz@gmail.com> | 2012-10-17 21:55:45 +0200 |
---|---|---|
committer | Piotr Dziwinski <piotrdz@gmail.com> | 2012-10-17 21:55:45 +0200 |
commit | f6e27099b294d55c15a6b5dad13cda7730a17a71 (patch) | |
tree | 2ce292b3fc476767bc4cd0040cea0fb83242146e /src/plugins/pluginmanager.h | |
parent | 9738631e5e49f6b8edc32b9128e0c5d52f7df44f (diff) | |
download | colobot-f6e27099b294d55c15a6b5dad13cda7730a17a71.tar.gz colobot-f6e27099b294d55c15a6b5dad13cda7730a17a71.tar.bz2 colobot-f6e27099b294d55c15a6b5dad13cda7730a17a71.zip |
Doxygen/comment fixes and some #include refactoring
Diffstat (limited to 'src/plugins/pluginmanager.h')
-rw-r--r-- | src/plugins/pluginmanager.h | 51 |
1 files changed, 25 insertions, 26 deletions
diff --git a/src/plugins/pluginmanager.h b/src/plugins/pluginmanager.h index 7a69820..2798483 100644 --- a/src/plugins/pluginmanager.h +++ b/src/plugins/pluginmanager.h @@ -14,33 +14,32 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// pluginmanager.h - /** - * @file plugin/pluginmanager.h - * @brief Plugin manager class. + * \file plugins/pluginmanager.h + * \brief Plugin manager class. */ #pragma once -#include <string> -#include <set> -#include <vector> #include "common/logger.h" #include "common/profile.h" #include "common/singleton.h" -#include "pluginloader.h" +#include "plugins/pluginloader.h" + +#include <string> +#include <set> +#include <vector> /** -* @class CPluginManager -* -* @brief Plugin manager class. Plugin manager can load plugins from colobot.ini or manually specified files. -* -*/ + * \class CPluginManager + * + * \brief Plugin manager class. Plugin manager can load plugins from colobot.ini or manually specified files. + * + */ class CPluginManager : public CSingleton<CPluginManager> { public: CPluginManager(); @@ -51,31 +50,31 @@ class CPluginManager : public CSingleton<CPluginManager> { void LoadFromProfile(); /** Function loads specified plugin - * @param std::string plugin filename - * @return returns true on success + * \param filename plugin filename + * \return returns true on success */ - bool LoadPlugin(std::string); + bool LoadPlugin(std::string filename); /** Function unloads specified plugin - * @param std::string plugin filename - * @return returns true on success + * \param filename plugin filename + * \return returns true on success */ - bool UnloadPlugin(std::string); + bool UnloadPlugin(std::string filename); /** Function adds path to be checked when searching for plugin file. If path was already added it will be ignored - * @param std::string plugin search path - * @return returns true on success + * \param dir plugin search path + * \return returns true on success */ - bool AddSearchDirectory(std::string); + bool AddSearchDirectory(std::string dir); /** Function removes path from list - * @param std::string plugin search path - * @return returns true on success + * \param dir plugin search path + * \return returns true on success */ - bool RemoveSearchDirectory(std::string); + bool RemoveSearchDirectory(std::string dir); /** Function tries to unload all plugins - * @return returns true on success + * \return returns true on success */ bool UnloadAllPlugins(); |