From 9026ac3264b00636a72a0c196b02cdac96b2c156 Mon Sep 17 00:00:00 2001
From: "bea@american.lindenlab.com" <bea@american.lindenlab.com>
Date: Tue, 1 Dec 2009 18:47:36 -0800
Subject: Add Doxygen comments

---
 indra/media_plugins/base/media_plugin_base.h | 42 ++++++++++++++++++++--------
 1 file changed, 30 insertions(+), 12 deletions(-)

(limited to 'indra/media_plugins/base/media_plugin_base.h')

diff --git a/indra/media_plugins/base/media_plugin_base.h b/indra/media_plugins/base/media_plugin_base.h
index 4dd157a07c..8f8e89f2e3 100644
--- a/indra/media_plugins/base/media_plugin_base.h
+++ b/indra/media_plugins/base/media_plugin_base.h
@@ -42,14 +42,17 @@ class MediaPluginBase
 {
 public:
 	MediaPluginBase(LLPluginInstance::sendMessageFunction host_send_func, void *host_user_data);
+   /** Media plugin destructor. */
 	virtual ~MediaPluginBase() {}
 
+   /** Handle received message from plugin loader shell. */
 	virtual void receiveMessage(const char *message_string) = 0;
 	
 	static void staticReceiveMessage(const char *message_string, void **user_data);
 
 protected:
 
+   /** Plugin status. */
 	typedef enum 
 	{
 		STATUS_NONE,
@@ -61,10 +64,13 @@ protected:
 		STATUS_DONE
 	} EStatus;
 
+   /** Plugin shared memory. */
 	class SharedSegmentInfo
 	{
 	public:
+      /** Shared memory address. */
 		void *mAddress;
+      /** Shared memory size. */
 		size_t mSize;
 	};
 
@@ -73,42 +79,54 @@ protected:
 	std::string statusString();
 	void setStatus(EStatus status);		
 	
-	// The quicktime plugin overrides this to add current time and duration to the message...
+	/// Note: The quicktime plugin overrides this to add current time and duration to the message.
 	virtual void setDirty(int left, int top, int right, int bottom);
 
+   /** Map of shared memory names to shared memory. */
 	typedef std::map<std::string, SharedSegmentInfo> SharedSegmentMap;
 
 	
+   /** Function to send message from plugin to plugin loader shell. */
 	LLPluginInstance::sendMessageFunction mHostSendFunction;
+   /** Message data being sent to plugin loader shell by mHostSendFunction. */
 	void *mHostUserData;
+   /** Flag to delete plugin instance (self). */
 	bool mDeleteMe;
+   /** Pixel array to display. TODO:DOC are pixels always 24-bit RGB format, aligned on 32-bit boundary? Also: calling this a pixel array may be misleading since 1 pixel > 1 char. */
 	unsigned char* mPixels;
+   /** TODO:DOC what's this for -- does a texture have its own piece of shared memory? updated on size_change_request, cleared on shm_remove */
 	std::string mTextureSegmentName;
+   /** Width of plugin display in pixels. */
 	int mWidth;
+   /** Height of plugin display in pixels. */
 	int mHeight;
+   /** Width of plugin texture. */
 	int mTextureWidth;
+   /** Height of plugin texture. */
 	int mTextureHeight;
+   /** Pixel depth (pixel size in bytes). */
 	int mDepth;
+   /** Current status of plugin. */
 	EStatus mStatus;
+   /** Map of shared memory segments. */
 	SharedSegmentMap mSharedSegments;
 
 };
 
-// The plugin must define this function to create its instance.
+/** 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
+*/
 int init_media_plugin(
 	LLPluginInstance::sendMessageFunction host_send_func, 
 	void *host_user_data, 
 	LLPluginInstance::sendMessageFunction *plugin_send_func, 
 	void **plugin_user_data);
 
-// It should look something like this:
-/*
-{
-	MediaPluginFoo *self = new MediaPluginFoo(host_send_func, host_user_data);
-	*plugin_send_func = MediaPluginFoo::staticReceiveMessage;
-	*plugin_user_data = (void*)self;
-
-	return 0;
-}
-*/
 
-- 
cgit v1.2.3


From 1973cdc4e622621e8e034f083794e922a1f387f4 Mon Sep 17 00:00:00 2001
From: "bea@american.lindenlab.com" <bea@american.lindenlab.com>
Date: Thu, 3 Dec 2009 08:47:59 -0800
Subject: Add Doxygen comments

---
 indra/media_plugins/base/media_plugin_base.h | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

(limited to 'indra/media_plugins/base/media_plugin_base.h')

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, 
-- 
cgit v1.2.3