summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard Braun <syn@sceen.net>2006-05-30 00:51:55 +0000
committerRichard Braun <syn@sceen.net>2006-05-30 00:51:55 +0000
commit786f6740bbe106169937d957a7e4e8d1f88b1664 (patch)
treed1e8a85ddff6ceba74460d29ea4e7ad1d7c9291f
parent9a5d814c406619e7e696f7dc1b52977d6a829343 (diff)
Documentation improvement.
-rw-r--r--mtx.doxygen4
-rw-r--r--mtx.h44
2 files changed, 46 insertions, 2 deletions
diff --git a/mtx.doxygen b/mtx.doxygen
index 58b602d..9c3b185 100644
--- a/mtx.doxygen
+++ b/mtx.doxygen
@@ -1,5 +1,5 @@
-PROJECT_NAME = mtx
-PROJECT_NUMBER = 0.1
+PROJECT_NAME =
+PROJECT_NUMBER =
OUTPUT_DIRECTORY = doc
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
diff --git a/mtx.h b/mtx.h
index eb55154..57ce4cd 100644
--- a/mtx.h
+++ b/mtx.h
@@ -19,6 +19,50 @@
*/
/**
+ * \mainpage mtx 0.1
+ *
+ * \section intro_sec Introduction
+ *
+ * Mtx is a small interpreter for a subset of the MATLAB/GNU Octave language
+ * specialized for matrix calculus. It can be compiled to use 64 bits words
+ * (which improves performance on 64 bits processors), and is able to handle
+ * arbitrary length values for every symbol.
+ *
+ * \section usage_sec Usage
+ *
+ * There are two ways to use mtx :
+ * - the command line interface (mtx_cli)
+ * - the graphical user interface (mtx_gui)
+ *
+ * Both interfaces provide exactly the same engine, so there will be no
+ * other difference than the interface itself. Start mtx by typing
+ * either ./mtx_cli or ./mtx_gui.
+ *
+ * Once your interface is ready, you can enter expressions. The simplest
+ * form of expression is the value (either a variable or an immediate value).
+ * For example :
+ * <pre>
+ * mtx_cli> 5
+ * ans = 5
+ * mtx_cli> ans
+ * ans = 5
+ * </pre>
+ * An immediate value is considered to be an integer or, if a dot
+ * (".") is found, a rational :
+ * <pre>
+ * mtx_cli> 123
+ * ans = 123
+ * mtx_cli> 1.23
+ * ans = 123/100
+ * </pre>
+ * Assignment uses the <code>=</code> operator :
+ * <pre>
+ * mtx_cli> a=123
+ * a = 123
+ * </pre>
+ */
+
+/**
* \file mtx.h
* \brief Global header.
*