dochkhaton Marco pt. 3 (last one)

src/createDatasetDescription.m

@@ -2,28 +2,18 @@
 
 function createDatasetDescription(cfg)
     %
-    % Short description of what the function does goes here.
+    % It creates ``dataset_description.json`` and writes in every entry contained in
+    % ``cfg.bids.datasetDescription``. The file should go in the root of a BIDS dataset.
     %
     % USAGE::
     %
-    %   [argout1, argout2] = templateFunction(argin1, [argin2 == default,] [argin3])
+    %   createDatasetDescription(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
+    % :param cfg: Configuration. See ``checkCFG()``.
+    % :type cfg: structure
     %
-    % :returns: - :argout1: (type) (dimension)
-    %           - :argout2: (type) (dimension)
+    % :output: - :``dataset_description.json``: (jsonfile)
     %
-    % createDatasetDescription(cfg)
-    %
-    % creates the datasetDescription.json file that goes in the root of a BIDS
-    % dataset
 
     opts.Indent = '    ';
 

src/createJson.m

@@ -26,6 +26,9 @@ function createJson(varargin)
     %                   a valid BIDS dataset.
     % :type extraInfo: structure
     %
+    % :output: - :``*.json``: (jsonfile) The file name corresponds to the run + suffix depending on
+    %             the arguments passed in.
+    %
     % .. TODO:
     %
     %    - use input parser for this one

src/utils/createValidName.m

@@ -8,9 +8,8 @@
     %
     %   [taskName, taskNameValid] = createTaskName(taskName)
     %
-    % :param taskName: (dimension) obligatory argument. Lorem ipsum dolor sit amet,
-    %                consectetur adipiscing elit. Ut congue nec est ac lacinia.
-    % :type argin1: string
+    % :param taskName: Name given to the task. Can be any string including spaces and special characters.
+    % :type taskName: string
     %
     % :returns:
     %           :name: (string) returns the input with an upper case for first letter

src/utils/initializeExtraColumns.m

@@ -8,10 +8,10 @@
     %
     %   logFile = initializeExtraColumns(logFile)
     %
-    % :param logFile:
+    % :param logFile: It contains what to save in the experiment outputs.
     % :type logFile: structure
     %
-    % :returns: :logFile: (structure) (dimension)
+    % :returns: :logFile: (structure) ``logfile`` updated with extra columns.
     %
     % Example::
     %

src/utils/returnNbColumns.m

@@ -2,25 +2,19 @@
 
 function nbCol = returnNbColumns(logFile, nameExtraColumn)
     %
-    % Short description of what the function does goes here.
+    % It returns the number of columns associated to one entry of the extra column list.
     %
     % USAGE::
     %
-    %   [argout1, argout2] = templateFunction(argin1, [argin2 == default,] [argin3])
+    %   [nbCol] = returnNbColumns(logFile, nameExtraColumn)
     %
-    % :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 every information related to the experiment output(s)
+    % :type logFile: structure
+    % :param nameExtraColumn: An entry of ``logFile.extraColumns``
+    % :type nameExtraColumn: string
     %
-    % :returns: - :argout1: (type) (dimension)
-    %           - :argout2: (type) (dimension)
-    %
-    % nbCol = returnNbColumns(logFile, nameExtraColumn)
+    % :returns: - :nbCol: (integer) The number of columns associated to one entry of the extra
+    %             column list.
     %
 
     thisExtraColumn = logFile(1).extraColumns.(nameExtraColumn);