correct docstrings

Author: scivision

+stdlib/absolute.m

@@ -1,4 +1,3 @@
-function c = absolute(p, base, expand_tilde, use_java)
 %% ABSOLUTE Determine absolute path
 % c = absolute(p);
 % Path "p" need not exist.
@@ -16,6 +15,8 @@
 %
 % does not normalize path
 % non-existant path is made absolute relative to pwd
+
+function c = absolute(p, base, expand_tilde, use_java)
 arguments
   p (1,1) string
   base string {mustBeScalarOrEmpty} = string.empty

+stdlib/auto_chunk_size.m

@@ -1,4 +1,3 @@
-function csize = auto_chunk_size(dims)
 %% AUTO_CHUNK_SIZE determine HDF5 / NetCDF4 chunk size
 %
 % based on https://github.com/h5py/h5py/blob/master/h5py/_hl/filters.py
@@ -7,6 +6,7 @@
 %%% Inputs
 % * dims: proposed dataset dimensions (like size())
 
+function csize = auto_chunk_size(dims)
 arguments
   dims (1,:) {mustBeInteger,mustBePositive}
 end

+stdlib/canonical.m

@@ -1,4 +1,3 @@
-function c = canonical(p, expand_tilde, use_java)
 %% CANONICAL Canonicalize path
 % c = canonical(p);
 % If exists, canonical absolute path is returned.
@@ -13,6 +12,8 @@
 %%% Outputs
 % * c: canonical path, if determined
 % https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html#getCanonicalPath()
+
+function c = canonical(p, expand_tilde, use_java)
 arguments
   p (1,1) string
   expand_tilde (1,1) logical = true

+stdlib/checkRAM.m

@@ -1,11 +1,11 @@
-function [OK,newSizeBytes,freebytes] = checkRAM(newSize, myclass)
 %% CHECKRAN estimate if RAM will fit a new array
 % checks that requested memory for the new array won't exceed AVAILABLE RAM with Matlab
 %
 % This script is optimistic as Matlab won't always be able to
 % create an array using ALL available RAM, but at least you know when you
 % certainly CAN'T create an array without digging deep into swap or worse.
 
+function [OK,newSizeBytes,freebytes] = checkRAM(newSize, myclass)
 arguments
   newSize (1,:) {mustBeNumeric}
   myclass (1,1) string = "double"

+stdlib/cpu_count.m

@@ -1,9 +1,10 @@
-function N = cpu_count
 %% CPU_COUNT how many CPUs are available
-N = maxNumCompThreads;
-if N < 2  % happens on some HPC
-  N = feature('NumCores');
-end
+function N = cpu_count()
+
+  N = maxNumCompThreads;
+  if N < 2  % happens on some HPC
+    N = feature('NumCores');
+  end
 
 % logical CPUs
 % https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/Runtime.html#getRuntime()

+stdlib/cpu_load.m

@@ -1,12 +1,14 @@
-function L = cpu_load()
 %% CPU_LOAD get total physical CPU load
-% https://docs.oracle.com/en/java/javase/21/docs/api/jdk.management/com/sun/management/OperatingSystemMXBean.html#getCpuLoad()
 % Returns the "recent cpu usage" for the whole system.
 %
 % This value is a double in the [0.0,1.0] interval.
 % A value of 0.0 means that all CPUs were idle during the recent period of time observed, while a value of 1.0 means that all CPUs were actively running 100% of the time during the recent period being observed.
 % All values betweens 0.0 and 1.0 are possible depending of the activities going on in the system.
 % If the system recent cpu usage is not available, the method returns a negative value.
+%
+% Ref: https://docs.oracle.com/en/java/javase/21/docs/api/jdk.management/com/sun/management/OperatingSystemMXBean.html#getCpuLoad()
+
+function L = cpu_load()
 
 b = java.lang.management.ManagementFactory.getOperatingSystemMXBean();
 

+stdlib/create_symlink.m

@@ -1,4 +1,3 @@
-function ok = create_symlink(target, link)
 %% CREATE_SYMLINK create symbolic link
 %
 %%% Inputs
@@ -9,6 +8,8 @@
 %
 % Ref: https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Files.html#createSymbolicLink(java.nio.file.Path,java.nio.file.Path,java.nio.file.attribute.FileAttribute...)
 
+function ok = create_symlink(target, link)
+
 arguments
   target (1,1) string
   link (1,1) string

+stdlib/diskfree.m

@@ -1,14 +1,15 @@
-function freebytes = diskfree(direc)
 %% DISKFREE disk free space
 % returns disk free space in bytes
 %
 % example:  diskfree('/')
 %
 % Ref: https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html#getUsableSpace()
+
+function freebytes = diskfree(d)
 arguments
-  direc (1,1) string {mustBeFolder}
+  d (1,1) string {mustBeFolder}
 end
 
-freebytes = java.io.File(direc).getUsableSpace;
+freebytes = java.io.File(d).getUsableSpace;
 
 end

+stdlib/exists.m

@@ -1,12 +1,13 @@
-function ok = exists(p, use_java)
-%% EXIST does path exist
+%% EXISTS does path exist
+%
 %%% Inputs
 % * p: path to check
 %%% Outputs
 % * ok: true if exists
 %
 % Ref: https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html#exists()
 
+function ok = exists(p, use_java)
 arguments
   p (1,1) string
   use_java (1,1) logical = false

+stdlib/expanduser.m

@@ -1,4 +1,3 @@
-function e = expanduser(p, use_java)
 %% EXPANDUSER expands tilde ~ into user home directory
 %
 % Useful for Matlab functions that can't handle ~
@@ -7,6 +6,8 @@
 % * p: path to expand, if tilde present
 %%% Outputs
 % * e: expanded path
+
+function e = expanduser(p, use_java)
 arguments
   p (1,1) string
   use_java (1,1) logical = false