Create Contents.m in fileio and in its subfolds. updated doc string o…

…f fileutil_concantMatlab and fileutil_getFilelist
bbci · Jan 27, 2014 · 6df7a7d · 6df7a7d
1 parent f30686c
commit 6df7a7d
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 2 deletions.
diff --git a/fileio/Contents.m b/fileio/Contents.m
@@ -0,0 +1,11 @@
+%This directory contains functions that are required for reading and
+%writing EEG data files.
+%
+%
+%FILE_LOADMATLAB - Load EEG data structure from Matlab file
+%FILE_SAVEMATLAB - Save EEG data structures in Matlab format
+%
+%FILE_READBV - load EEG data which is stored in BrainVision format.
+%
+%FILE_READBVHEADER - Read header in BrainVision Format
+%FILE_READBVMARKERS - Read markers in BrainVision Format
diff --git a/fileio/private/Contents.m b/fileio/private/Contents.m
@@ -0,0 +1 @@
+%This directory contains the C code for the mex-file version of FILE_READBV
diff --git a/fileio/utils/Contents.m b/fileio/utils/Contents.m
@@ -0,0 +1,6 @@
+%This directory contains utility files for saving and loading EEG data
+%
+%
+%FILEUTIL_CONCATMATLAB - concatenate Matlab data structures
+%FILEUTIL_GETFILELIST - Retrieves a list of header/marker/EEG files.
+%FILEUTIL_ISABSOLUTEPATH - Determines whether a path is absolute or relative.
diff --git a/fileio/utils/fileutil_concatMatlab.m b/fileio/utils/fileutil_concatMatlab.m
@@ -1,8 +1,8 @@
 function [varargout]= fileutil_concatMatlab(file_list, varargin)
-% EEGFILE_CONCATMATLAB - concatenate Matlab data structures
+% FILEUTIL_CONCATMATLAB - concatenate Matlab data structures
 %
 % Synopsis:
-%   [DAT, MRK, MNT]= file_concatBV(FILE_LIST, 'Property, 'Value', ...)
+%   [DAT, MRK, MNT]= fileutil_concatMatlab(FILE_LIST, 'Property, 'Value', ...)
 %
 % Arguments:
 %   FILE_LIST:  CELL|CHAR   list of file names (no extension)

diff --git a/fileio/utils/fileutil_getFilelist.m b/fileio/utils/fileutil_getFilelist.m
@@ -1,4 +1,23 @@
 function file= fileutil_getFilelist(spec, varargin)
+% FILEUTIL_GETFILELIST - Retrieves a list of header/marker/EEG files.
+%
+% Synopsis:
+%   File= fileutil_getFilelist(SPEC, 'Property, 'Value', ...)
+%
+% Arguments:
+%   SPEC:  CELL|CHAR   list of file names (no extension)
+%
+% Properties:
+%   'Ext': file extension. default: 'eeg' 
+%   'Folder': base directory to search for files. default: BBCI.RawDir
+%   'RequireMatch': boolean. This function will throw an error it this
+%   property is set to true and no files were found
+%
+% Returns:
+%   FILE: filename corresponding to spec (if found). FILE may also be a cell array of file names.
+%
+%
+
 
 %% TODO: should also handle: spec is cell array
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		%This directory contains the C code for the mex-file version of FILE_READBV