changeset 17105:fa3f2ac0e825 stable

Write the intro text for the main Doxygen page. * main.c: Add text for main Doxygen page
author Jordi Gutiérrez Hermoso <jordigh@octave.org>
date Sun, 28 Jul 2013 11:29:13 -0400
parents c48625614ea6
children 054905bfc306 2c76db746701
files src/main.c
diffstat 1 files changed, 18 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/src/main.c
+++ b/src/main.c
@@ -34,3 +34,21 @@
 {
   return octave_main (argc, argv, 0);
 }
+
+/*!
+@mainpage Source code documentation for GNU Octave
+
+GNU Octave is a high-level language, primarily intended for numerical
+computations.  It provides a convenient interactive command line
+interface for solving linear and nonlinear problems numerically, and
+for performing other numerical experiments.  It may also be used as a
+batch-oriented language for data processing.
+
+GNU Octave is free software. You may redistribute it and/or modify it
+under the terms of the <a href="http://www.gnu.org/licenses/">GNU
+General Public License</a> as published by the Free Software Foundation.
+
+This is the developer documentation for Octave's own source code. It is
+intended to help for hacking Octave. It may also be useful for
+understanding the Octave API when writing your own .oct files.
+*/