No more doxygen warnings for gtk2_arodur/*

[ardour.git] / gtk2_ardour / group_tabs.h

diff --git a/gtk2_ardour/group_tabs.h b/gtk2_ardour/group_tabs.h
index fc8f50b2bc9fb46ac50e5c0e82c73725bf8e3273..7ddd4d54c9d3638118588a1ad73362c79b95d057 100644 (file)
--- a/gtk2_ardour/group_tabs.h
+++ b/gtk2_ardour/group_tabs.h
@@ -1,21 +1,23 @@
 /*
-    Copyright (C) 2009 Paul Davis
-
-    This program is free software; you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-*/
+ * Copyright (C) 2009-2011 Carl Hetherington <carl@carlh.net>
+ * Copyright (C) 2009-2011 David Robillard <d@drobilla.net>
+ * Copyright (C) 2009-2017 Paul Davis <paul@linuxaudiosystems.com>
+ * Copyright (C) 2014-2017 Robin Gareus <robin@gareus.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
 
 #ifndef __gtk_ardour_group_tabs_h__
 #define __gtk_ardour_group_tabs_h__
@@ -47,8 +49,12 @@ public:
 
        void set_session (ARDOUR::Session *);
 
-       /** @param g Route group, or 0.
-         *  @return Menu to be popped up on right-click over the given route group.
+       /** Create route-group context menu
+        *
+        * @param g Route group, or 0.
+        * @param tabArea false if context menu is not for a group tab, show the "create new from" items here.
+        *                 When true a given group's context menu for the group \p g is displayed.
+        * @return Menu to be popped up on right-click over the given route group.
         */
        Gtk::Menu* get_menu (ARDOUR::RouteGroup* g, bool tabArea = false);
 
@@ -70,7 +76,7 @@ protected:
        };
 
 private:
-       static void emit_gui_changed_for_members (ARDOUR::RouteGroup *);
+       static void emit_gui_changed_for_members (boost::shared_ptr<ARDOUR::RouteList>);
 
        /** Compute all the tabs for this widget.
         *  @return Tabs.
@@ -83,11 +89,12 @@ private:
         */
        virtual void draw_tab (cairo_t* cr, Tab const & t) = 0;
 
-       /** @param x x coordinate
-        *  @param y y coordinate
-        *  @return x or y, depending on which is the primary coordinate for this widget.
+       /** Coordinate map (editor, mixer)
+        * @param x x-coordinate
+        * @param y y-coordinate
+        * @return x or y, depending on which is the primary coordinate for this widget.
         */
-       virtual double primary_coordinate (double, double) const = 0;
+       virtual double primary_coordinate (double x, double y) const = 0;
 
        virtual ARDOUR::RouteList routes_for_tab (Tab const * t) const = 0;
 
@@ -110,7 +117,7 @@ private:
        void set_activation (ARDOUR::RouteGroup *, bool);
        void edit_group (ARDOUR::RouteGroup *);
        void subgroup (ARDOUR::RouteGroup *, bool, ARDOUR::Placement);
-        void un_subgroup (ARDOUR::RouteGroup *);
+       void un_subgroup (ARDOUR::RouteGroup *);
        void activate_all ();
        void disable_all ();
        void remove_group (ARDOUR::RouteGroup *);
@@ -132,7 +139,7 @@ private:
        void assign_selection_to_master (uint32_t which);
        void assign_recenabled_to_master (uint32_t which);
        void assign_soloed_to_master (uint32_t which);
-       void assign_some_to_master (uint32_t which, ARDOUR::RouteList);
+       void assign_some_to_master (uint32_t which, ARDOUR::RouteList, std::string vcaname = "");
 
        ARDOUR::RouteList get_soloed ();
        ARDOUR::RouteList get_rec_enabled ();