Merge pull request #138 from marcobarilari/marco_build-rtd

[DOC] build the rtd without warnings

Author: Remi-Gau

src/convertSourceToRaw.m

@@ -10,15 +10,14 @@ function convertSourceToRaw(cfg)
     %
     %   convertSourceToRaw(cfg)
     %
-    % :param cfg: cfg structure is needed only for providing the path in
-    %           ``cfg.dir.output``
+    % :param cfg: cfg structure is needed only for providing the path in ``cfg.dir.output``.
     % :type cfg: structure
     %
     % :output:
-    % - creates dummy README and CHANGE file
-    % - copy source dir to raw dir
-    % - remove the date suffix (_date-*) from the files where it is present
-    % - zips the _stim files.
+    %          - :creates: a dummy README and CHANGE file
+    %          - :copies: ``source`` directory to ``raw`` directory
+    %          - :removes: the date suffix ``_date-*`` from the files where it is present
+    %          - :zips: the ``_stim.tsv`` files.
 
     sourceDir = fullfile(cfg.dir.output, 'source');
     rawDir = fullfile(cfg.dir.output, 'raw');

src/createFilename.m

@@ -21,11 +21,11 @@
     %
     % The behavior of this function depends on:
     %   - ``cfg.testingDevice``:
-    %     - set to ``pc`` (dummy try) or ``beh`` can work for behavioral experiment.
-    %     - set on ``mri`` for fMRI experiment.
-    %     - set on ``eeg`` or ``ieeg`` can work for electro encephalography or
-    %       intracranial eeg
-    %     - set on ``meg`` can work for magneto encephalography
+    %       + set to ``pc`` (dummy try) or ``beh`` can work for behavioral experiment.
+    %       + set on ``mri`` for fMRI experiment.
+    %       + set on ``eeg`` or ``ieeg`` can work for electro encephalography or intracranial eeg
+    %       + set on ``meg`` can work for magneto encephalography
+    %
     %   - ``cfg.eyeTracker.do`` set to ``true``, can work for simple eyetracking data.
     %
     % See ``test_createFilename`` in the ``tests`` folder for more details on how to use it.

src/createJson.m

@@ -26,8 +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.
+    % :output:
+    %          - :``*.json``: (jsonfile) The file name corresponds to the run + suffix depending
+    %                         on the arguments passed in.
     %
     % .. TODO:
     %

src/gui/setDefaultResponses.m

@@ -13,7 +13,7 @@
     %
     % :returns: - :responses: (cell) It contains the response set by default
     %           - :cfg: (structure) Configuration update with ``cfg.debug.do`` set to false if not
-    %             set by the user.
+    %                   set by the user.
     %
 
     if nargin < 1

src/utils/returnNbColumns.m

@@ -13,8 +13,9 @@
     % :param nameExtraColumn: An entry of ``logFile.extraColumns``
     % :type nameExtraColumn: string
     %
-    % :returns: - :nbCol: (integer) The number of columns associated to one entry of the extra
-    %             column list.
+    % :returns: 
+    %           - :nbCol: (integer) The number of columns associated to one entry of the extra
+    %                     column list.
     %
 
     thisExtraColumn = logFile(1).extraColumns.(nameExtraColumn);