updated doxygen documentation

[chaz/openbox] / src / xatom.hh

diff --git a/src/xatom.hh b/src/xatom.hh
index d92b01f0f0b3265d69423c03ffb7f8427ce8c26b..0b5ec43590611d174b83239208527f827bc8b8be 100644 (file)
--- a/src/xatom.hh
+++ b/src/xatom.hh
@@ -1,37 +1,24 @@
 // XAtom.h for Openbox
-// Copyright (c) 2002 - 2002 Ben Janens (ben at orodu.net)
-//
-// Permission is hereby granted, free of charge, to any person obtaining a
-// copy of this software and associated documentation files (the "Software"),
-// to deal in the Software without restriction, including without limitation
-// the rights to use, copy, modify, merge, publish, distribute, sublicense,
-// and/or sell copies of the Software, and to permit persons to whom the
-// Software is furnished to do so, subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in
-// all copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
-// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-// DEALINGS IN THE SOFTWARE.
-
 #ifndef   __XAtom_h
 #define   __XAtom_h
 
+/*! @file xatom.hh
+  @brief Provides access to atoms on the display
+*/
+
+extern "C" {
 #include <X11/Xlib.h>
 #include <X11/Xatom.h>
 
 #include <assert.h>
+}
 
 #include <vector>
 #include <string>
 
-class Blackbox;
-class ScreenInfo;
+#include "otk/screeninfo.hh"
+
+namespace ob {
 
 class XAtom {
 public:
@@ -190,7 +177,7 @@ public:
 
   // setup support on a screen, each screen should call this once in its
   // constructor.
-  void setSupported(const ScreenInfo *screen);
+  void setSupported(const otk::ScreenInfo *screen);
   
   void setValue(Window win, Atoms atom, Atoms type, unsigned long value) const;
   void setValue(Window win, Atoms atom, Atoms type,
@@ -227,4 +214,6 @@ public:
     assert(ret != 0); return ret; }
 };
 
+}
+
 #endif // __XAtom_h