summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarl Hetherington <carl@carlh.net>2011-11-16 02:03:30 +0000
committerCarl Hetherington <carl@carlh.net>2011-11-16 02:03:30 +0000
commit6e1aa92eb82071868fd2e24838344d6c2aa8ba5b (patch)
treeb33d4d169eb9bf55bc0c3d11c2a88c9b936787af
parente4ce7667545253d478160554b8ad0a661588f622 (diff)
Doxygen tweaks.
git-svn-id: svn://localhost/ardour2/branches/3.0@10644 d708f5d6-7413-0410-9779-e7cbd77b26cf
-rw-r--r--gtk2_ardour/ardour_ui.cc2
-rw-r--r--libs/ardour/ardour/diskstream.h7
-rw-r--r--libs/evoral/src/libsmf/smf.h2
3 files changed, 8 insertions, 3 deletions
diff --git a/gtk2_ardour/ardour_ui.cc b/gtk2_ardour/ardour_ui.cc
index b4ae6131a0..749e70e2ac 100644
--- a/gtk2_ardour/ardour_ui.cc
+++ b/gtk2_ardour/ardour_ui.cc
@@ -2511,8 +2511,6 @@ ARDOUR_UI::build_session_from_nsd (const std::string& session_path, const std::s
bus_profile.input_ac = AutoConnectOption (0);
}
- /// @todo some minor tweaks.
-
bus_profile.output_ac = AutoConnectOption (0);
if (_startup->connect_outputs ()) {
diff --git a/libs/ardour/ardour/diskstream.h b/libs/ardour/ardour/diskstream.h
index c93cda83cb..96bffae723 100644
--- a/libs/ardour/ardour/diskstream.h
+++ b/libs/ardour/ardour/diskstream.h
@@ -50,6 +50,9 @@ class Session;
class Track;
class Location;
+/** Parent class for classes which can stream data to and from disk.
+ * These are used by Tracks to get playback and put recorded data.
+ */
class Diskstream : public SessionObject, public PublicDiskstream
{
public:
@@ -69,6 +72,10 @@ class Diskstream : public SessionObject, public PublicDiskstream
boost::shared_ptr<ARDOUR::IO> io() const { return _io; }
void set_track (ARDOUR::Track *);
+ /** @return A number between 0 and 1, where 0 indicates that the playback buffer
+ * is dry (ie the disk subsystem could not keep up) and 1 indicates that the
+ * buffer is full.
+ */
virtual float playback_buffer_load() const = 0;
virtual float capture_buffer_load() const = 0;
diff --git a/libs/evoral/src/libsmf/smf.h b/libs/evoral/src/libsmf/smf.h
index 7f4aa402c0..cbc7035f91 100644
--- a/libs/evoral/src/libsmf/smf.h
+++ b/libs/evoral/src/libsmf/smf.h
@@ -33,7 +33,7 @@
/**
*
- * \mainpage libsmf - general usage instructions
+ * \page libsmf libsmf - general usage instructions
*
* An smf_t structure represents a "song". Every valid smf contains one or more tracks.
* Tracks contain zero or more events. Libsmf doesn't care about actual MIDI data, as long