diff options
author | Kristopher Ives <kris@leetbook2.(none)> | 2009-10-25 00:35:05 -0700 |
---|---|---|
committer | Kristopher Ives <kris@leetbook2.(none)> | 2009-10-25 00:35:05 -0700 |
commit | 93bbbd5a59919da92190b8c3116a5986adf5e79b (patch) | |
tree | 4171cf82f810ea411ea4e89eda4adfc53aa9c27d /include | |
parent | e69b9b2279d28149d83675590101ff54ed79a10e (diff) | |
download | zcomp-93bbbd5a59919da92190b8c3116a5986adf5e79b.tar.gz zcomp-93bbbd5a59919da92190b8c3116a5986adf5e79b.tar.bz2 |
Fixed some old /// docs.
Added class description docs for some structs and classes.
Diffstat (limited to 'include')
-rw-r--r-- | include/core/pluginclasses.h | 1 | ||||
-rw-r--r-- | include/core/screen.h | 14 |
2 files changed, 11 insertions, 4 deletions
diff --git a/include/core/pluginclasses.h b/include/core/pluginclasses.h index 0122a63..ae1a824 100644 --- a/include/core/pluginclasses.h +++ b/include/core/pluginclasses.h @@ -30,6 +30,7 @@ #include <vector> + class PluginClassIndex { public: PluginClassIndex () : index ((unsigned)~0), refCount (0), diff --git a/include/core/screen.h b/include/core/screen.h index fe182cb..abd7ca7 100644 --- a/include/core/screen.h +++ b/include/core/screen.h @@ -67,6 +67,9 @@ typedef boost::function<void (const char *)> FileWatchCallBack; typedef int CompFileWatchHandle; typedef int CompWatchFdHandle; +/** + * Information needed to invoke a CallBack when a file changes. + */ struct CompFileWatch { CompString path; int mask; @@ -85,6 +88,9 @@ struct CompActiveWindowHistory { int activeNum; }; +/** + * Interface to an abstract screen. + */ class ScreenInterface : public WrapableInterface<CompScreen, ScreenInterface> { public: virtual void fileWatchAdded (CompFileWatch *fw); @@ -124,10 +130,10 @@ class ScreenInterface : public WrapableInterface<CompScreen, ScreenInterface> { virtual void outputChangeNotify (); }; -/// -/// A wrapping of the X display screen. This takes care of communication to the -/// X server. -/// +/** + * A wrapping of the X display screen. This takes care of communication to the + * X server. + */ class CompScreen : public CompSize, public WrapableHandler<ScreenInterface, 17>, |