Mercurial > hg > massef

changeset 15:bdd77fe783e4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated MASSEF documentation with new properties and methods. Added documentation for doc method.
author Christopher Hummersone <c.hummersone@surrey.ac.uk>
date Tue, 07 Mar 2017 12:20:31 +0000
parents aea77872f608
children 90887c0061d4 cf45d7071d97
files help_html/helptoc.xml help_html/source/help_MASSEF.m help_html/source/help_MASSEF_doc.m help_html/source/publishHelp.m
diffstat 4 files changed, 32 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/help_html/helptoc.xml	Tue Mar 07 12:08:29 2017 +0000
+++ b/help_html/helptoc.xml	Tue Mar 07 12:20:31 2017 +0000
@@ -5,6 +5,7 @@
         <tocitem target="help_MASSEF.html">MASSEF
             <tocitem target="help_MASSEF_evaluate.html">MASSEF.evaluate</tocitem>
             <tocitem target="help_MASSEF_execute.html">MASSEF.execute</tocitem>
+            <tocitem target="help_MASSEF_doc.html">MASSEF.doc</tocitem>
             <tocitem target="help_MASSEF_install.html">MASSEF.install</tocitem>
             <tocitem target="help_MASSEF_save.html">MASSEF.save</tocitem>
             <tocitem target="help_MASSEF_start.html">MASSEF.start</tocitem>
--- a/help_html/source/help_MASSEF.m	Tue Mar 07 12:08:29 2017 +0000
+++ b/help_html/source/help_MASSEF.m	Tue Mar 07 12:20:31 2017 +0000
@@ -27,6 +27,10 @@
 % considered at any one time. The default is 128.</td>
 % </tr>
 % <tr>
+% <td><tt>creationDate</tt></td>
+% <td>Date the object was created (read-only).</td>
+% </tr>
+% <tr>
 % <td><tt>dir</tt></td>
 % <td>The MASSEF installation directory (read-only).</td>
 % </tr>
@@ -59,6 +63,10 @@
 % href="help_MASSEF_execute.html">MASSEF.execute</a> finishes.
 % The default is <tt>'Results/results.mat'</tt>.</td>
 % </tr>
+% <tr>
+% <td><tt>saveDate</tt></td>
+% <td>Date the object was last saved (read-only).</td>
+% </tr>
 % </table>
 % </html>
 %   
@@ -80,6 +88,10 @@
 % <td><a href="help_MASSEF_execute.html">execute</a></td>
 % <td>Run the framework using the input mixtures and separators.</td>
 % </tr>
+% <tr>
+% <td><a href="help_MASSEF_save.html">save</a></td>
+% <td>Save the framework's data and results.</td>
+% </tr>
 % </table>
 % </html>
 % 
@@ -87,6 +99,9 @@
 % 
 % <html>
 % <table>
+% <tr>
+% <td><a href="help_MASSEF_doc.html">doc</a></td>
+% <td>Display the framework documentation.</td>
 % </tr>
 % <tr>
 % <td><a href="help_MASSEF_install.html">install</a></td>
@@ -95,6 +110,7 @@
 % <tr>
 % <td><a href="help_MASSEF_start.html">start</a></td>
 % <td>Start the framework.</td>
+% </tr>
 % </table>
 % </html>
 % 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/help_html/source/help_MASSEF_doc.m	Tue Mar 07 12:20:31 2017 +0000
@@ -0,0 +1,14 @@
+%% MASSEF.doc
+% Display the framework documentation.
+% 
+%% Syntax
+% 
+%   MASSEF.doc
+% 
+% |MASSEF.doc| opens the framework's documentation in the MATLAB browser.
+% 
+% <html>
+% <hr>
+% <p>Copyright &copy; 2016 <a href="http://www.surrey.ac.uk">University of Surrey</a><br>
+% <a href="http://iosr.uk">Institute of Sound Recording, University of Surrey, UK</a></p>
+% </html>
--- a/help_html/source/publishHelp.m	Tue Mar 07 12:08:29 2017 +0000
+++ b/help_html/source/publishHelp.m	Tue Mar 07 12:20:31 2017 +0000
@@ -11,6 +11,7 @@
 publish('help_MASSEF.m',options);
 publish('help_MASSEF_evaluate.m',options);
 publish('help_MASSEF_execute.m',options);
+publish('help_MASSEF_doc.m',options);
 publish('help_MASSEF_install.m',options);
 publish('help_MASSEF_save.m',options);
 publish('help_MASSEF_start.m',options);