Doxyfile (#53)

* annotate configure.ac

* add a Doxyfile template

* update MVERSION, start adding support for Doxygen

* remove comments from Doxyfile.diff

Co-authored-by: Wolf Lammen <[email protected]>

Author: wlammen

src/Doxyfile.diff

@@ -0,0 +1,39 @@
+# diff to Doxyfile 1.8.17 with only default settings.
+
+# The Doxyfile reflects your personal documentation style.  It is therefore not
+# automatically overwritten by git.  Instead a Doxyfile.diff suggests values we
+# think are quite usable.  You can use this file directly by renaming it to
+# Doxyfile.  You can prepend its contents to your personal Doxyfile, so that the
+# suggested values do not overwrite your settings.  Or, of course, patch your
+# file with a subset suiting your needs. 
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project.
+#
+# All text after a double hash (##) is considered a comment and is placed in
+# front of the TAG it is preceding.
+#
+# All text after a single hash (#) is considered a comment and will be ignored.
+# The format is:
+# TAG = value [value, ...]
+# For lists, items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (\" \").
+
+PROJECT_NAME           = "metamath executable"
+
+# TODO: Set to Metamath version
+
+PROJECT_NUMBER         = "Metamath-version"
+
+PROJECT_BRIEF          = "executable used to maintain *.mm files" 
+
+PROJECT_LOGO           = "Metamath.png"
+
+OUTPUT_DIRECTORY       = "../doxy"
+
+# disable Graphviz .dot output
+
+HAVE_DOT               = NO
+
+GENERATE_LATEX         = NO

src/metamath.c

@@ -10,6 +10,10 @@
    from other people which may be GPL licensed.  For more details see:
    https://github.com/metamath/metamath-exe/issues/7#issuecomment-675555069 */
 
+/*! \file
+ * Contains main(), the starting point of metamath; executes or calls commands
+ */
+
 /* The overall functionality of the modules is as follows:
     metamath.c - Contains main(); executes or calls commands
     mmcmdl.c - Command line interpreter
@@ -54,8 +58,21 @@
 */
 
 
-
-#define MVERSION "0.199.pre 7-Aug-2021"
+/*! \def MVERSION
+ * The current version of metamath.  It is incremented each time the software
+ * is modified.  When main versions are released, the version consists of a
+ * main version, followed by a dot and a three-digit subversion.  Intermediate
+ * versions are further followed by a free style suffix that should allow
+ * ordering.
+ * The version string is extracted and then processed by shell and perl
+ * scripts.  To avoid problems during replacements:
+ * - use only printable characters from the ASCII range;
+ * - avoid characters from the following set, eligible for escaping in text, regular
+ *     expressions and so on like -begin of list ][`*+^$'?"{/}\ end of list-;
+ * - use no space character other than simple space (U+0020);
+ * - never use space characters at the beginning or at the end.
+ */
+#define MVERSION "0.199.pre 29-Jan-2022"
 /* 0.199.pre
    30-Dec-2021 mc metamath.c mmdata.c mminou.c mmmaci.c -
      Remove mmmaci and everything related to THINK_C compiler