Add some comments.

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

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>

gtk2_ardour/editor.h

@@ -349,6 +349,7 @@ class Editor : public PublicEditor
 
   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;

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>
 

gtk2_ardour/editor_ops.cc

@@ -17,6 +17,8 @@
 
 */
 
+/* Note: public Editor methods are documented in public_editor.h */
+
 #include <unistd.h>
 
 #include <cstdlib>

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()
 {
 }

gtk2_ardour/public_editor.h

@@ -73,6 +73,13 @@ 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 ();
@@ -80,25 +87,84 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway
 
 	typedef list<TimeAxisView *> TrackViewList;
 
+	/** @return Singleton PublicEditor instance */
 	static PublicEditor& instance () { return *_instance; }
 
-	virtual void             connect_to_session (ARDOUR::Session*) = 0;
+	/** 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;
-	virtual void set_snap_to (Editing::SnapType) = 0;
-	virtual void set_snap_mode (Editing::SnapMode) = 0;
-	virtual void set_snap_threshold (double) = 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;
+
+	/** 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;
+
+	/** @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;
+
+	/** @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;
@@ -112,8 +178,16 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway
 	virtual void play_selection () = 0;
 	virtual void set_show_measures (bool yn) = 0;
 	virtual bool show_measures () const = 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;
@@ -131,9 +205,19 @@ 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;
+
+	/** @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;
@@ -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;

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 ()
 {

libs/ardour/ardour/audio_diskstream.h

@@ -193,6 +193,7 @@ class AudioDiskstream : public Diskstream
 	    boost::shared_ptr<AudioFileSource> fades_source;
 	    boost::shared_ptr<AudioFileSource> write_source;
 
+	    /// the Port that our audio data comes from
 	    Port         *source;
 	    Sample       *current_capture_buffer;
 	    Sample       *current_playback_buffer;

libs/ardour/ardour/audioengine.h

@@ -204,8 +204,11 @@ class AudioEngine : public sigc::trackable
 	bool _has_run;
 	nframes_t _buffer_size;
 	nframes_t _frame_rate;
+	/// number of frames between each check for changes in monitor input
 	nframes_t monitor_check_interval;
+	/// time of the last monitor check in frames
 	nframes_t last_monitor_check;
+	/// the number of frames processed since start() was called
 	nframes_t _processed_frames;
 	bool _freewheeling;
 	bool _freewheel_thread_registered;

libs/ardour/ardour/session.h

@@ -762,6 +762,9 @@ class Session : public PBD::StatefulDestructible
 
 	/* History (for editors, mixers, UIs etc.) */
 
+	/** Undo some transactions.
+	 * @param n Number of transactions to undo.
+	 */
 	void undo (uint32_t n) {
 		_history.undo (n);
 	}
@@ -983,6 +986,7 @@ class Session : public PBD::StatefulDestructible
 
 	AudioEngine            &_engine;
 	mutable gint            processing_prohibited;
+	/// the function called when the main JACK process callback happens
 	process_function_type    process_function;
 	process_function_type    last_process_function;
 	bool                     waiting_for_sync_offset;

libs/ardour/audioengine.cc

@@ -255,6 +255,11 @@ AudioEngine::_graph_order_callback (void *arg)
 	return 0;
 }
 
+/** Wrapped which is called by JACK as its process callback.  It is just
+ * here to get us back into C++ land by calling AudioEngine::process_callback()
+ * @param nframes Number of frames passed by JACK.
+ * @param arg User argument passed by JACK, which will be the AudioEngine*.
+ */
 int
 AudioEngine::_process_callback (nframes_t nframes, void *arg)
 {
@@ -267,11 +272,17 @@ AudioEngine::_freewheel_callback (int onoff, void *arg)
 	static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
 }
 
+/** Method called by JACK (via _process_callback) which says that there
+ * is work to be done.
+ * @param nframes Number of frames to process.
+ */
 int
 AudioEngine::process_callback (nframes_t nframes)
 {
 	// CycleTimer ct ("AudioEngine::process");
 	Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
+
+	/// The number of frames that will have been processed when we've finished
 	nframes_t next_processed_frames;
 	
 	/* handle wrap around of total frames counter */
@@ -283,11 +294,13 @@ AudioEngine::process_callback (nframes_t nframes)
 	}
 
 	if (!tm.locked() || session == 0) {
+		/* return having done nothing */
 		_processed_frames = next_processed_frames;
 		return 0;
 	}
 
 	if (session_remove_pending) {
+		/* perform the actual session removal */
 		session = 0;
 		session_remove_pending = false;
 		session_removed.signal();
@@ -296,6 +309,7 @@ AudioEngine::process_callback (nframes_t nframes)
 	}
 
 	if (_freewheeling) {
+		/* emit the Freewheel signal and stop freewheeling in the event of trouble */
 		if (Freewheel (nframes)) {
 			cerr << "Freewheeling returned non-zero!\n";
 			_freewheeling = false;

libs/ardour/session_process.cc

@@ -44,6 +44,9 @@ using namespace ARDOUR;
 using namespace PBD;
 using namespace std;
 
+/** Called by the audio engine when there is work to be done with JACK.
+ * @param nframes Number of frames to process.
+ */
 void
 Session::process (nframes_t nframes)
 {
@@ -255,7 +258,7 @@ Session::commit_diskstreams (nframes_t nframes, bool &needs_butler)
 	}
 }
 
-
+/** Process callback used when the auditioner is not active */
 void
 Session::process_with_events (nframes_t nframes)
 {
@@ -354,6 +357,8 @@ Session::process_with_events (nframes_t nframes)
 
 		offset = 0;
 
+		/* yes folks, here it is, the actual loop where we really truly
+		   process some audio */
 		while (nframes) {
 
 			this_nframes = nframes; /* real (jack) time relative */
@@ -804,6 +809,9 @@ Session::process_without_events (nframes_t nframes)
 		summon_butler ();
 }
 
+/** Process callback used when the auditioner is active.
+ * @param nframes number of frames to process.
+ */
 void
 Session::process_audition (nframes_t nframes)
 {
@@ -840,6 +848,7 @@ Session::process_audition (nframes_t nframes)
 	}
 
 	if (!auditioner->active()) {
+		/* auditioner no longer active, so go back to the normal process callback */
 		process_function = &Session::process_with_events;
 	}
 }

libs/ardour/session_transport.cc

@@ -718,6 +718,10 @@ Session::locate (nframes_t target_frame, bool with_roll, bool with_flush, bool w
 	_send_smpte_update = true;
 }
 
+/** Set the transport speed.
+ * @param speed New speed
+ * @param abort
+ */
 void
 Session::set_transport_speed (float speed, bool abort)
 {
@@ -733,6 +737,8 @@ Session::set_transport_speed (float speed, bool abort)
 
 	if (transport_rolling() && speed == 0.0) {
 
+		/* we are rolling and we want to stop */
+
 		if (Config->get_monitoring_model() == HardwareMonitoring)
 		{
 			boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
@@ -753,6 +759,8 @@ Session::set_transport_speed (float speed, bool abort)
 		
 	} else if (transport_stopped() && speed == 1.0) {
 
+		/* we are stopped and we want to start rolling at speed 1 */
+
 		if (!get_record_enabled() && Config->get_stop_at_session_end() && _transport_frame >= current_end_frame()) {
 			return;
 		}
@@ -825,6 +833,8 @@ Session::set_transport_speed (float speed, bool abort)
 	}
 }
 
+
+/** Stop the transport.  */
 void
 Session::stop_transport (bool abort)
 {

libs/pbd/undo.cc

@@ -174,6 +174,9 @@ UndoHistory::remove (UndoTransaction* const ut)
 	Changed (); /* EMIT SIGNAL */
 }
 
+/** Undo some transactions.
+ * @param n Number of transactions to undo.
+ */
 void
 UndoHistory::undo (unsigned int n)
 {