# HG changeset patch
# User Chris Cannam
# Date 1536333228 -3600
# Node ID b7042aaecebe0e546baf2262566fe4545f547100
# Parent  75d92155fa204a4ed6752a7db5ea58b6807a689d
Comments

diff -r 75d92155fa20 -r b7042aaecebe data/model/ReadOnlyWaveFileModel.h
--- a/data/model/ReadOnlyWaveFileModel.h	Fri Sep 07 16:13:21 2018 +0100
+++ b/data/model/ReadOnlyWaveFileModel.h	Fri Sep 07 16:13:48 2018 +0100
@@ -36,8 +36,20 @@
     Q_OBJECT
 
 public:
+    /**
+     * Construct a WaveFileModel from a source path and optional
+     * resampling target rate
+     */
     ReadOnlyWaveFileModel(FileSource source, sv_samplerate_t targetRate = 0);
+
+    /**
+     * Construct a WaveFileModel from a source path using an existing
+     * AudioFileReader. The model does not take ownership of the
+     * AudioFileReader, which remains managed by the caller and must
+     * outlive the model.
+     */
     ReadOnlyWaveFileModel(FileSource source, AudioFileReader *reader);
+    
     ~ReadOnlyWaveFileModel();
 
     bool isOK() const;