livie
/
phoenix-firestorm
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix some missing Doxygen comments

master
bea@american.lindenlab.com 2009-12-04 14:37:50 -08:00
parent dab659adea
commit 13eeba25d8
4 changed files with 25 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
indra/llplugin/llplugininstance.cpp
View File

@ -43,14 +43,14 @@ LLPluginInstanceMessageListener::~LLPluginInstanceMessageListener()
}
/**
* Name of plugin init function. TODO:DOC need to describe how it's used?
* TODO:DOC describe how it's used
*/
const char *LLPluginInstance::PLUGIN_INIT_FUNCTION_NAME = "LLPluginInitEntryPoint";
/**
* Constructor.
*
* @param[in] owner Plugin instance. TODO:DOC is this a good description?
* @param[in] owner Plugin instance. TODO:DOC is this a good description of what "owner" is?
*/
LLPluginInstance::LLPluginInstance(LLPluginInstanceMessageListener *owner) :
mDSOHandle(NULL),
@ -154,6 +154,11 @@ void LLPluginInstance::staticReceiveMessage(const char *message_string, void **u
self->receiveMessage(message_string);
}
/**
* Plugin receives message from plugin loader shell.
*
* @param[in] message_string Message
*/
void LLPluginInstance::receiveMessage(const char *message_string)
{
if(mOwner)

8
indra/llplugin/llplugininstance.h
View File

@ -1,6 +1,5 @@
/**
* @file llplugininstance.h
* @brief LLPluginInstance handles loading the dynamic library of a plugin and setting up its entry points for message passing.
*
* @cond
* $LicenseInfo:firstyear=2008&license=viewergpl$
@ -39,13 +38,20 @@
#include "apr_dso.h"
/**
* @brief LLPluginInstanceMessageListener receives messages sent from the plugin loader shell to the plugin.
*/
class LLPluginInstanceMessageListener
{
public:
virtual ~LLPluginInstanceMessageListener();
/** Plugin receives message from plugin loader shell. */
virtual void receivePluginMessage(const std::string &message) = 0;
};
/**
* @brief LLPluginInstance handles loading the dynamic library of a plugin and setting up its entry points for message passing.
*/
class LLPluginInstance
{
LOG_CLASS(LLPluginInstance);

6
indra/llplugin/llpluginmessage.cpp
View File

@ -387,12 +387,18 @@ int LLPluginMessage::parse(const std::string &message)
}
/**
* Destructor
*/
LLPluginMessageListener::~LLPluginMessageListener()
{
// TODO: should listeners have a way to ensure they're removed from dispatcher lists when deleted?
}
/**
* Destructor
*/
LLPluginMessageDispatcher::~LLPluginMessageDispatcher()
{

8
indra/llplugin/llpluginmessage.h
View File

@ -1,6 +1,5 @@
/**
* @file llpluginmessage.h
* @brief LLPluginMessage encapsulates the serialization/deserialization of messages passed to and from plugins.
*
* @cond
* $LicenseInfo:firstyear=2008&license=viewergpl$
@ -36,7 +35,9 @@
#include "llsd.h"
/**
* @brief LLPluginMessage encapsulates the serialization/deserialization of messages passed to and from plugins.
*/
class LLPluginMessage
{
LOG_CLASS(LLPluginMessage);
@ -105,12 +106,13 @@ private:
};
/**
* @brief Listens for plugin messages.
* @brief Listener for plugin messages.
*/
class LLPluginMessageListener
{
public:
virtual ~LLPluginMessageListener();
/** Plugin receives message from plugin loader shell. */
virtual void receivePluginMessage(const LLPluginMessage &message) = 0;
};