Changed: #1193 Update doxygen documentation.

This commit is contained in:
dnk-88 2010-12-05 20:33:58 +02:00
parent 0245a69e63
commit 31b8ed8eb0
3 changed files with 30 additions and 1 deletions

View file

@ -33,6 +33,14 @@ namespace NLMISC
namespace NLQT
{
/**
@interface IPlugin
@brief Base class for all plugins.
@details The IPlugin class is an abstract class that must be implemented
once for each plugin. The IPlugin implementation must be exported and
made known to Qt's plugin system via the Q_EXPORT_PLUGIN macro,
see the Qt documentation for details on that.
*/
class IPlugin
{
public:

View file

@ -28,6 +28,14 @@ namespace NLQT
{
class IPluginSpec;
/**
@interface IPluginManager
@brief Interface for plugin system that manages the plugins, their life cycle and their registered objects.
@details The plugin manager is used for the following tasks:
- Manage plugins and their state
- Manipulate a 'common object pool'
*/
class IPluginManager: public QObject
{
Q_OBJECT

View file

@ -27,6 +27,11 @@ namespace NLQT
class IPlugin;
class IPluginManager;
/**
@struct State
@details The plugin goes through several steps while being loaded.
The state gives a hint on what went wrong in case of an error.
*/
struct State
{
enum List
@ -41,6 +46,14 @@ struct State
};
};
/**
@interface IPluginSpec
@brief Interface for plugin spec contains the information of the plugins and
information about the plugin's current state.
@details The plugin spec is also filled with more information as the plugin
goes through its loading process (see State).
If an error occurs, the plugin spec is the place to look for the error details.
*/
class IPluginSpec
{
public: