finish conversion to the new otk::OBProperty class with its new interface

[chaz/openbox] / otk / property.hh

diff --git a/otk/property.hh b/otk/property.hh
index 73a98e5dfa4b4d8b35952e5db388fa899f29b356..215f941f47b8d7021713e3f6003869a1665658f0 100644 (file)
--- a/otk/property.hh
+++ b/otk/property.hh
@@ -141,15 +141,19 @@ public:
     kde_net_wm_system_tray_window_for,
     kde_net_wm_window_type_override,
  
+#ifndef DOXYGEN_IGNORE
     // constant for how many atoms exist in the enumerator
     NUM_ATOMS
+#endif
   };
 
   //! The possible types/encodings of strings
   enum StringType {
     ascii, //!< Standard 8-bit ascii string
     utf8,  //!< Utf8-encoded string
+#ifndef DOXYGEN_IGNORE
     NUM_STRING_TYPE
+#endif
   };
 
 private:
@@ -181,7 +185,7 @@ public:
   //! Destroys the OBAtom object
   virtual ~OBProperty();
 
-  //! Sets a property on a window to a new value
+  //! Sets a single-value property on a window to a new value
   /*!
     @param win The window id of the window on which to set the property's value
     @param atom A member of the OBProperty::Atoms enum that specifies which
@@ -191,7 +195,7 @@ public:
     @param value The value to set the property to
   */
   void set(Window win, Atoms atom, Atoms type, unsigned long value) const;
-  //! Sets a property on a window to a new value
+  //! Sets an multiple-value property on a window to a new value
   /*!
     @param win The window id of the window on which to set the property's value
     @param atom A member of the OBProperty::Atoms enum that specifies which
@@ -204,7 +208,7 @@ public:
   */
   void set(Window win, Atoms atom, Atoms type,
            unsigned long value[], int elements) const;
-  //! Sets a property on a window to a new value
+  //! Sets a string property on a window to a new value
   /*!
     @param win The window id of the window on which to set the property's value
     @param atom A member of the OBProperty::Atoms enum that specifies which
@@ -215,7 +219,7 @@ public:
   */
   void set(Window win, Atoms atom, StringType type,
            const std::string &value) const;
-  //! Sets a property on a window to a new value
+  //! Sets a string-array property on a window to a new value
   /*!
     @param win The window id of the window on which to set the property's value
     @param atom A member of the OBProperty::Atoms enum that specifies which
@@ -291,8 +295,8 @@ public:
                      retrieve all possible strings, use "(unsigned) -1".<br>
                      When the function returns, if it returns true, this will
                      contain the actual number of strings retrieved.<br>
-    @param value If the function returns true, then this contains all of the
-                 strings retrieved from the property's value.
+    @param strings If the function returns true, then this contains all of the
+                   strings retrieved from the property's value.
     @return true if retrieval of the specified property with the specified
             type was successful; otherwise, false
   */
@@ -301,9 +305,9 @@ public:
 
   //! Removes a property from a window
   /*!
-    @param The window id of the window to remove the property from
-    @param A member of the OBProperty::Atoms enum that specifies which property
-           to remove from the window
+    @param win The window id of the window to remove the property from
+    @param atom A member of the OBProperty::Atoms enum that specifies which
+                property to remove from the window
   */
   void erase(Window win, Atoms atom) const;