improve help sections

Author: Remi-Gau

cleanUp.m

@@ -1,4 +1,6 @@
 function cleanUp
+% A wrapper function to close all windows, ports, show mouse cursor, close keyboard queues
+% and give access back to the keyboards.
 
 WaitSecs(0.5);
 
@@ -24,5 +26,5 @@
 
 close all
 
- 
+
 end

deg2Pix.m

@@ -1,8 +1,11 @@
-function structure = deg2Pix(fieldName, structure, Cfg)
+function structure = deg2Pix(fieldName, structure, cfg)
+% For a given field value in degrees of visual angle in the structure,
+% this computes its value in pixel using the pixel per degree value of the cfg structure
+% and returns a structure with an additional field with Pix suffix holding that new value. 
 
 deg = getfield( structure, fieldName);
 
 structure = setfield( structure, [fieldName 'Pix'], ...
-    floor(Cfg.ppd * deg) ) ;
+    floor(cfg.ppd * deg) ) ;
 
-end
+end

drawFixationCross.m

@@ -1,10 +1,11 @@
-function drawFixationCross(Cfg, ExpParameters, color)
+function drawFixationCross(cfg, expParameters, color)
+% Define the parameters of the fixation cross in `cfg` and `expParameters` and this does the rest.
 
 Screen('DrawLines', ...
-    Cfg.win, ...
-    Cfg.allCoords, ...
-    ExpParameters.lineWidthPix, ...
+    cfg.win, ...
+    cfg.allCoords, ...
+    expParameters.lineWidthPix, ...
     color , ...
-    [Cfg.center(1) Cfg.center(2)], 1);
+    [cfg.center(1) cfg.center(2)], 1);
 
-end
+end

initPTB.m

@@ -1,8 +1,20 @@
 function [cfg] = initPTB(cfg)
-% This seems a good candidate function to have as a common function across
-% experiments
-% We might want to add a couple of IF in case the experiment does not use
-% audio for example.
+% This will initialize PsychToolBox
+% - screen
+%   - the windon opened takes the whole screen by default
+%   - set in debug mode with window transparency if necessary
+%   - can skip synch test if you ask for it (nicely)
+%   - gets the flip interval
+%   - computes the pixel per degree of visual angle
+%   - set font details
+% - keyboard
+% - sound
+
+
+% TO DO
+% - We might want to add a couple of IF in case the experiment does not use audio for example.
+% - the computation for ppd assumes the windows takes the whole screenDistance
+% - refactor the window opening section (pass the window size as argument)
 
 checkDependencies()
 
@@ -57,12 +69,12 @@
 
 % init PTB with different options in concordance to the Debug Parameters
 if cfg.debug
-    
+
     % set to one because we don not care about time
     Screen('Preference', 'SkipSyncTests', 2);
     Screen('Preference', 'Verbosity', 0);
     Screen('Preferences', 'SuppressAllWarnings', 2);
-    
+
     if cfg.testingSmallScreen
         [cfg.win, cfg.winRect] = PsychImaging('OpenWindow', cfg.screen, cfg.backgroundColor,  [0,0, 480, 270]);
     else
@@ -71,11 +83,11 @@
         end
         [cfg.win, cfg.winRect] = PsychImaging('OpenWindow', cfg.screen, cfg.backgroundColor);
     end
-    
+
 else
     Screen('Preference','SkipSyncTests', 0);
     [cfg.win, cfg.winRect] = PsychImaging('OpenWindow', cfg.screen, cfg.backgroundColor);
-    
+
 end
 
 

pressSpace4me.m

@@ -1,21 +1,21 @@
 function pressSpace4me
+% Use that to stop your script and only restart when the space bar is pressed.
 
 fprintf('\npress space to continue\n');
 
 while 1
 
     WaitSecs(0.1);
-    
+
     [~, keyCode, ~] = KbWait(-1);
-    
+
     responseKey = KbName(find(keyCode));
-    
+
     if strcmp(responseKey,'space')
         fprintf('starting the experiment....\n');
         break
     end
-    
-end
 
 end
 
+end

testKeyboards.m

@@ -1,4 +1,6 @@
 function testKeyboards(cfg)
+% Checks that the keyboards asked for properly connected.
+% If no key is pressed on the correct keyboard after the timeOut time this exits with an error.
 
 timeOut = 5;
 
@@ -40,25 +42,25 @@ function throwError(keyCode, deviceNumber, keyboardType)
 
 
 if all(keyCode==0)
-    
+
     % Give me my keyboard back... Pretty please.
     ListenChar();
-    
+
     fprintf(text1);
-    
+
     if isempty(deviceNumber)
         disp(' - no keyboard selected, default is the main keyboard')
     else
         disp(deviceNumber)
     end
-    
+
     fprintf(text2);
-    
+
     [keyboardNumbers, keyboardNames] = GetKeyboardIndices  %#ok<*NOPRT,*ASGLU>
-    
+
     error(errorText)
-    
+
 end
 
 
-end
+end