changeset 1066:c98a1fe7c7f5 spectrogram-minor-refactor

Comments
author Chris Cannam
date Thu, 23 Jun 2016 10:51:45 +0100
parents 85e49aa7fe77
children 6eb9e032e708
files layer/ColourScaleLayer.h layer/VerticalScaleLayer.h
diffstat 2 files changed, 12 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/layer/ColourScaleLayer.h	Thu Jun 23 08:46:20 2016 +0100
+++ b/layer/ColourScaleLayer.h	Thu Jun 23 10:51:45 2016 +0100
@@ -21,6 +21,13 @@
 
 class LayerGeometryProvider;
 
+/**
+ * Interface for layers in which a colour scale represents (or can
+ * sometimes represent, depending on the display mode) the sample
+ * value. For example, TimeValueLayer uses colour scale when in
+ * segment mode and so provides this interface for use by the
+ * LogColourScale or LinearColourScale scale renderers.
+ */
 class ColourScaleLayer
 {
 public:
--- a/layer/VerticalScaleLayer.h	Thu Jun 23 08:46:20 2016 +0100
+++ b/layer/VerticalScaleLayer.h	Thu Jun 23 10:51:45 2016 +0100
@@ -16,6 +16,11 @@
 #ifndef VERTICAL_SCALE_LAYER_H
 #define VERTICAL_SCALE_LAYER_H
 
+/**
+ * Interface for layers in which the Y axis represents (or can
+ * sometimes represent, depending on the display mode) the sample
+ * value. For example, TimeValueLayer in point mode.
+ */
 class VerticalScaleLayer
 {
 public: