Add some comments.

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

diff --git a/gtk2_ardour/editor.cc b/gtk2_ardour/editor.cc
index 95a42d15f1920f85dfa7da34b51014c11276c519..c46a050ea78c965508b6e498d3499fbe7b0c9a6a 100644 (file)
--- 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 b103e32e5e55d880c477ebab7bfaaa3f35c52f90..66d2aa433586bc69baa287531cbafcf8a54f3557 100644 (file)
--- 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 d4f8cc3eb842a165f4239577577926d40b602735..f540998a1e2d90ff687c8205c4e8a68d48dce5f1 100644 (file)
--- 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 6693c51197430c6ecb62e8e0f7b2dc10735de7fd..46443c20e99c9a7b1203890e0dbab4f215af7a56 100644 (file)
--- 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 d4cfa1fb1f4cfe5055c2843f2a8ad9a4614753a6..6797119a1f2e0eafa416a8258baf7c8212566aac 100644 (file)
--- 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 26335bef3b985da9e8fe06b96ff333f96cd239ce..0730d371b958c23751bce4bcffbaa306ff607dcf 100644 (file)
--- 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 1e8874444c2d5fa01ce8a3b3c9d22f21df73a0db..638a621428bd3e49ef63a6f349d23d4b197b2771 100644 (file)
--- 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 ()
 {

diff --git a/libs/ardour/ardour/audio_diskstream.h b/libs/ardour/ardour/audio_diskstream.h
index 4846a20cbdc8463dcba98b971deb8eaffafb2132..1bf94a4494a48e8770c6087267a6e4752a715c83 100644 (file)
--- a/libs/ardour/ardour/audio_diskstream.h
+++ b/libs/ardour/ardour/audio_diskstream.h
@@ -192,7 +192,8 @@ 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;

diff --git a/libs/ardour/ardour/audioengine.h b/libs/ardour/ardour/audioengine.h
index a95bc0472bc83640f74be13dda2ea648505e9b31..fca3c2df9aa684aedb7167c7d0c7b21be94e279d 100644 (file)
--- a/libs/ardour/ardour/audioengine.h
+++ b/libs/ardour/ardour/audioengine.h
@@ -194,24 +194,27 @@ class AudioEngine : public sigc::trackable
        std::string make_port_name_non_relative (std::string);
 
   private:
-       ARDOUR::Session      *session;
-       jack_client_t       *_jack;
-       std::string           jack_client_name;
-       Glib::Mutex           _process_lock;
-       Glib::Cond            session_removed;
-       bool                  session_remove_pending;
-       bool                 _running;
-       bool                 _has_run;
-       nframes_t       _buffer_size;
-       nframes_t       _frame_rate;
-       nframes_t        monitor_check_interval;
-       nframes_t        last_monitor_check;
-       nframes_t       _processed_frames;
-       bool                 _freewheeling;
-       bool                 _freewheel_thread_registered;
-       sigc::slot<int,nframes_t>  freewheel_action;
-       bool                  reconnect_on_halt;
-       int                  _usecs_per_cycle;
+       ARDOUR::Session *session;
+       jack_client_t *_jack;
+       std::string jack_client_name;
+       Glib::Mutex _process_lock;
+       Glib::Cond session_removed;
+       bool session_remove_pending;
+       bool _running;
+       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;
+       sigc::slot<int,nframes_t> freewheel_action;
+       bool reconnect_on_halt;
+       int _usecs_per_cycle;
 
        SerializedRCUManager<Ports> ports;
 

diff --git a/libs/ardour/ardour/session.h b/libs/ardour/ardour/session.h
index f3e8d73de0ee9728e0be3eb74c1727cc4fd7f00d..bd415c441f403474fda54592eb9bc9cd0d871991 100644 (file)
--- a/libs/ardour/ardour/session.h
+++ b/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;

diff --git a/libs/ardour/audio_diskstream.cc b/libs/ardour/audio_diskstream.cc
index c635bf7809a12fd601a9209aedd6850742b327d6..7f791963493e282f8dec3975bb3b520cb65d954a 100644 (file)
--- a/libs/ardour/audio_diskstream.cc
+++ b/libs/ardour/audio_diskstream.cc
@@ -551,7 +551,7 @@ AudioDiskstream::process (nframes_t transport_frame, nframes_t nframes, nframes_
 
        for (chan = c->begin(); chan != c->end(); ++chan) {
                (*chan)->current_capture_buffer = 0;
-               (*chan)->current_playback_buffer  = 0;
+               (*chan)->current_playback_buffer = 0;
        }
 
        if (nominally_recording || (_session.get_record_enabled() && Config->get_punch_in())) {

diff --git a/libs/ardour/audioengine.cc b/libs/ardour/audioengine.cc
index 3b85ea2147c6fd26129769cd6c5ed9fc813adf36..cbdd1fda1ce8fc088c66161295cd3775a356dd66 100644 (file)
--- a/libs/ardour/audioengine.cc
+++ b/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 */
@@ -281,13 +292,15 @@ AudioEngine::process_callback (nframes_t nframes)
        } else {
                next_processed_frames = _processed_frames + 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;

diff --git a/libs/ardour/session_process.cc b/libs/ardour/session_process.cc
index 4f82de1c0ed1917b23462d2bc1ec3ef8bb46140a..5a8d80b58c81a9114579f190599d8444a3350e7e 100644 (file)
--- a/libs/ardour/session_process.cc
+++ b/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;
        }
 }

diff --git a/libs/ardour/session_transport.cc b/libs/ardour/session_transport.cc
index b199d77f97c7c44592f0f43d6a90461c8b18ed6f..d032e31b93febad22c2b8b90147888ab71d19ea4 100644 (file)
--- a/libs/ardour/session_transport.cc
+++ b/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)
 {

diff --git a/libs/pbd/undo.cc b/libs/pbd/undo.cc
index 4719d0968eb07cc70301f27ec50f07f291964089..5c7178b0d64150b2e6d9dd3c0360fa34fe910d1a 100644 (file)
--- a/libs/pbd/undo.cc
+++ b/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)
 {