Add some comments.

git-svn-id: svn://localhost/ardour2/trunk@1837 d708f5d6-7413-0410-9779-e7cbd77b26cf

7 files changed, 149 insertions, 49 deletions

diff --git a/gtk2_ardour/editor.cc b/gtk2_ardour/editor.cc
index 95a42d15f1..c46a050ea7 100644
--- a/gtk2_ardour/editor.cc
+++ b/gtk2_ardour/editor.cc
@@ -17,6 +17,8 @@
 
 */
 
+/* Note: public Editor methods are documented in public_editor.h */
+
 #include <unistd.h>
 #include <cstdlib>
 #include <cmath>
diff --git a/gtk2_ardour/editor.h b/gtk2_ardour/editor.h
index b103e32e5e..66d2aa4335 100644
--- a/gtk2_ardour/editor.h
+++ b/gtk2_ardour/editor.h
@@ -348,7 +348,8 @@ class Editor : public PublicEditor
 	void on_realize();
 
   private:
-	
+
+	/// The session that we are editing, or 0
 	ARDOUR::Session     *session;
 	bool                 constructed;
 
@@ -1048,6 +1049,8 @@ class Editor : public PublicEditor
 
 	Editing::SnapType snap_type;
 	Editing::SnapMode snap_mode;
+
+	/// Snap threshold in pixels
 	double snap_threshold;
 
 	void handle_gui_changes (const string &, void *);
@@ -1206,8 +1209,11 @@ class Editor : public PublicEditor
 	/* display control */
 	
 	bool _show_measures;
+	/// true to show waveforms, otherwise false
 	bool _show_waveforms;
+	/// true if the editor should follow the playhead, otherwise false
 	bool _follow_playhead;
+	/// true if waveforms should be shown while recording audio tracks, otherwise false
 	bool _show_waveforms_recording;
 	
 	ARDOUR::TempoMap::BBTPointList *current_bbt_points;
diff --git a/gtk2_ardour/editor_export_audio.cc b/gtk2_ardour/editor_export_audio.cc
index d4f8cc3eb8..f540998a1e 100644
--- a/gtk2_ardour/editor_export_audio.cc
+++ b/gtk2_ardour/editor_export_audio.cc
@@ -17,6 +17,8 @@
 
 */
 
+/* Note: public Editor methods are documented in public_editor.h */
+
 #include <unistd.h>
 #include <climits>
 
diff --git a/gtk2_ardour/editor_ops.cc b/gtk2_ardour/editor_ops.cc
index 6693c51197..46443c20e9 100644
--- a/gtk2_ardour/editor_ops.cc
+++ b/gtk2_ardour/editor_ops.cc
@@ -17,6 +17,8 @@
 
 */
 
+/* Note: public Editor methods are documented in public_editor.h */
+
 #include <unistd.h>
 
 #include <cstdlib>
diff --git a/gtk2_ardour/public_editor.cc b/gtk2_ardour/public_editor.cc
index d4cfa1fb1f..6797119a1f 100644
--- a/gtk2_ardour/public_editor.cc
+++ b/gtk2_ardour/public_editor.cc
@@ -22,11 +22,13 @@
 
 PublicEditor* PublicEditor::_instance = 0;
 
+/** PublicEditor constructor */
 PublicEditor::PublicEditor ()
   	: Window (Gtk::WINDOW_TOPLEVEL)
 {
 }
 
+/** PublicEditor destructor */
 PublicEditor::~PublicEditor()
 {
 }
diff --git a/gtk2_ardour/public_editor.h b/gtk2_ardour/public_editor.h
index 26335bef3b..0730d371b9 100644
--- a/gtk2_ardour/public_editor.h
+++ b/gtk2_ardour/public_editor.h
@@ -73,32 +73,98 @@ class ImageFrameView;
 class ImageFrameTimeAxis;
 class MarkerView;
 
+/// Representation of the interface of the Editor class
+
+/** This class contains just the public interface of the Editor class,
+ * in order to decouple it from the private implementation, so that callers
+ * of PublicEditor need not be recompiled if private methods or member variables
+ * change.
+ */
 class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway {
   public:
-	PublicEditor();
-	virtual ~PublicEditor();
+	PublicEditor ();
+	virtual ~PublicEditor ();
 
 	typedef list<TimeAxisView *> TrackViewList;
 
-	static PublicEditor& instance() { return *_instance; }
+	/** @return Singleton PublicEditor instance */
+	static PublicEditor& instance () { return *_instance; }
+
+	/** Attach this editor to a Session.
+	 * @param s Session to connect to.
+	 */
+	virtual void connect_to_session (ARDOUR::Session* s) = 0;
+
+	/** @return The Session that we are editing, or 0 */
+	virtual ARDOUR::Session* current_session () const = 0;
+
+	/** Set the snap type.
+	 * @param t Snap type (defined in editing_syms.h)
+	 */
+	virtual void set_snap_to (Editing::SnapType t) = 0;
+
+	/** Set the snap mode.
+	 * @param m Snap mode (defined in editing_syms.h)
+	 */
+	virtual void set_snap_mode (Editing::SnapMode m) = 0;
+
+	/** Set the snap threshold.
+	 * @param t Snap threshold in `units'.
+	 */
+	virtual void set_snap_threshold (double t) = 0;
 
-	virtual void             connect_to_session (ARDOUR::Session*) = 0;
-	virtual ARDOUR::Session* current_session() const = 0;
-	virtual void set_snap_to (Editing::SnapType) = 0;
-	virtual void set_snap_mode (Editing::SnapMode) = 0;
-	virtual void set_snap_threshold (double) = 0;
+	/** Undo some transactions.
+	 * @param n Number of transactions to undo.
+	 */
 	virtual void undo (uint32_t n = 1) = 0;
+
+	/** Redo some transactions.
+	 * @param n Number of transaction to redo.
+	 */
 	virtual void redo (uint32_t n = 1) = 0;
-	virtual void set_mouse_mode (Editing::MouseMode, bool force = false) = 0;
+
+	/** Set the mouse mode (gain, object, range, timefx etc.)
+	 * @param m Mouse mode (defined in editing_syms.h)
+	 * @param force Perform the effects of the change even if no change is required
+	 * (ie even if the current mouse mode is equal to \ref m)
+	 */
+	virtual void set_mouse_mode (Editing::MouseMode m, bool force = false) = 0;
+
+	/** Step the mouse mode onto the next or previous one.
+	 * @param next true to move to the next, otherwise move to the previous
+	 */
 	virtual void step_mouse_mode (bool next) = 0;
+
+	/** @return The current mouse mode (gain, object, range, timefx etc.)
+	 * (defined in editing_syms.h)
+	 */
 	virtual Editing::MouseMode current_mouse_mode () const = 0;
-	virtual void consider_auditioning (boost::shared_ptr<ARDOUR::Region>) = 0;
+
+	/** Possibly start the audition of a region.  If \ref r is 0, or not an AudioRegion
+	 * any current audition is cancelled.  If we are currently auditioning \ref r,
+	 * the audition will be cancelled.  Otherwise an audition of \ref r will start.
+	 * \param r Region to consider.
+	 */
+	virtual void consider_auditioning (boost::shared_ptr<ARDOUR::Region> r) = 0;
+
+	/** Set whether waveforms should be shown for audio tracks.
+	 * @param yn true to show waveforms, otherwise false.
+	 */
 	virtual void set_show_waveforms (bool yn) = 0;
-	virtual bool show_waveforms() const = 0;
+
+	/** @return true if waveforms are being shown, otherwise false */
+	virtual bool show_waveforms () const = 0;
+
+	/** Set whether waveforms should be shown while recording audio tracks.
+	 * @param yn true to show waveforms, otherwise false.
+	 */
 	virtual void set_show_waveforms_recording (bool yn) = 0;
-	virtual bool show_waveforms_recording() const = 0;
+
+	/** @return true if waveforms are being shown while recording, otherwise false */
+	virtual bool show_waveforms_recording () const = 0;
 	virtual void new_region_from_selection () = 0;
 	virtual void separate_region_from_selection () = 0;
+
 	virtual void toggle_playback (bool with_abort) = 0;
 	virtual void transition_to_rolling (bool fwd) = 0;
 	virtual nframes_t unit_to_frame (double unit) = 0;
@@ -106,21 +172,29 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway
 	virtual double frame_to_unit (double frame) = 0;
 	virtual nframes_t pixel_to_frame (double pixel) = 0;
 	virtual gulong frame_to_pixel (nframes_t frame) = 0;
-	virtual Selection& get_selection() const = 0;
-	virtual Selection& get_cut_buffer() const = 0;
+	virtual Selection& get_selection () const = 0;
+	virtual Selection& get_cut_buffer () const = 0;
 	virtual bool extend_selection_to_track (TimeAxisView&) = 0;
 	virtual void play_selection () = 0;
 	virtual void set_show_measures (bool yn) = 0;
 	virtual bool show_measures () const = 0;
-	virtual void export_session() = 0;
-	virtual void export_selection() = 0;
-	virtual void export_range_markers() = 0;
-	virtual void register_actions() = 0;
+
+	/** Open an export dialogue for the whole session */
+	virtual void export_session () = 0;
+
+	/** Open an export dialogue for currently selected time range, if there
+	 * is one; if not an error is displayed to the user.
+	 */
+	virtual void export_selection () = 0;
+
+	/** Open an export dialogue for marked ranges */
+	virtual void export_range_markers () = 0;
+	virtual void register_actions () = 0;
 	virtual void add_toplevel_controls (Gtk::Container&) = 0;
-	virtual void      set_zoom_focus (Editing::ZoomFocus) = 0;
+	virtual void set_zoom_focus (Editing::ZoomFocus) = 0;
 	virtual Editing::ZoomFocus get_zoom_focus () const = 0;
-	virtual gdouble   get_current_zoom () = 0;
-	virtual PlaylistSelector& playlist_selector() const = 0;
+	virtual gdouble get_current_zoom () = 0;
+	virtual PlaylistSelector& playlist_selector () const = 0;
 	virtual void route_name_changed (TimeAxisView *) = 0;
 	virtual void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>) = 0;
 	virtual void new_playlists () = 0;
@@ -131,15 +205,25 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway
 	virtual void set_selected_mixer_strip (TimeAxisView&) = 0;
 	virtual void hide_track_in_display (TimeAxisView& tv) = 0;
 	virtual void show_track_in_display (TimeAxisView& tv) = 0;
+
+	/** Set whether the editor should follow the playhead.
+	 * @param yn true to follow playhead, otherwise false.
+	 */
 	virtual void set_follow_playhead (bool yn) = 0;
+
+	/** Toggle whether the editor is following the playhead */
 	virtual void toggle_follow_playhead () = 0;
-	virtual bool follow_playhead() const = 0;
-	virtual bool dragging_playhead() const = 0;
+
+	/** @return true if the editor is following the playhead */
+	virtual bool follow_playhead () const = 0;
+
+	/** @return true if the playhead is currently being dragged, otherwise false */
+	virtual bool dragging_playhead () const = 0;
 	virtual void ensure_float (Gtk::Window&) = 0;
 	virtual void show_window () = 0;
 	virtual TrackViewList* get_valid_views (TimeAxisView*, ARDOUR::RouteGroup* grp = 0) = 0;
-	virtual nframes_t leftmost_position() const = 0;
-	virtual nframes_t current_page_frames() const = 0;
+	virtual nframes_t leftmost_position () const = 0;
+	virtual nframes_t current_page_frames () const = 0;
 	virtual void temporal_zoom_step (bool coarser) = 0;
 	virtual void scroll_tracks_down_line () = 0;
 	virtual void scroll_tracks_up_line () = 0;
@@ -147,9 +231,9 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway
 	virtual void prepare_for_cleanup () = 0;
 	virtual void reset_x_origin (nframes_t frame) = 0;
 	virtual void remove_last_capture () = 0;
-	virtual void maximise_editing_space() = 0;
-	virtual void restore_editing_space() = 0;
-	virtual nframes_t edit_cursor_position(bool sync) = 0;
+	virtual void maximise_editing_space () = 0;
+	virtual void restore_editing_space () = 0;
+	virtual nframes_t edit_cursor_position (bool sync) = 0;
 
 #ifdef WITH_CMT
 	virtual void add_imageframe_time_axis(const std::string & track_name, void*)  = 0;
@@ -167,26 +251,26 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway
 
 	Glib::RefPtr<Gtk::ActionGroup> editor_actions;
 
-	virtual void reset_focus() = 0;
-
-	virtual bool canvas_control_point_event (GdkEvent* event,ArdourCanvas::Item*, ControlPoint*) = 0;
-	virtual bool canvas_line_event (GdkEvent* event,ArdourCanvas::Item*, AutomationLine*) = 0;
-	virtual bool canvas_selection_rect_event (GdkEvent* event,ArdourCanvas::Item*, SelectionRect*) = 0;
-	virtual bool canvas_selection_start_trim_event (GdkEvent* event,ArdourCanvas::Item*, SelectionRect*) = 0;
-	virtual bool canvas_selection_end_trim_event (GdkEvent* event,ArdourCanvas::Item*, SelectionRect*) = 0;
-	virtual bool canvas_crossfade_view_event (GdkEvent* event,ArdourCanvas::Item*, CrossfadeView*) = 0;
-	virtual bool canvas_fade_in_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*) = 0;
-	virtual bool canvas_fade_in_handle_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*) = 0;
-	virtual bool canvas_fade_out_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*) = 0;
-	virtual bool canvas_fade_out_handle_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*) = 0;
-	virtual bool canvas_region_view_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*) = 0;
-	virtual bool canvas_region_view_name_highlight_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*) = 0;
-	virtual bool canvas_region_view_name_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*) = 0;
-	virtual bool canvas_stream_view_event (GdkEvent* event,ArdourCanvas::Item*, RouteTimeAxisView*) = 0;
-	virtual bool canvas_marker_event (GdkEvent* event,ArdourCanvas::Item*, Marker*) = 0;
-	virtual bool canvas_zoom_rect_event (GdkEvent* event,ArdourCanvas::Item*) = 0;
-	virtual bool canvas_tempo_marker_event (GdkEvent* event,ArdourCanvas::Item*, TempoMarker*) = 0;
-	virtual bool canvas_meter_marker_event (GdkEvent* event,ArdourCanvas::Item*, MeterMarker*) = 0;
+	virtual void reset_focus () = 0;
+
+	virtual bool canvas_control_point_event (GdkEvent* event, ArdourCanvas::Item*, ControlPoint*) = 0;
+	virtual bool canvas_line_event (GdkEvent* event, ArdourCanvas::Item*, AutomationLine*) = 0;
+	virtual bool canvas_selection_rect_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
+	virtual bool canvas_selection_start_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
+	virtual bool canvas_selection_end_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
+	virtual bool canvas_crossfade_view_event (GdkEvent* event, ArdourCanvas::Item*, CrossfadeView*) = 0;
+	virtual bool canvas_fade_in_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
+	virtual bool canvas_fade_in_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
+	virtual bool canvas_fade_out_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
+	virtual bool canvas_fade_out_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
+	virtual bool canvas_region_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
+	virtual bool canvas_region_view_name_highlight_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
+	virtual bool canvas_region_view_name_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
+	virtual bool canvas_stream_view_event (GdkEvent* event, ArdourCanvas::Item*, RouteTimeAxisView*) = 0;
+	virtual bool canvas_marker_event (GdkEvent* event, ArdourCanvas::Item*, Marker*) = 0;
+	virtual bool canvas_zoom_rect_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
+	virtual bool canvas_tempo_marker_event (GdkEvent* event, ArdourCanvas::Item*, TempoMarker*) = 0;
+	virtual bool canvas_meter_marker_event (GdkEvent* event, ArdourCanvas::Item*, MeterMarker*) = 0;
 	virtual bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*) = 0;
 
 	virtual bool canvas_tempo_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
@@ -206,6 +290,7 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway
 	virtual bool canvas_markerview_end_handle_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*) = 0;
 #endif
 
+	/// Singleton instance, set up by Editor::Editor()
 	static PublicEditor* _instance;
 
 	friend class PluginUIWindow;
diff --git a/gtk2_ardour/selection.cc b/gtk2_ardour/selection.cc
index 1e8874444c..638a621428 100644
--- a/gtk2_ardour/selection.cc
+++ b/gtk2_ardour/selection.cc
@@ -67,6 +67,7 @@ operator== (const Selection& a, const Selection& b)
 		a.redirects == b.redirects;
 }
 
+/** Clear everything from the Selection */
 void
 Selection::clear ()
 {