add auto-generated docs

Author: scivision

+stdlib/+fileio/absolute_path.m

@@ -1,11 +1,16 @@
 function abspath = absolute_path(p)
+%% absolute_path(p)
 % path need not exist, but absolute path is returned
 %
 % NOTE: some network file systems are not resolvable by Matlab Java
 % subsystem, but are sometimes still valid--so return
 % unmodified path if this occurs.
 %
-% Copyright (c) 2020 Michael Hirsch (MIT License)
+%% Inputs
+% * p: path to make absolute
+%% Outputs
+% * abspath: absolute path, if determined
+
 arguments
   p (1,:) string
 end

+stdlib/+fileio/expanduser.m

@@ -1,23 +1,16 @@
 function expanded = expanduser(p)
-% expanded = expanduser(path)
+%% expanduser(path)
+% expands tilde ~ into user home directory
 %
-%   expands tilde ~ into user home directory
+% Useful for Matlab functions like h5read() and some Computer Vision toolbox functions
+% that can't handle ~
+%% Inputs
+% * p: path to expand, if tilde present
+%% Outputs
+% * expanded: expanded path
 %
-%   Useful for Matlab functions like h5read() and some Computer Vision toolbox functions
-%   that can't handle ~ and Matlab does not consider it a bug per conversations with
-%   Mathworks staff
-%
-%  Benchmark: on laptop and Matlab R2020a
-%
-%   about 200 microseconds
-%   f = @() expanduser('~/foo');
-%   timeit(f)
-%
-%   about 2 microseconds:
-%   f = @() expanduser('foo');
-%   timeit(f)
-%
-%   See also absolute_path
+% See also ABSOLUTE_PATH
+
 arguments
   p string
 end

+stdlib/+fileio/extract_zstd.m

@@ -1,4 +1,5 @@
 function extract_zstd(archive, out_dir)
+%% extract_zstd(archive, out_dir)
 % extract a zstd file "archive" to "out_dir"
 % out_dir need not exist yet, but its parent must
 % We do this with CMake to avoid problems with old system tar.

+stdlib/+fileio/ini2struct.m

@@ -1,11 +1,10 @@
 function Struct = ini2struct(filename)
+%% ini2struct(filename)
 % Parses .ini file
 % Returns a structure with section names and keys as fields.
 %
 % Based on init2struct.m by Andriy Nych
-% 2014/02/01
-%
-% robustified by Michael Hirsch 2020
+
 arguments
   filename (1,1) string {mustBeFile}
 end

+stdlib/+fileio/is_absolute_path.m

@@ -1,5 +1,6 @@
 function isabs = is_absolute_path(apath)
-%% true if path is absolute. Path need not yet exist.
+%% is_absolute_path(apath)
+% true if path is absolute. Path need not yet exist.
 % even if path has inside ".." it's still considered absolute
 % e.g. Python
 %  os.path.isabs("/foo/../bar") == True

+stdlib/+fileio/is_exe.m

@@ -1,6 +1,11 @@
 function ok = is_exe(file)
-%% ok = is_exe(file)
-% is a file executable?
+%% is_exe(file)
+% is a file executable, as per its filesystem attributes
+% does not actually try to run the file.
+%% Inputs
+% * file: filename
+%% Outputs
+% * ok: boolean logical
 
 arguments
   file (1,1) string {mustBeNonzeroLengthText}

+stdlib/+fileio/makedir.m

@@ -1,5 +1,6 @@
 function makedir(direc)
-%% malformed paths can be "created" but are not accessible.
+%% makedir(direc)
+% malformed paths can be "created" but are not accessible.
 % This function works around that bug in Matlab mkdir().
 arguments
   direc (1,1) string {mustBeNonzeroLengthText}
@@ -13,6 +14,6 @@ function makedir(direc)
 
 mkdir(direc);
 
-assert(isfolder(direc), 'not a directory %s', direc)
+assert(isfolder(direc), "stdlib:fileio:makedir:IOError", 'not a directory %s', direc)
 
 end

+stdlib/+fileio/md5sum.m

@@ -1,4 +1,5 @@
 function hash = md5sum(file)
+%% md5sum(file)
 % compute MD5 hash of file
 arguments
   file (1,1) string {mustBeFile}

+stdlib/+fileio/path_tail.m

@@ -1,4 +1,5 @@
 function last = path_tail(apath)
+%% path_tail(apath)
 % get last part of directory path
 % if filename, return filename with suffix
 arguments

+stdlib/+fileio/posix.m

@@ -1,9 +1,14 @@
-function ppath = posix(varargin)
+function ppath = posix(file)
+%% posix(file)
 % convert a path or sequence of path components to a Posix path separated
 % with "/" even on Windows.
 % If Windows path also have escaping "\" this breaks
+arguments
+  file (1,:) string
+end
+
 
-ppath = fullfile(varargin{:});
+ppath = fullfile(file);
 
 if ispc
   ppath = strrep(ppath, "\", "/");