Adding Doxygen comments

1 files changed, 27 insertions, 1 deletions

diff --git a/indra/llplugin/llplugininstance.cpp b/indra/llplugin/llplugininstance.cpp
index 16ba492669..bb25475a59 100644
--- a/indra/llplugin/llplugininstance.cpp
+++ b/indra/llplugin/llplugininstance.cpp
@@ -37,13 +37,21 @@
 
 #include "llapr.h"
 
-//virtual 
+/** Virtual destructor. */
 LLPluginInstanceMessageListener::~LLPluginInstanceMessageListener()
 {
 }
 
+/** 
+ * Name of plugin init function. TODO:DOC need to 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?
+ */
 LLPluginInstance::LLPluginInstance(LLPluginInstanceMessageListener *owner) :
 	mDSOHandle(NULL),
 	mPluginUserData(NULL),
@@ -52,6 +60,9 @@ LLPluginInstance::LLPluginInstance(LLPluginInstanceMessageListener *owner) :
 	mOwner = owner;
 }
 
+/** 
+ * Destructor.
+ */
 LLPluginInstance::~LLPluginInstance()
 {
 	if(mDSOHandle != NULL)
@@ -61,6 +72,12 @@ LLPluginInstance::~LLPluginInstance()
 	}
 }
 
+/** 
+ * Dynamically loads the plugin and runs the plugin's init function.
+ *
+ * @param[in] plugin_file Name of plugin dll/dylib/so. TODO:DOC is this correct? see .h
+ * @return 0 if successful, APR error code or error code from the plugin's init function on failure.
+ */
 int LLPluginInstance::load(std::string &plugin_file)
 {
 	pluginInitFunction init_function = NULL;
@@ -102,6 +119,11 @@ int LLPluginInstance::load(std::string &plugin_file)
 	return (int)result;
 }
 
+/** 
+ * Sends a message to the plugin.
+ *
+ * @param[in] message Message
+ */
 void LLPluginInstance::sendMessage(const std::string &message)
 {
 	if(mPluginSendMessageFunction)
@@ -115,6 +137,10 @@ void LLPluginInstance::sendMessage(const std::string &message)
 	}
 }
 
+/**
+ * Idle. TODO:DOC what's the purpose of this?
+ *
+ */
 void LLPluginInstance::idle(void)
 {
 }