touched up code and documentation

This commit is contained in:
2009-05-28 01:01:33 +00:00
parent 502bab8e4e
commit 83a6e0d3b0
11 changed files with 369 additions and 141 deletions

View File

@ -564,7 +564,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = ../include ../README
INPUT = ../include ./page
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@ -581,7 +581,7 @@ INPUT_ENCODING = UTF-8
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
FILE_PATTERNS = *.h *.c *.hpp *.cpp
FILE_PATTERNS = *.h *.c *.hpp *.cpp *.doc
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
@ -1210,13 +1210,13 @@ ENABLE_PREPROCESSING = YES
# compilation will be performed. Macro expansion can be done in a controlled
# way by setting EXPAND_ONLY_PREDEF to YES.
MACRO_EXPANSION = NO
MACRO_EXPANSION = YES
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
# then the macro expansion is limited to the macros specified with the
# PREDEFINED and EXPAND_AS_DEFINED tags.
EXPAND_ONLY_PREDEF = NO
EXPAND_ONLY_PREDEF = YES
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
# in the INCLUDE_PATH (see below) will be search if a #include is found.
@ -1244,7 +1244,11 @@ INCLUDE_FILE_PATTERNS =
# undefined via #undef or recursively expanded use the := operator
# instead of the = operator.
PREDEFINED =
PREDEFINED = \
"QSE_BEGIN_NAMESPACE(x)=namespace x {" \
"QSE_END_NAMESPACE(x)=}" \
"QSE_BEGIN_NAMESPACE2(x,y)=namespace x { namespace y {" \
"QSE_END_NAMESPACE2(x,y)=} }"
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.

4
qse/doc/page/awk.doc Normal file
View File

@ -0,0 +1,4 @@
/** @page awk AWK
AWK Interpreter
*/

29
qse/doc/page/main.doc Normal file
View File

@ -0,0 +1,29 @@
/** @mainpage QSE
@section INTRODUCTION
QSE provides a script engine for various scripting languages and utility programs. It aims to produce a flexible script engine framework that can be embedded into an application. A hosting application can access various aspects of the embedded script engine and vice versa.
The library is licended under the Apache License, Version 2.0.
The project webpage: http://qse.googlecode.com/
For furthur information, contact:
Chung, Hyung-Hwan <b a c o n e v i @ g m a i l . c o m>
@section INSTALLATION
Cross compiling for WIN32 with MINGW32
./configure --host=i586-mingw32msvc --target=i586-mingw32msvc --enable-syscall
make
@section DOCUMENTATION
Generate the API documents with robodoc.
robodoc --rc doc/robodoc.rc --css doc/robodoc.css --src . --doc ./doc/qse
@section MODULES
QSE includes various modules:
- @ref awk "AWK"
- @ref sed "SED"
*/

9
qse/doc/page/sed.doc Normal file
View File

@ -0,0 +1,9 @@
/** @page sed SED
STREAM EDITOR
a stream editor is provided
@section sed_io_handler How to write an IO handler
IO handler has the following prototype...
*/