Documentation for mp_disp(), mp_printf(), mp.logger.

Author: rdzman

README.md

@@ -36,8 +36,9 @@ of MATLAB or Octave, including setting up your MATLAB/Octave path.
   t_test_fcns.......ok
   t_debug_assert....ok
   t_have_feature....ok
-  All tests successful (37 of 37)
-  Elapsed time 0.13 seconds.
+  t_mp_logger.......ok
+  All tests successful (51 of 51)
+  Elapsed time 0.20 seconds.
 ```
 
 Usage
@@ -273,14 +274,14 @@ particular function.
   (all char arrays). Calling `mptestver` without assigning the return value
   prints the version and release date of the current installation of MP-Test.
 
-- __mp.disp__ — drop-in replacement for `disp()`
+- __mp_disp__ — drop-in replacement for `disp()`
   ```
   mp_disp(obj)
   ```
   Optionally redirects the output of `disp()` to a file via an `mp.logger`
   object, or elsewhere via a custom `mp.logger` subclass.
 
-- __mp.printf__ — drop-in replacement for `fprintf()`
+- __mp_printf__ — drop-in replacement for `fprintf()`
   ```
   mp_printf(format_str, arg1, ...)
   mp_printf(fid, format_str, arg1, ...)

docs/sphinx/source/classes/mp/logger.rst

@@ -0,0 +1,10 @@
+.. currentmodule:: mptest.+mp
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mptest/blob/master/lib/+mp/logger.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+mp.logger
+---------
+
+.. autoclass:: logger
+    :show-inheritance:
+    :members:

docs/sphinx/source/functions/mp_disp.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mptest/blob/master/lib/mp_disp.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+mp_disp
+-------
+
+.. autofunction:: mp_disp

docs/sphinx/source/functions/mp_printf.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mptest/blob/master/lib/mp_printf.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+mp_printf
+---------
+
+.. autofunction:: mp_printf

docs/sphinx/source/functions/t_mp_logger.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mptest/blob/master/lib/t/t_mp_logger.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+t_mp_logger
+-----------
+
+.. autofunction:: t_mp_logger

docs/sphinx/source/index.rst

@@ -45,9 +45,11 @@ of MATLAB or Octave, including setting up your MATLAB/Octave path.
 
         >> test_mptest
         t_test_fcns.......ok
+        t_debug_assert....ok
         t_have_feature....ok
-        All tests successful (29 of 29)
-        Elapsed time 0.18 seconds.
+        t_mp_logger.......ok
+        All tests successful (51 of 51)
+        Elapsed time 0.20 seconds.
 
 
 Usage

docs/sphinx/source/matlab-source/mptest/+mp/logger.m

@@ -0,0 +1 @@
+../../../../../../lib/+mp/logger.m

docs/sphinx/source/matlab-source/mptest/mp_disp.m

@@ -0,0 +1 @@
+../../../../../lib/mp_disp.m

docs/sphinx/source/matlab-source/mptest/mp_printf.m

@@ -0,0 +1 @@
+../../../../../lib/mp_printf.m

docs/sphinx/source/matlab-source/mptest/t_mp_logger.m

@@ -0,0 +1 @@
+../../../../../lib/t/t_mp_logger.m