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/plugininterface.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/plugininterface.h')
-rw-r--r-- | src/plugins/plugininterface.h | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/src/plugins/plugininterface.h b/src/plugins/plugininterface.h index 6554b44..838dbfd 100644 --- a/src/plugins/plugininterface.h +++ b/src/plugins/plugininterface.h @@ -14,17 +14,17 @@ // * You should have received a copy of the GNU General Public License // * along with this program. If not, see http://www.gnu.org/licenses/. -// plugininterface.h - /** - * @file plugin/plugininterface.h - * @brief Generic plugin interface + * \file plugins/plugininterface.h + * \brief Generic plugin interface */ #pragma once + #include <string> + #define PLUGIN_INTERFACE(class_type) \ static class_type* Plugin##class_type; \ extern "C" void InstallPluginEntry() { Plugin##class_type = new class_type(); Plugin##class_type->InstallPlugin(); } \ @@ -37,29 +37,29 @@ /** -* @class CPluginInterface -* -* @brief Generic plugin interface. All plugins that will be managed by plugin manager have to derive from this class. -* -*/ + * \class CPluginInterface + * + * \brief Generic plugin interface. All plugins that will be managed by plugin manager have to derive from this class. + * + */ class CPluginInterface { public: /** Function to get plugin name or description - * @return returns plugin name + * \return returns plugin name */ - inline virtual std::string PluginName() { return "abc"; }; + inline virtual std::string PluginName() { return "abc"; } /** Function to get plugin version. 1 means version 0.01, 2 means 0.02 etc. - * @return number indicating plugin version + * \return number indicating plugin version */ - inline virtual int PluginVersion() { return 0; }; + inline virtual int PluginVersion() { return 0; } /** Function to initialize plugin */ - inline virtual void InstallPlugin() {}; + inline virtual void InstallPlugin() {} /** Function called before removing plugin */ - inline virtual bool UninstallPlugin(std::string &) { return true; }; + inline virtual bool UninstallPlugin(std::string &) { return true; } }; |