Finished up basic class comments

cafarm · cafarm · commit 1489c7298402 · 2016-05-17T15:14:43.000-07:00
diff --git a/src/main/matlab/+symphonyui/+builtin/+daqs/HekaDaqController.m b/src/main/matlab/+symphonyui/+builtin/+daqs/HekaDaqController.m
@@ -1,4 +1,5 @@
 classdef HekaDaqController < symphonyui.core.DaqController
+    % Manages a Heka/Instrutech DAQ interface (ITC-16, ITC-18, or ITC-1600).
 
     methods
 
diff --git a/src/main/matlab/+symphonyui/+builtin/+daqs/HekaSimulationDaqController.m b/src/main/matlab/+symphonyui/+builtin/+daqs/HekaSimulationDaqController.m
@@ -1,5 +1,6 @@
 classdef HekaSimulationDaqController < symphonyui.builtin.daqs.SimulationDaqController
-
+    % Manages a simulated Heka/Instrutech DAQ interface (requires no attached hardware).
+    
     methods
 
         function obj = HekaSimulationDaqController()
diff --git a/src/main/matlab/+symphonyui/+builtin/+devices/AxopatchDevice.m b/src/main/matlab/+symphonyui/+builtin/+devices/AxopatchDevice.m
@@ -1,4 +1,5 @@
 classdef AxopatchDevice < symphonyui.core.Device
+    % Represents an Axopatch device.
     
     properties (Constant)
         % These constants should directly reference Symphony.ExternalDevices but we cannot import the assembly before
diff --git a/src/main/matlab/+symphonyui/+builtin/+devices/CalibratedDevice.m b/src/main/matlab/+symphonyui/+builtin/+devices/CalibratedDevice.m
@@ -1,4 +1,5 @@
 classdef CalibratedDevice < symphonyui.core.Device
+    % Represents a UnitConvertingDevice with an associated lookup table (LUT).
     
     properties
         measurementConversionTarget
diff --git a/src/main/matlab/+symphonyui/+builtin/+devices/MultiClampDevice.m b/src/main/matlab/+symphonyui/+builtin/+devices/MultiClampDevice.m
@@ -1,4 +1,5 @@
 classdef MultiClampDevice < symphonyui.core.Device
+    % Represents a MultiClamp 700[A,B] device.
     
     methods
         
diff --git a/src/main/matlab/+symphonyui/+builtin/+devices/UnitConvertingDevice.m b/src/main/matlab/+symphonyui/+builtin/+devices/UnitConvertingDevice.m
@@ -1,4 +1,5 @@
 classdef UnitConvertingDevice < symphonyui.core.Device
+    % Represents a generic device (LED, valve, temperature controller, etc.).
     
     properties
         measurementConversionTarget
diff --git a/src/main/matlab/+symphonyui/+builtin/+figures/CustomFigure.m b/src/main/matlab/+symphonyui/+builtin/+figures/CustomFigure.m
@@ -1,4 +1,5 @@
 classdef CustomFigure < symphonyui.core.FigureHandler
+    % Delegates to a specified callback function to handle creating and updating the controls of the figure.
     
     properties
         userData
diff --git a/src/main/matlab/+symphonyui/+builtin/+figures/MeanResponseFigure.m b/src/main/matlab/+symphonyui/+builtin/+figures/MeanResponseFigure.m
@@ -1,4 +1,5 @@
 classdef MeanResponseFigure < symphonyui.core.FigureHandler
+    % Plots the mean response of a specified device for all epochs run.
     
     properties (SetAccess = private)
         device
diff --git a/src/main/matlab/+symphonyui/+builtin/+figures/ResponseFigure.m b/src/main/matlab/+symphonyui/+builtin/+figures/ResponseFigure.m
@@ -1,4 +1,5 @@
 classdef ResponseFigure < symphonyui.core.FigureHandler
+    % Plots the response of a specified device in the most recent epoch.
 
     properties (SetAccess = private)
         device
diff --git a/src/main/matlab/+symphonyui/+builtin/+figures/ResponseStatisticsFigure.m b/src/main/matlab/+symphonyui/+builtin/+figures/ResponseStatisticsFigure.m
@@ -1,4 +1,5 @@
 classdef ResponseStatisticsFigure < symphonyui.core.FigureHandler
+    % Plots statistics calculated from the response of a specified device for each epoch run.
     
     properties (SetAccess = private)
         device
diff --git a/src/main/matlab/+symphonyui/+builtin/+previews/StimuliPreview.m b/src/main/matlab/+symphonyui/+builtin/+previews/StimuliPreview.m
@@ -1,4 +1,5 @@
 classdef StimuliPreview < symphonyui.core.ProtocolPreview
+    % Displays a cell array of stimuli on a 2D plot. 
     
     properties
         createStimuliFcn
@@ -12,6 +13,9 @@
     methods
         
         function obj = StimuliPreview(panel, createStimuliFcn)
+            % Constructs a StimuliPreview on the given panel with the given stimuli. createStimuliFcn should be a
+            % callback function that creates a cell array of stimuli.
+            
             obj@symphonyui.core.ProtocolPreview(panel);
             obj.createStimuliFcn = createStimuliFcn;
             obj.log = log4m.LogManager.getLogger(class(obj));

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`classdef HekaDaqController < symphonyui.core.DaqController`
	`2`	`+ % Manages a Heka/Instrutech DAQ interface (ITC-16, ITC-18, or ITC-1600).`
`2`	`3`
`3`	`4`	`methods`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`classdef AxopatchDevice < symphonyui.core.Device`
	`2`	`+ % Represents an Axopatch device.`
`2`	`3`
`3`	`4`	`properties (Constant)`
`4`	`5`	`% These constants should directly reference Symphony.ExternalDevices but we cannot import the assembly before`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`classdef CalibratedDevice < symphonyui.core.Device`
	`2`	`+ % Represents a UnitConvertingDevice with an associated lookup table (LUT).`
`2`	`3`
`3`	`4`	`properties`
`4`	`5`	`measurementConversionTarget`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`classdef MultiClampDevice < symphonyui.core.Device`
	`2`	`+ % Represents a MultiClamp 700[A,B] device.`
`2`	`3`
`3`	`4`	`methods`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`classdef UnitConvertingDevice < symphonyui.core.Device`
	`2`	`+ % Represents a generic device (LED, valve, temperature controller, etc.).`
`2`	`3`
`3`	`4`	`properties`
`4`	`5`	`measurementConversionTarget`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`classdef CustomFigure < symphonyui.core.FigureHandler`
	`2`	`+ % Delegates to a specified callback function to handle creating and updating the controls of the figure.`
`2`	`3`
`3`	`4`	`properties`
`4`	`5`	`userData`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`classdef MeanResponseFigure < symphonyui.core.FigureHandler`
	`2`	`+ % Plots the mean response of a specified device for all epochs run.`
`2`	`3`
`3`	`4`	`properties (SetAccess = private)`
`4`	`5`	`device`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`classdef ResponseFigure < symphonyui.core.FigureHandler`
	`2`	`+ % Plots the response of a specified device in the most recent epoch.`
`2`	`3`
`3`	`4`	`properties (SetAccess = private)`
`4`	`5`	`device`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`classdef ResponseStatisticsFigure < symphonyui.core.FigureHandler`
	`2`	`+ % Plots statistics calculated from the response of a specified device for each epoch run.`
`2`	`3`
`3`	`4`	`properties (SetAccess = private)`
`4`	`5`	`device`