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/pluginloader.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/pluginloader.h')
-rw-r--r-- | src/plugins/pluginloader.h | 41 |
1 files changed, 20 insertions, 21 deletions
diff --git a/src/plugins/pluginloader.h b/src/plugins/pluginloader.h index 3dfa20b..e8c2c73 100644 --- a/src/plugins/pluginloader.h +++ b/src/plugins/pluginloader.h @@ -14,68 +14,67 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// pluginloader.h - /** - * @file plugin/pluginloader.h - * @brief Plugin loader interface + * \file plugins/pluginloader.h + * \brief Plugin loader interface */ #pragma once -#include <ltdl.h> -#include <string> #include "common/logger.h" -#include "plugininterface.h" +#include "plugins/plugininterface.h" + +#include <ltdl.h> +#include <string> /** -* @class CPluginLoader -* -* @brief Plugin loader interface. Plugin manager uses this class to load plugins. -* -*/ + * \class CPluginLoader + * + * \brief Plugin loader interface. Plugin manager uses this class to load plugins. + * + */ class CPluginLoader { public: /** Class contructor - * @param std::string plugin filename + * \param filename plugin filename */ - CPluginLoader(std::string); + CPluginLoader(std::string filename); /** Function to get plugin name or description - * @return returns plugin name + * \return returns plugin name */ std::string GetName(); /** Function to get plugin version - * @return returns plugin version + * \return returns plugin version */ int GetVersion(); /** Function to unload plugin - * @return returns true on success + * \return returns true on success */ bool UnloadPlugin(); /** Function to load plugin - * @return returns true on success + * \return returns true on success */ bool LoadPlugin(); /** Function to check if plugin is loaded - * @return returns true if plugin is loaded + * \return returns true if plugin is loaded */ bool IsLoaded(); /** Function to set plugin filename - * @return returns true on success. Action can fail if plugin was loaded and cannot be unloaded + * \return returns true on success. Action can fail if plugin was loaded and cannot be unloaded */ bool SetFilename(std::string); /** Function to get plugin filename - * @return returns plugin filename + * \return returns plugin filename */ std::string GetFilename(); |