# HG changeset patch
# User Chris Cannam
# Date 1483614638 0
# Node ID df59bf0b42362b4ba7e54da4232fc72a6bdf8f23
# Parent  8541563f1fd3d7584e73e3a0a084f5b012580ca8
Doc comment

diff -r 8541563f1fd3 -r df59bf0b4236 data/model/Dense3DModelPeakCache.h
--- a/data/model/Dense3DModelPeakCache.h	Wed Jan 04 16:03:12 2017 +0000
+++ b/data/model/Dense3DModelPeakCache.h	Thu Jan 05 11:10:38 2017 +0000
@@ -73,9 +73,15 @@
         return m_source->getMaximumLevel();
     }
 
-    virtual Column getColumn(int column) const;
+    /**
+     * Retrieve the peaks column at peak-cache column number col. This
+     * will consist of the peak values in the underlying model from
+     * columns (col * getColumnsPerPeak()) to ((col+1) *
+     * getColumnsPerPeak() - 1) inclusive.
+     */
+    virtual Column getColumn(int col) const;
 
-    virtual float getValueAt(int column, int n) const;
+    virtual float getValueAt(int col, int n) const;
 
     virtual QString getBinName(int n) const {
         return m_source->getBinName(n);