summaryrefslogtreecommitdiff
path: root/libs/ardour/sndfilesource.cc
diff options
context:
space:
mode:
authorPaul Davis <paul@linuxaudiosystems.com>2014-04-04 15:17:14 -0400
committerPaul Davis <paul@linuxaudiosystems.com>2014-04-04 15:17:14 -0400
commitf7396fd4627509ac378e1229b9d3c311f00ae5cc (patch)
tree89a9e5c3786f5daa295d96fa739ef8d25816482a /libs/ardour/sndfilesource.cc
parent0da58e95100b50d3abc0df7040963043485e76aa (diff)
clarify comments for SndFileSource constructors
Diffstat (limited to 'libs/ardour/sndfilesource.cc')
-rw-r--r--libs/ardour/sndfilesource.cc8
1 files changed, 6 insertions, 2 deletions
diff --git a/libs/ardour/sndfilesource.cc b/libs/ardour/sndfilesource.cc
index 1c3144f164..6bb0e46551 100644
--- a/libs/ardour/sndfilesource.cc
+++ b/libs/ardour/sndfilesource.cc
@@ -65,7 +65,9 @@ SndFileSource::SndFileSource (Session& s, const XMLNode& node)
}
}
-/** Files created this way are never writable or removable */
+/** Constructor for existing external-to-session files.
+ Files created this way are never writable or removable
+*/
SndFileSource::SndFileSource (Session& s, const string& path, int chn, Flag flags)
: Source(s, DataType::AUDIO, path, flags)
/* note that the origin of an external file is itself */
@@ -80,7 +82,9 @@ SndFileSource::SndFileSource (Session& s, const string& path, int chn, Flag flag
}
}
-/** This constructor is used to construct new files, not open existing ones. */
+/** This constructor is used to construct new internal-to-session files,
+ not open existing ones.
+*/
SndFileSource::SndFileSource (Session& s, const string& path, const string& origin,
SampleFormat sfmt, HeaderFormat hf, framecnt_t rate, Flag flags)
: Source(s, DataType::AUDIO, path, flags)