update copyright in help section

Remi-Gau · Remi-Gau · commit 0023a4bf69a9 · 2022-11-02T11:27:34.000+01:00
diff --git a/requirements.txt b/requirements.txt
@@ -2,5 +2,5 @@ Sphinx
 sphinxcontrib-matlabdomain
 sphinxcontrib-napoleon
 sphinx_rtd_theme
-miss_hit==0.9.29
+miss_hit==0.9.35
 pre-commit
diff --git a/src/aperture/apertureTexture.m b/src/aperture/apertureTexture.m
@@ -5,6 +5,7 @@
     %   [cfg, thisEvent] = apertureTexture(action, cfg, thisEvent)
     %
     %
+
     % (C) Copyright 2010-2020 Sam Schwarzkopf
     % (C) Copyright 2020 CPP_PTB developers
 
diff --git a/src/aperture/eccenLogSpeed.m b/src/aperture/eccenLogSpeed.m
@@ -4,6 +4,7 @@
     % cf. Tootell 1997; Swisher 2007; Warnking 2002 etc
     %
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     TR = cfg.mri.repetitionTime;
diff --git a/src/aperture/getApertureName.m b/src/aperture/getApertureName.m
@@ -1,5 +1,6 @@
 function apertureName = getApertureName(cfg, apertures, iApert)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
     switch cfg.aperture
         case 'Bar'
diff --git a/src/aperture/saveApertures.m b/src/aperture/saveApertures.m
@@ -1,5 +1,6 @@
 function saveApertures(saveAps, cfg, apertures)
     %
+
     % (C) Copyright 2010-2020 Sam Schwarzkopf
     % (C) Copyright 2020 CPP_PTB developers
     if saveAps
diff --git a/src/aperture/smoothOval.m b/src/aperture/smoothOval.m
@@ -6,6 +6,7 @@ function smoothOval(win, color, rect, fringe)
     %   SmoothOval(WindowPtr, Color, Rect, Fringe)
     %
     %
+
     % (C) Copyright 2010-2020 Sam Schwarzkopf
     % (C) Copyright 2020 CPP_PTB developers
 
diff --git a/src/aperture/smoothRect.m b/src/aperture/smoothRect.m
@@ -6,6 +6,7 @@ function smoothRect(win, color, rect, fringe)
     %
     %   SmoothRect(WindowPtr, Color, Rect, Fringe)
     %
+
     % (C) Copyright 2010-2020 Sam Schwarzkopf
     % (C) Copyright 2020 CPP_PTB developers
 
diff --git a/src/defaults/checkCppPtbCfg.m b/src/defaults/checkCppPtbCfg.m
@@ -10,6 +10,7 @@
     %
     % :returns: - :cfg: (structure)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     if nargin < 1
diff --git a/src/defaults/cppPtbDefaults.m b/src/defaults/cppPtbDefaults.m
@@ -4,6 +4,7 @@
     %
     %   value = cppPtbDefaults(type)
     %
+
     % (C) Copyright 2022 CPP_PTB developers
 
     value = [];
diff --git a/src/defaults/setDefaultFields.m b/src/defaults/setDefaultFields.m
@@ -14,6 +14,7 @@
     %
     % :returns: - :structure: (structure)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     fieldsToSet = orderfields(fieldsToSet);
diff --git a/src/dot/computeCartCoord.m b/src/dot/computeCartCoord.m
@@ -4,6 +4,7 @@
     %
     %   cartesianCoordinates = computeCartCoord(positions, dotMatrixWidth)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     cartesianCoordinates = ...
diff --git a/src/dot/computeRadialMotionDirection.m b/src/dot/computeRadialMotionDirection.m
@@ -1,5 +1,6 @@
 function angleMotion = computeRadialMotionDirection(positions, dotMatrixWidth, dots)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     positions = computeCartCoord(positions, dotMatrixWidth);
diff --git a/src/dot/decomposeMotion.m b/src/dot/decomposeMotion.m
@@ -13,6 +13,7 @@
     %           - :vertVector: vertical component of motion
     %
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     horVector = cos(pi * angleMotion / 180);
diff --git a/src/dot/dotMotionSimulation.m b/src/dot/dotMotionSimulation.m
@@ -7,6 +7,7 @@
     %
     %   relativeDensityContrast = dotMotionSimulation(cfg, thisEvent, nbEvents, doPlot)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     close all;
diff --git a/src/dot/dotTexture.m b/src/dot/dotTexture.m
@@ -1,5 +1,6 @@
 function cfg = dotTexture(action, cfg, thisEvent)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
     switch action
 
diff --git a/src/dot/generateNewDotPositions.m b/src/dot/generateNewDotPositions.m
@@ -1,5 +1,6 @@
 function newPositions = generateNewDotPositions(dotMatrixWidth, nbDots)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     newPositions = rand(nbDots, 2) * dotMatrixWidth;
diff --git a/src/dot/initDots.m b/src/dot/initDots.m
@@ -28,6 +28,7 @@
     % - ``dots.speeds``: ``[ndots, 2]`` ; horizontal and vertical speed ; in pixels per frame
     % - ``dots.speedPixPerFrame``
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     dots.direction = thisEvent.direction(1);
diff --git a/src/dot/postInitDots.m b/src/dot/postInitDots.m
@@ -5,6 +5,7 @@
     % generic function to finalize dots set up after psychtoolbox initialization
     %
     %
+
     % (C) Copyright 2022 CPP_PTB developers
 
     cfg.dot.matrixWidth = cfg.screen.winWidth;
diff --git a/src/dot/reseedDots.m b/src/dot/reseedDots.m
@@ -1,5 +1,6 @@
 function dots = reseedDots(dots, cfg)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     fixationWidthPix = 0;
diff --git a/src/dot/seedDots.m b/src/dot/seedDots.m
@@ -1,5 +1,6 @@
 function [positions, speeds, time] = seedDots(varargin)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     [dots, cfg, isSignal] = deal(varargin{:});
diff --git a/src/dot/setDotDirection.m b/src/dot/setDotDirection.m
@@ -24,6 +24,7 @@
     %
     % All directions are in end expressed between 0 and 360.
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     directionAllDots = dots.direction;
diff --git a/src/dot/updateDots.m b/src/dot/updateDots.m
@@ -1,5 +1,6 @@
 function [dots] = updateDots(dots, cfg)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     % Move the selected dots
diff --git a/src/drawFieldOfVIew.m b/src/drawFieldOfVIew.m
@@ -16,6 +16,7 @@
     %
     % :returns: - :fov: (array) PTB rectangle
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     if nargin < 2
diff --git a/src/errors/errorAbort.m b/src/errors/errorAbort.m
@@ -1,5 +1,6 @@
 function errorAbort
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     errorStruct.message = 'Escape key press detected: aborting experiment.';
diff --git a/src/errors/errorAbortGetReponse.m b/src/errors/errorAbortGetReponse.m
@@ -1,5 +1,6 @@
 function errorAbortGetReponse
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     errorStruct.message = 'Escape key press detected by getResponse: aborting experiment.';
diff --git a/src/errors/errorDistanceToScreen.m b/src/errors/errorDistanceToScreen.m
@@ -1,5 +1,6 @@
 function errorDistanceToScreen(cfg)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     errorStruct.message = sprintf([
diff --git a/src/errors/errorRestrictedKeysGetReponse.m b/src/errors/errorRestrictedKeysGetReponse.m
@@ -1,5 +1,6 @@
 function errorRestrictedKeysGetReponse
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     errorStruct.message = 'getResponse reported a key press on a restricted key';
diff --git a/src/eyeTracker.m b/src/eyeTracker.m
@@ -33,6 +33,7 @@
     %   cpp-lln-lab/CPP_BIDS, in the output folder and shut the connection between the
     %   stimulation computer and the EyeLink computer
     %
+
     % (C) Copyright 2020 CPP_PTB developers
     if ~cfg.eyeTracker.do
 
diff --git a/src/fixation/drawFixation.m b/src/fixation/drawFixation.m
@@ -14,6 +14,7 @@ function drawFixation(cfg)
     %
     % See initFixation for more info.
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     switch cfg.fixation.type
diff --git a/src/fixation/initFixation.m b/src/fixation/initFixation.m
@@ -22,6 +22,7 @@
     %
     % Contains a fixation cross and a dot
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     % Convert some values from degrees to pixels
diff --git a/src/getExperimentEnd.m b/src/getExperimentEnd.m
@@ -3,6 +3,7 @@
     % Wrapper function that will show a fixation cross and display in the console the
     % whole experiment's duration in minutes and seconds
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     drawFixation(cfg);
diff --git a/src/getExperimentStart.m b/src/getExperimentStart.m
@@ -7,6 +7,7 @@
     %
     %   cfg = getExperimentStart(cfg)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     drawFixation(cfg);
diff --git a/src/initPTB.m b/src/initPTB.m
@@ -24,6 +24,7 @@
     % See the set up page of the documentation for more details on the content of cfg
     %
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     checkPtbVersion();
diff --git a/src/isOctave.m b/src/isOctave.m
@@ -5,6 +5,7 @@
     % Must stay in the 'src' folder for continuous integration with github
     % action to work. Not sure why.
     %
+
     % (C) Copyright 2010-2020 Agah Karakuzu
     % (C) Copyright 2020 CPP_PTB developers
 
diff --git a/src/keyboard/checkAbort.m b/src/keyboard/checkAbort.m
@@ -32,6 +32,7 @@ function checkAbort(cfg, deviceNumber)
     %       end
     %   end
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     if nargin < 1 || isempty(cfg)
diff --git a/src/keyboard/checkAbortGetResponse.m b/src/keyboard/checkAbortGetResponse.m
@@ -1,5 +1,6 @@
 function checkAbortGetResponse(responseEvents, cfg)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
     if isfield(responseEvents, 'keyName') > 0 && ...
             any( ...
diff --git a/src/keyboard/collectAndSaveResponses.m b/src/keyboard/collectAndSaveResponses.m
@@ -1,5 +1,6 @@
 function responseEvents = collectAndSaveResponses(cfg, logFile, experimentStart)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     responseEvents = getResponse('check', cfg.keyboard.responseBox, cfg);
diff --git a/src/keyboard/getResponse.m b/src/keyboard/getResponse.m
@@ -72,6 +72,7 @@
     %
     % - ``stop`` stops listening to key presses
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     if nargin < 2 || isempty(deviceNumber)
diff --git a/src/keyboard/pressSpaceForMe.m b/src/keyboard/pressSpaceForMe.m
@@ -8,6 +8,7 @@ function pressSpaceForMe()
     %
     %   pressSpaceForMe()
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     fprintf('\nPress space to continue.\n');
diff --git a/src/keyboard/testKeyboards.m b/src/keyboard/testKeyboards.m
@@ -9,6 +9,7 @@ function testKeyboards(cfg)
     %
     %   testKeyboards(cfg)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     timeOut = 5;
diff --git a/src/randomization/repeatShuffleConditions.m b/src/randomization/repeatShuffleConditions.m
@@ -15,6 +15,7 @@
     %
     % :returns: - :shuffledRepeats: (vector) (dimension)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     % TODO
diff --git a/src/randomization/setTargetPositionInSequence.m b/src/randomization/setTargetPositionInSequence.m
@@ -17,6 +17,7 @@
     %
     % :returns: - :chosenPositions:
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     REPLACE = false;
diff --git a/src/randomization/shuffle.m b/src/randomization/shuffle.m
@@ -8,6 +8,7 @@
     %
     %   shuffled = shuffle(unshuffled)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     try
diff --git a/src/screen/farewellScreen.m b/src/screen/farewellScreen.m
@@ -1,5 +1,6 @@
 function farewellScreen(cfg)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     Screen('FillRect', cfg.screen.win, cfg.color.background, cfg.screen.winRect);
diff --git a/src/screen/standByScreen.m b/src/screen/standByScreen.m
@@ -7,6 +7,7 @@ function standByScreen(cfg)
     %
     %  standByScreen(cfg)
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     Screen('FillRect', cfg.screen.win, cfg.color.background, cfg.screen.winRect);
diff --git a/src/templates/templateFunction.m b/src/templates/templateFunction.m
@@ -21,6 +21,7 @@
     %    - item 1
     %    - item 2
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     % The code goes below
diff --git a/src/templates/templateFunctionExample.m b/src/templates/templateFunctionExample.m
@@ -35,6 +35,7 @@ function templateFunctionExample()
     %
     % % tests end here because test indentation has ended
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     % The code goes below
diff --git a/src/utils/checkPtbVersion.m b/src/utils/checkPtbVersion.m
@@ -6,6 +6,7 @@ function checkPtbVersion()
     %
     %   checkPtbVersion()
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     printCreditsCppPtb();
diff --git a/src/utils/cleanUp.m b/src/utils/cleanUp.m
@@ -7,6 +7,7 @@ function cleanUp()
     %
     %   cleanUp()
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     WaitSecs(0.5);
diff --git a/src/utils/computeFOV.m b/src/utils/computeFOV.m
@@ -19,6 +19,7 @@
     %
     %  The result obtained is in radians.
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     if cfg.screen.monitorDistance < 2
diff --git a/src/utils/degToPix.m b/src/utils/degToPix.m
@@ -24,6 +24,7 @@
     %   fixation = degToPix('width', fixation, cfg);
     %
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     deg = getfield(structure, fieldName); %#ok<GFLD>
diff --git a/src/utils/pixToDeg.m b/src/utils/pixToDeg.m
@@ -26,6 +26,7 @@
     %
     %   fixation = degToPix('widthPix', fixation, cfg);
     %
+
     % (C) Copyright 2020 CPP_PTB developers
 
     pix = getfield(structure, fieldName); %#ok<GFLD>
diff --git a/src/utils/printCreditsCppPtb.m b/src/utils/printCreditsCppPtb.m
diff --git a/src/utils/printScreen.m b/src/utils/printScreen.m
diff --git a/src/utils/setUpRand.m b/src/utils/setUpRand.m
diff --git a/src/video/createFramesTextureStructure.m b/src/video/createFramesTextureStructure.m
diff --git a/src/video/playVideoFrames.m b/src/video/playVideoFrames.m
diff --git a/src/waitFor.m b/src/waitFor.m
diff --git a/src/waitForTrigger.m b/src/waitForTrigger.m

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`% [cfg, thisEvent] = apertureTexture(action, cfg, thisEvent)`
`6`	`6`	`%`
`7`	`7`	`%`
	`8`	`+`
`8`	`9`	`% (C) Copyright 2010-2020 Sam Schwarzkopf`
`9`	`10`	`% (C) Copyright 2020 CPP_PTB developers`
`10`	`11`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`% cf. Tootell 1997; Swisher 2007; Warnking 2002 etc`
`5`	`5`	`%`
`6`	`6`	`%`
	`7`	`+`
`7`	`8`	`% (C) Copyright 2020 CPP_PTB developers`
`8`	`9`
`9`	`10`	`TR = cfg.mri.repetitionTime;`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`function apertureName = getApertureName(cfg, apertures, iApert)`
`2`	`2`	`%`
	`3`	`+`
`3`	`4`	`% (C) Copyright 2020 CPP_PTB developers`
`4`	`5`	`switch cfg.aperture`
`5`	`6`	`case 'Bar'`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`function saveApertures(saveAps, cfg, apertures)`
`2`	`2`	`%`
	`3`	`+`
`3`	`4`	`% (C) Copyright 2010-2020 Sam Schwarzkopf`
`4`	`5`	`% (C) Copyright 2020 CPP_PTB developers`
`5`	`6`	`if saveAps`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ function smoothOval(win, color, rect, fringe)`
`6`	`6`	`% SmoothOval(WindowPtr, Color, Rect, Fringe)`
`7`	`7`	`%`
`8`	`8`	`%`
	`9`	`+`
`9`	`10`	`% (C) Copyright 2010-2020 Sam Schwarzkopf`
`10`	`11`	`% (C) Copyright 2020 CPP_PTB developers`
`11`	`12`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ function smoothRect(win, color, rect, fringe)`
`6`	`6`	`%`
`7`	`7`	`% SmoothRect(WindowPtr, Color, Rect, Fringe)`
`8`	`8`	`%`
	`9`	`+`
`9`	`10`	`% (C) Copyright 2010-2020 Sam Schwarzkopf`
`10`	`11`	`% (C) Copyright 2020 CPP_PTB developers`
`11`	`12`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`	`%`
`11`	`11`	`% :returns: - :cfg: (structure)`
`12`	`12`	`%`
	`13`	`+`
`13`	`14`	`% (C) Copyright 2020 CPP_PTB developers`
`14`	`15`
`15`	`16`	`if nargin < 1`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`%`
`5`	`5`	`% value = cppPtbDefaults(type)`
`6`	`6`	`%`
	`7`	`+`
`7`	`8`	`% (C) Copyright 2022 CPP_PTB developers`
`8`	`9`
`9`	`10`	`value = [];`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`%`
`15`	`15`	`% :returns: - :structure: (structure)`
`16`	`16`	`%`
	`17`	`+`
`17`	`18`	`% (C) Copyright 2020 CPP_PTB developers`
`18`	`19`
`19`	`20`	`fieldsToSet = orderfields(fieldsToSet);`