summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorKristopher Ives <kris@leetbook2.(none)>2009-10-25 01:10:52 -0700
committerKristopher Ives <kris@leetbook2.(none)>2009-10-25 01:10:52 -0700
commitfae3b156daeb3cd833ab9d7ff1e4b13b904be7c7 (patch)
tree3dc8b9074bd4ca164fbbddf191573613c9cc5178 /include
parent1c67a54b84ed35a8ed9c99034a88db937d9479bd (diff)
downloadzcomp-fae3b156daeb3cd833ab9d7ff1e4b13b904be7c7.tar.gz
zcomp-fae3b156daeb3cd833ab9d7ff1e4b13b904be7c7.tar.bz2
Added documentation for some internal classes.
Fixed some old comments.
Diffstat (limited to 'include')
-rw-r--r--include/core/option.h30
-rw-r--r--include/core/plugin.h10
-rw-r--r--include/core/window.h13
3 files changed, 31 insertions, 22 deletions
diff --git a/include/core/option.h b/include/core/option.h
index 0a70e41..09cf033 100644
--- a/include/core/option.h
+++ b/include/core/option.h
@@ -39,14 +39,14 @@ class CompAction;
class CompMatch;
class CompScreen;
-///
-/// A configuration option with boolean, int, float, String, Color, Key, Button,
-/// Edge, Bell, or List.
-///
+/**
+ * A configuration option with boolean, int, float, String, Color, Key, Button,
+ * Edge, Bell, or List.
+ */
class CompOption {
- ///
- /// Option data types
- ///
+ /**
+ * Option data types
+ */
public:
typedef enum {
TypeBool,
@@ -65,9 +65,9 @@ class CompOption {
TypeUnset
} Type;
- ///
- /// A value of an Option
- ///
+ /**
+ * A value of an Option
+ */
class Value {
public:
typedef std::vector<Value> Vector;
@@ -126,7 +126,10 @@ class CompOption {
private:
PrivateValue *priv;
};
-
+
+ /**
+ * TODO
+ */
class Restriction {
public:
Restriction ();
@@ -151,7 +154,10 @@ class CompOption {
};
typedef std::vector<CompOption> Vector;
-
+
+ /**
+ * TODO
+ */
class Class {
public:
virtual Vector & getOptions () = 0;
diff --git a/include/core/plugin.h b/include/core/plugin.h
index 0592a75..3fc3da5 100644
--- a/include/core/plugin.h
+++ b/include/core/plugin.h
@@ -73,11 +73,11 @@ union CompPrivate {
void *(*fptr) (void);
};
-///
-/// Base plug-in interface for Compiz. All plugins must implement this
-/// interface, which provides basics for loading, unloading, options,
-/// and linking together the plugin and Screen(s).
-///
+/**
+ * Base plug-in interface for Compiz. All plugins must implement this
+ * interface, which provides basics for loading, unloading, options,
+ * and linking together the plugin and Screen(s).
+ */
class CompPlugin {
public:
class VTable {
diff --git a/include/core/window.h b/include/core/window.h
index bc46dfc..8ac4df6 100644
--- a/include/core/window.h
+++ b/include/core/window.h
@@ -246,16 +246,19 @@ class WindowInterface : public WrapableInterface<CompWindow, WindowInterface>
virtual bool isFocussable ();
};
-///
-/// An Window object that wraps an X window. This handles snychronization of
-/// window state, geometry, etc. between Compiz and the X server.
-///
+/**
+ * An Window object that wraps an X window. This handles snychronization of
+ * window state, geometry, etc. between Compiz and the X server.
+ */
class CompWindow :
public WrapableHandler<WindowInterface, 15>,
public PluginClassStorage
{
public:
-
+
+ /**
+ * A mutable object about the dimensions and location of a CompWindow.
+ */
class Geometry : public CompRect
{
public: