summaryrefslogtreecommitdiff
path: root/indra/media_plugins
diff options
context:
space:
mode:
authorbea@american.lindenlab.com <bea@american.lindenlab.com>2009-12-03 08:47:59 -0800
committerbea@american.lindenlab.com <bea@american.lindenlab.com>2009-12-03 08:47:59 -0800
commit1973cdc4e622621e8e034f083794e922a1f387f4 (patch)
tree053cf761eec8b1d515a16f50c7b9eb120c97e02c /indra/media_plugins
parent916720dd110d089a295e2c28f1702da7e6725e83 (diff)
Add Doxygen comments
Diffstat (limited to 'indra/media_plugins')
-rw-r--r--indra/media_plugins/base/media_plugin_base.h20
1 files changed, 11 insertions, 9 deletions
diff --git a/indra/media_plugins/base/media_plugin_base.h b/indra/media_plugins/base/media_plugin_base.h
index 8f8e89f2e3..ed4dc0cfa9 100644
--- a/indra/media_plugins/base/media_plugin_base.h
+++ b/indra/media_plugins/base/media_plugin_base.h
@@ -114,15 +114,17 @@ protected:
};
/** The plugin <b>must</b> define this function to create its instance.
- * It should look something like this: \n
-{ \n
- MediaPluginFoo *self = new MediaPluginFoo(host_send_func, host_user_data); \n
- *plugin_send_func = MediaPluginFoo::staticReceiveMessage; \n
- *plugin_user_data = (void*)self; \n
- \n
- return 0; \n
-} \n
-*/
+ * It should look something like this:
+ * @code
+ * {
+ * MediaPluginFoo *self = new MediaPluginFoo(host_send_func, host_user_data);
+ * *plugin_send_func = MediaPluginFoo::staticReceiveMessage;
+ * *plugin_user_data = (void*)self;
+ *
+ * return 0;
+ * }
+ * @endcode
+ */
int init_media_plugin(
LLPluginInstance::sendMessageFunction host_send_func,
void *host_user_data,