adds a little more doc to SinSource [ci skip]

JuliaAudio · May 17, 2017 · bf9b4f5 · bf9b4f5
1 parent f4c300d
commit bf9b4f5
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src/SignalGen/SinSource.jl b/src/SignalGen/SinSource.jl
@@ -1,5 +1,9 @@
 """
-SinSource is a multi-channel sine-tone signal generator.
+    SinSource(eltype, samplerate, freqs)
+
+SinSource is a multi-channel sine-tone signal generator. `freqs` can be an
+array of frequencies for a multi-channel source, or a single frequency for a
+mono source.
 """
 type SinSource{T} <: SampleSource
     samplerate::Float64