clarify comments for SndFileSource constructors
authorPaul Davis <paul@linuxaudiosystems.com>
Fri, 4 Apr 2014 19:17:14 +0000 (15:17 -0400)
committerPaul Davis <paul@linuxaudiosystems.com>
Fri, 4 Apr 2014 19:17:14 +0000 (15:17 -0400)
libs/ardour/sndfilesource.cc

index 1c3144f16421177f140b7da1753ec7bfaa8cf92f..6bb0e46551b26ebe190ac78d84db7b59d10f8b89 100644 (file)
@@ -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)