Enlightenment CVS committal
Author : mej
Project : eterm
Module : libast
Dir : eterm/libast/src
Modified Files:
conf.c options.c
Log Message:
Fri Mar 7 23:52:30 2003 Michael Jennings (mej)
Definitely making progress on the documentation, but there's still a
long way to go.
===================================================================
RCS file: /cvsroot/enlightenment/eterm/libast/src/conf.c,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -3 -r1.8 -r1.9
--- conf.c 24 Feb 2003 03:03:20 -0000 1.8
+++ conf.c 8 Mar 2003 04:52:56 -0000 1.9
@@ -31,7 +31,7 @@
* @author Michael Jennings <[EMAIL PROTECTED]>
*/
-static const char cvs_ident[] = "$Id: conf.c,v 1.8 2003/02/24 03:03:20 mej Exp $";
+static const char cvs_ident[] = "$Id: conf.c,v 1.9 2003/03/08 04:52:56 mej Exp $";
#ifdef HAVE_CONFIG_H
# include <config.h>
@@ -977,3 +977,28 @@
* Example code for using the string routines.
*
*/
+
+/**
+ * @defgroup DOXGRP_CONF_FSS File State Stack
+ * @ingroup DOXGRP_CONF
+ *
+ * @note An understanding of the inner workings of the file state
+ * stack is not necessary to use the config file parser. If you
+ * aren't interested in understanding the LibAST internals, you should
+ * skip most of this section and simply study the examples.
+ *
+ * Parsers must keep track of various state-related information when
+ * parsing files, things like file name, line number, etc. And since
+ * LibAST's config file parser supports the inclusion of sub-files via
+ * its %include directive, it must keep track of multiple instances of
+ * this information, one for each file. LibAST uses a structure array
+ * called the File State Stack.
+ */
+
+/**
+ * @defgroup DOXGRP_CONF_CTX Context Handling
+ * @ingroup DOXGRP_CONF
+ *
+ *
+ */
+
===================================================================
RCS file: /cvsroot/enlightenment/eterm/libast/src/options.c,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -3 -r1.6 -r1.7
--- options.c 19 Feb 2003 21:10:36 -0000 1.6
+++ options.c 8 Mar 2003 04:52:56 -0000 1.7
@@ -21,7 +21,17 @@
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
-static const char cvs_ident[] = "$Id: options.c,v 1.6 2003/02/19 21:10:36 mej Exp $";
+/**
+ * @file options.c
+ * Command Line Option Parser Source File
+ *
+ * This file contains the functions which comprise the command line
+ * option parser.
+ *
+ * @author Michael Jennings <[EMAIL PROTECTED]>
+ */
+
+static const char cvs_ident[] = "$Id: options.c,v 1.7 2003/03/08 04:52:56 mej Exp $";
#ifdef HAVE_CONFIG_H
# include <config.h>
@@ -438,3 +448,20 @@
}
SPIFOPT_FLAGS_SET(SPIFOPT_SETTING_POSTPARSE);
}
+
+/**
+ * @defgroup DOXGRP_OPT Command Line Option Parser
+ *
+ * This group of functions/defines/macros comprises the command line
+ * option parser.
+ *
+ *
+ * A small sample program demonstrating some of these routines can be
+ * found @link opt_example.c here @endlink.
+ */
+
+/**
+ * @example opt_example.c
+ * Example code for using the options parser.
+ *
+ */
-------------------------------------------------------
This SF.net email is sponsored by: Etnus, makers of TotalView, The debugger
for complex code. Debugging C/C++ programs can leave you feeling lost and
disoriented. TotalView can help you find your way. Available on major UNIX
and Linux platforms. Try it free. www.etnus.com
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
