dockathon Marco pt. 2

src/utils/checkCppBidsDependencies.m

@@ -2,12 +2,14 @@
 
 function checkCppBidsDependencies(cfg)
     %
-    % Adds dependencies to the matlab path and make sure we got all of them/
+    % Adds dependencies to the Matlab / Octave path and make sure we got all of them.
     %
     % USAGE::
     %
     %   checkCppBidsDependencies(cfg)
     %
+    % :param cfg: Configuration. See ``checkCFG()``.
+    % :type cfg: structure
 
     GITHUB_WORKSPACE = getenv('GITHUB_WORKSPACE');
 

src/utils/isPositiveInteger.m

@@ -2,14 +2,14 @@
 
 function trueOrFalse = isPositiveInteger(input2check)
     %
-    %
+    % It checks whether the input is a positive integer and report it as ``true`` or ``false``
     %
     % USAGE::
     %
     %   trueOrFalse = isPositiveInteger(input2check)
     %
-    % :param input2check:
-    % :type input2check: column vector
+    % :param input2check: (1xn) The input to check (either a number or ``NaN``)
+    % :type input2check: vector
     %
     % :returns: :trueOrFalse: (boolean)
     %

src/utils/printCreditsCppBids.m

@@ -2,23 +2,15 @@
 
 function printCreditsCppBids(cfg)
     %
-    % Short description of what the function does goes here.
+    % It will print the credits of this repo. Depending on the level of verbosity set in
+    % ``cfg.verbose`` (default is 2 if not set), it will print the graphic and general information.
     %
     % USAGE::
     %
-    %   [argout1, argout2] = templateFunction(argin1, [argin2 == default,] [argin3])
+    %   printCreditsCppBids(cfg)
     %
-    % :param argin1: (dimension) obligatory argument. Lorem ipsum dolor sit amet,
-    %                consectetur adipiscing elit. Ut congue nec est ac lacinia.
-    % :type argin1: type
-    % :param argin2: optional argument and its default value. And some of the
-    %               options can be shown in litteral like ``this`` or ``that``.
-    % :type argin2: string
-    % :param argin3: (dimension) optional argument
-    % :type argin3: integer
-    %
-    % :returns: - :argout1: (type) (dimension)
-    %           - :argout2: (type) (dimension)
+    % :param cfg: Configuration. See ``checkCFG()``.
+    % :type cfg: structure
     %
 
     try

src/utils/returnHeaderName.m

@@ -2,25 +2,20 @@
 
 function headerName = returnHeaderName(columnName, nbCol, iCol)
     %
-    % Short description of what the function does goes here.
+    % It returns one by one the column name to be used as a header in a recently opened event file
     %
     % USAGE::
     %
-    %   [argout1, argout2] = templateFunction(argin1, [argin2 == default,] [argin3])
+    %   headerName = returnHeaderName(columnName, nbCol, iCol)
     %
-    % :param argin1: (dimension) obligatory argument. Lorem ipsum dolor sit amet,
-    %                consectetur adipiscing elit. Ut congue nec est ac lacinia.
-    % :type argin1: type
-    % :param argin2: optional argument and its default value. And some of the
-    %               options can be shown in litteral like ``this`` or ``that``.
-    % :type argin2: string
-    % :param argin3: (dimension) optional argument
-    % :type argin3: integer
+    % :param columnName: The column name to print
+    % :type columnName: string
+    % :param nbCol: It is the number of columns associated to one entry of the extra column list
+    % :type nbCol: integer
+    % :param iCol: Index of the columns associated to one entry of the extra column list
+    % :type iCol: integer
     %
-    % :returns: - :argout1: (type) (dimension)
-    %           - :argout2: (type) (dimension)
-    %
-    % headerName = returnHeaderName(columnName, nbCol, iCol)
+    % :returns: - :headerName: (string) return the extra column name to be used as header
     %
 
     if nbCol == 1

src/utils/returnNamesExtraColumns.m

@@ -1,26 +1,18 @@
 % (C) Copyright 2020 CPP_BIDS developers
 
-function [namesExtraColumns, logFile] = returnNamesExtraColumns(logFile)
+function [namesExtraColumns, logfile] = returnNamesExtraColumns(logFile)
     %
-    % Short description of what the function does goes here.
+    % It returns the extra columns name(s), in ``cfg.extraColumns``,  as header to add to the
+    % ``event`` file
     %
     % USAGE::
     %
-    %   [argout1, argout2] = templateFunction(argin1, [argin2 == default,] [argin3])
+    %   [namesExtraColumns] = returnNamesExtraColumns(logFile)
     %
-    % :param argin1: (dimension) obligatory argument. Lorem ipsum dolor sit amet,
-    %                consectetur adipiscing elit. Ut congue nec est ac lacinia.
-    % :type argin1: type
-    % :param argin2: optional argument and its default value. And some of the
-    %               options can be shown in litteral like ``this`` or ``that``.
-    % :type argin2: string
-    % :param argin3: (dimension) optional argument
-    % :type argin3: integer
+    % :param logFile: It contains all the information to be saved in the event/stim file
+    % :type logFile: structure
     %
-    % :returns: - :argout1: (type) (dimension)
-    %           - :argout2: (type) (dimension)
-    %
-    % [namesExtraColumns, logFile] = returnNamesExtraColumns(logFile)
+    % :returns: - :namesExtraColumns: (cell) (nx1)
     %
 
     namesExtraColumns = [];