fix mistaken "do not roll" conclusion in TransportFSM::compute_should_roll()

[ardour.git] / gtk2_ardour / midi_region_view.h

diff --git a/gtk2_ardour/midi_region_view.h b/gtk2_ardour/midi_region_view.h
index c13bd2d0abd859efc4b9786301d3e962e6c9c0ab..6d5a6c250658f5017f5d52c67072dffe7ce95a0a 100644 (file)
--- a/gtk2_ardour/midi_region_view.h
+++ b/gtk2_ardour/midi_region_view.h
@@ -1,20 +1,26 @@
 /*
-    Copyright (C) 2001-2011 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) 2006-2015 David Robillard <d@drobilla.net>
+ * Copyright (C) 2008-2012 Hans Baier <hansfbaier@googlemail.com>
+ * Copyright (C) 2008-2017 Paul Davis <paul@linuxaudiosystems.com>
+ * Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
+ * Copyright (C) 2015-2016 Tim Mayberry <mojofunk@gmail.com>
+ * Copyright (C) 2015-2017 Nick Mainsbridge <mainsbridge@gmail.com>
+ * Copyright (C) 2015-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_midi_region_view_h__
 #define __gtk_ardour_midi_region_view_h__
@@ -131,7 +137,7 @@ public:
        /** Look up the given time and channel in the 'automation' and set keys accordingly.
         * @param time the time of the patch change event
         * @param channel the MIDI channel of the event
-        * @key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
+        * @param key a reference to an instance of MIDI::Name::PatchPrimaryKey whose fields will
         *        will be set according to the result of the lookup
         */
        void get_patch_key_at (Temporal::Beats time, uint8_t channel, MIDI::Name::PatchPrimaryKey& key) const;
@@ -155,6 +161,8 @@ public:
        void delete_sysex (SysEx*);
 
        /** Change a patch to the next or previous bank/program.
+        *
+        * @param patch The patch-change instance (canvas item)
         * @param bank If true, step bank, otherwise, step program.
         * @param delta Amount to adjust number.
         */
@@ -210,8 +218,11 @@ public:
        void select_matching_notes (uint8_t notenum, uint16_t channel_mask, bool add, bool extend);
        void toggle_matching_notes (uint8_t notenum, uint16_t channel_mask);
 
-       /** Return true iff the note is within the extent of the region.
+       /** Test if a note is within this region's range
+        *
+        * @param note the note to test
         * @param visible will be set to true if the note is within the visible note range, false otherwise.
+        * @return true iff the note is within the (time) extent of the region.
         */
        bool note_in_region_range(const boost::shared_ptr<NoteType> note, bool& visible) const;