From 1e38f5d0a91a2f533ed499464a11657e243290c6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Adjemian=20=28Charybdis=29?=
<stephane.adjemian@univ-lemans.fr>
Date: Fri, 12 Dec 2014 10:15:33 +0100
Subject: [PATCH] Added Contents.m file.
If m-unit-tests/src is in the Matlab/Octave's path, then
help m-unit-tests/src
will display the list of routines in the toolbox and an example.
---
src/Contents.m | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
create mode 100644 src/Contents.m
diff --git a/src/Contents.m b/src/Contents.m
new file mode 100644
index 0000000..e2ba145
--- /dev/null
+++ b/src/Contents.m
@@ -0,0 +1,20 @@
+% Matlab/Octave toolbox for performing unit tests.
+%
+% Routines:
+%
+% build_report_summary - Builds a summary report.
+% dassert - Tests the equality of two objects.
+% dtest - Runs unit test defined in a Matlab/Octave routine, by calling mtest, and display results.
+% get_directory_description - Lists recursively all the *.m files in a directory.
+% initialize_unit_tests_toolbox - Initialization of the path to the m-unit-tests/src folder.
+% is_unitary_test_available - Decides if unitary tests defined in a Matlab/Octave routine have to be run
+% mtest - Extracts unit test sections from Matlab/Octave's routine, executes the tests and reports results.
+% run_unitary_tests - Runs unitary tests defined in a collection of files.
+% run_unitary_tests_in_directory - Runs all the unitary tests defined in a directory (and subfolders).
+%
+%
+% Example:
+%
+% >> addpath m-unit-tests
+% >> initialize_unit_test_toolbox
+% >> run_unitary_tests_in_directory('dates/src/@dates')
\ No newline at end of file
--
GitLab