Merged revisions 6293,6296-6306,6308 via svnmerge from

[ardour.git] / libs / gtkmm2 / gtk / gtkmm / targetlist.h

diff --git a/libs/gtkmm2/gtk/gtkmm/targetlist.h b/libs/gtkmm2/gtk/gtkmm/targetlist.h
index 286d533ee1cb27531238039b67f368d54e34b80b..f6e07584bf119f3c3fe1b404048d86848903e15b 100644 (file)
--- a/libs/gtkmm2/gtk/gtkmm/targetlist.h
+++ b/libs/gtkmm2/gtk/gtkmm/targetlist.h
@@ -3,6 +3,7 @@
 #ifndef _GTKMM_TARGETLIST_H
 #define _GTKMM_TARGETLIST_H
 
+
 #include <glibmm.h>
 
 /* Copyright(C) 2002 The gtkmm Development Team
@@ -68,11 +69,24 @@ public:
   static Glib::RefPtr<Gtk::TargetList> create(const ArrayHandle_TargetEntry& targets);
   
  
+  /** Appends another target to a Gtk::TargetList.
+   * @param target The interned atom representing the target.
+   * @param flags The flags for this target.
+   * @param info An ID that will be passed back to the application.
+   */
   void add(const Glib::ustring& target, TargetFlags flags = TargetFlags(0), guint info = 0);
   void add(const ArrayHandle_TargetEntry& targets);
   
+  /** Removes a target from a target list.
+   * @param target The interned atom representing the target.
+   */
   void remove(const Glib::ustring& target);
   
+  /** Looks up a given target in a Gtk::TargetList.
+   * @param target An interned atom representing the target to search for.
+   * @param info A pointer to the location to store application info for target.
+   * @return <tt>true</tt> if the target was found, otherwise <tt>false</tt>.
+   */
   bool find(const Glib::ustring& target, guint* info) const;
 
 
@@ -84,14 +98,18 @@ public:
 namespace Glib
 {
 
-  /** @relates Gtk::TargetList
-   * @param object The C instance
+  /** A Glib::wrap() method for this object.
+   * 
+   * @param object The C instance.
    * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
    * @result A C++ instance that wraps this C instance.
+   *
+   * @relates Gtk::TargetList
    */
   Glib::RefPtr<Gtk::TargetList> wrap(GtkTargetList* object, bool take_copy = false);
 
 } // namespace Glib
 
+
 #endif /* _GTKMM_TARGETLIST_H */