Fixed some old comments syntax.

Added some docs for some internals to CompPlugin.
Added some docs for some internals for CompAction.

4 files changed, 61 insertions, 40 deletions

diff --git a/include/core/action.h b/include/core/action.h
index e24a6d1..006ba30 100644
--- a/include/core/action.h
+++ b/include/core/action.h
@@ -55,6 +55,9 @@ class PrivateAction;
 
 #define CompNoMask         (1 << 25)
 
+/**
+ * Context of an event occuring.
+ */
 class CompAction {
     public:
 	typedef enum {
@@ -72,7 +75,10 @@ class CompAction {
 	    StateAutoGrab    = 1 << 11,
 	    StateNoEdgeDelay = 1 << 12
 	} StateEnum;
-
+	
+	/**
+	 * Type of event a CompAction is bound to.
+	 */
 	typedef enum {
 	    BindingTypeNone       = 0,
 	    BindingTypeKey        = 1 << 0,
diff --git a/include/core/modifierhandler.h b/include/core/modifierhandler.h
index 5620ce8..72c4b1e 100644
--- a/include/core/modifierhandler.h
+++ b/include/core/modifierhandler.h
@@ -28,6 +28,9 @@
 
 #include <core/core.h>
 
+/**
+ * TODO
+ */
 class ModifierHandler
 {
     public:
diff --git a/include/core/plugin.h b/include/core/plugin.h
index 04f404b..0592a75 100644
--- a/include/core/plugin.h
+++ b/include/core/plugin.h
@@ -88,9 +88,9 @@ class CompPlugin {
 		void initVTable (CompString         name,
 				 CompPlugin::VTable **self = NULL);
 		
-		///
-		/// Gets the name of this compiz plugin
-		///
+		/**
+		 * Gets the name of this compiz plugin
+		 */
 		const CompString name () const;
 
 		virtual bool init () = 0;
@@ -114,6 +114,9 @@ class CompPlugin {
 		VTable       **mSelf;
         };
 
+    /**
+     * TODO (or not?)
+     */
 	template <typename T, typename T2>
 	class VTableForScreenAndWindow : public VTable {
 	    bool initScreen (CompScreen *s);
@@ -129,6 +132,9 @@ class CompPlugin {
 	    bool setOption (const CompString &name, CompOption::Value &value);
 	};
 
+    /**
+     * TODO (or not?)
+     */
 	template <typename T>
 	class VTableForScreen : public VTable {
 	    bool initScreen (CompScreen *s);
@@ -139,7 +145,10 @@ class CompPlugin {
 
 	    bool setOption (const CompString &name, CompOption::Value &value);
 	};
-
+	
+	/**
+	 * Interface for matching plugins by name.
+	 */
 	struct cmpStr
 	{
 	    bool operator () (const char *a, const char *b) const
@@ -166,57 +175,57 @@ class CompPlugin {
 
 	static void windowFiniPlugins (CompWindow *w);
 	
-	///
-	/// Finds a plugin by name. (TODO Does it have to be loaded?)
-	///
+	/**
+	 * Finds a plugin by name. (TODO Does it have to be loaded?)
+	 */
 	static CompPlugin *find (const char *name);
 	
-	///
-	/// Load a compiz plugin. Loading a plugin that has
-	/// already been loaded will return the existing instance.
-	///
+	/**
+	 * Load a compiz plugin. Loading a plugin that has
+	 * already been loaded will return the existing instance.
+	 */
 	static CompPlugin *load (const char *plugin);
 	
-	///
-	/// Unload a compiz plugin. Unloading a plugin multiple times has no
-	/// effect, and you can't unload a plugin that hasn't been loaded already
-	/// with CompPlugin::load()
-	///
+	/**
+	 * Unload a compiz plugin. Unloading a plugin multiple times has no
+	 * effect, and you can't unload a plugin that hasn't been loaded already
+	 * with CompPlugin::load()
+	 */
 	static void unload (CompPlugin *p);
 	
-	///
-	/// Adds a plugin onto the working set of active plugins. If the plugin fails to initPlugin
-	/// this will return false and the plugin will not be added to the working set.
-	///
+	/**
+	 * Adds a plugin onto the working set of active plugins. If the plugin fails to initPlugin
+	 * this will return false and the plugin will not be added to the working set.
+	 */
 	static bool push (CompPlugin *p);
 	
-	///
-	/// Removes the last activated plugin with CompPlugin::push() and returns
-	/// the removed plugin, or NULL if there was none.
-	///
+	/**
+	 * Removes the last activated plugin with CompPlugin::push() and returns
+	 * the removed plugin, or NULL if there was none.
+	 */
 	static CompPlugin *pop (void);
 	
-	///
-	/// Gets a list of the working set of plugins that have been CompPlugin::push() but not
-	/// CompPlugin::pop()'d.
-	///
+	/**
+	 * Gets a list of the working set of plugins that have been CompPlugin::push() but not
+	 * CompPlugin::pop()'d.
+	 */
 	static List & getPlugins ();
 	
-	///
-	/// Gets a list of the names of all the known plugins, including plugins that may
-	/// have already been loaded.
-	///
+	/**
+	 * Gets a list of the names of all the known plugins, including plugins that may
+	 * have already been loaded.
+	 */
 	static std::list<CompString> availablePlugins ();
 	
-	///
-	/// Gets the Application Binary Interface (ABI) version of a (un)loaded plugin.
-	///
+	/**
+	 * Gets the Application Binary Interface (ABI) version of a (un)loaded plugin.
+	 */
 	static int getPluginABI (const char *name);
 	
-	///
-	/// Verifies a signature to ensure that the plugin conforms to the Application Binary
-	/// Interface (ABI) 
-	///
+	/**
+	 * Verifies a signature to ensure that the plugin conforms to the Application Binary
+	 * Interface (ABI) 
+	 */
 	static bool checkPluginABI (const char *name,
 				    int	        abi);
 
diff --git a/include/core/screen.h b/include/core/screen.h
index abd7ca7..2b76537 100644
--- a/include/core/screen.h
+++ b/include/core/screen.h
@@ -81,6 +81,9 @@ typedef std::list<CompFileWatch *> CompFileWatchList;
 #define ACTIVE_WINDOW_HISTORY_SIZE 64
 #define ACTIVE_WINDOW_HISTORY_NUM  32
 
+/**
+ * Information about the last activity with a window.
+ */
 struct CompActiveWindowHistory {
     Window id[ACTIVE_WINDOW_HISTORY_SIZE];
     int    x;