No more doxygen warnings for gtk2_arodur/*

[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 9396dc76c2118f1037fadd75be32a4b658399a45..6d5a6c250658f5017f5d52c67072dffe7ce95a0a 100644 (file)
--- a/gtk2_ardour/midi_region_view.h
+++ b/gtk2_ardour/midi_region_view.h
@@ -137,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;
@@ -161,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.
         */
@@ -216,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;