fix(tests): miscelaneous docstring fixes

This fixes some docstrings related issues:

1. Remove leading whitespaces in some places
2. avoid displaying output of some test assignments
3. avoid nested execution of `xunit` tests
when `checkDocstrings` hits the `runAllTests` routine.
4. Fix wrong parameter file in
`detectMappingDelimiter` docstring.
5. Fix wrong function reference in
`IMOS.meta.site_bathymetry` docstring.

Util/+IMOS/+meta/site_bathymetry.m

@@ -18,11 +18,11 @@
 % Example:
 % sample_data.site_nominal_depth = [];
 % sample_data.site_depth_at_deployment = [];
-% assert(isempty(IMOS.meta.get_site_bathymetry(sample_data)))
+% assert(isempty(IMOS.meta.site_bathymetry(sample_data)))
 % sample_data.site_nominal_depth = 20;
-% assert(IMOS.meta.get_site_bathymetry(sample_data)==20)
+% assert(IMOS.meta.site_bathymetry(sample_data)==20)
 % sample_data.site_depth_at_deployment = 10;
-% assert(IMOS.meta.get_site_bathymetry(sample_data)==10)
+% assert(IMOS.meta.site_bathymetry(sample_data)==10)
 %
 % author: hugo.oliveira@utas.edu.au
 %

Util/TestUtils/checkDocstrings.m

@@ -4,11 +4,11 @@
 % Check all matlab source file IMOS docstrings in a folder.
 %
 % Inputs:
-% 
+%
 % folder [str] - a string with the folder location.
 %
 % Outputs:
-% 
+%
 % ok [bool] - All docstrings are fine.
 % wrong_files - A cell where the evaluation of the docstring failed.
 %

Util/detectMappingDelimiter.m

@@ -16,7 +16,7 @@
 % %basic usage
 % comma_file = [toolboxRootPath 'GUI/instrumentAliases.txt'];
 % assert(isequal(detectMappingDelimiter(comma_file),','))
-% equal_file = [toolboxRootPath 'AutomaticQC/imosEchoIntensityQC.txt'];
+% equal_file = [toolboxRootPath 'AutomaticQC/imosEchoIntensitySetQC.txt'];
 % assert(isequal(detectMappingDelimiter(equal_file),'='))
 %
 %
@@ -38,7 +38,7 @@
 catch
 end
 
-try 
+try
 	equal_opts = readMappings(fname,'=');
 	equal_ok = true;
 catch
@@ -53,7 +53,7 @@
 	return
 elseif comma_ok
 	delimiter = ',';
-elseif equal_ok 
+elseif equal_ok
 	delimiter = '=';
 end
 

Util/memuse.m

@@ -15,17 +15,17 @@
 %
 % Example:
 %
-% x = memuse(1048576,'logical')
+% x = memuse(1048576,'logical');
 % assert(x==1)
-% x = memuse(1048576,'double')
+% x = memuse(1048576,'double');
 % assert(x==8)
-% x = memuse(1048576,'single')
+% x = memuse(1048576,'single');
 % assert(x==4)
 %
 % %we dont introspect content for cells/struct
-% x = memuse(1,'struct')
+% x = memuse(1,'struct');
 % assert(isinf(x))
-% x = memuse(1,'cell')
+% x = memuse(1,'cell');
 % assert(isinf(x))
 %
 %

test/runAllTests.m

@@ -15,7 +15,7 @@
 %
 %
 % Example:
-% runAllTests(1);
+% %runAllTests(0);
 %
 % author: hugo.oliveira@utas.edu.au
 %