documented code a little more

This commit is contained in:
hyung-hwan 2009-06-02 19:40:23 +00:00
parent 9fcfd0c0ba
commit 0b8d9a9b87
3 changed files with 57 additions and 10 deletions

View File

@ -790,7 +790,7 @@ HTML_FOOTER =
# the style sheet file to the HTML output directory, so don't put your own # the style sheet file to the HTML output directory, so don't put your own
# stylesheet in the HTML output directory as well, or it will be erased! # stylesheet in the HTML output directory as well, or it will be erased!
HTML_STYLESHEET = HTML_STYLESHEET = ./doxygen.css
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to # files or namespaces will be aligned in HTML using tables. If set to

View File

@ -11,14 +11,61 @@ The project webpage: http://qse.googlecode.com/
For furthur information, contact: For furthur information, contact:
Chung, Hyung-Hwan <bacon@abiyo.net> Chung, Hyung-Hwan <bacon@abiyo.net>
@section INSTALLATION @section installation INSTALLATION
Cross compiling for WIN32 with MINGW32
./configure --host=i586-mingw32msvc --target=i586-mingw32msvc --enable-syscall @subsection bulid_tarball_unix BUILINDG FROM A SOURCE TARBALL UNDER LINUX/UNIX
make
Download the latest source tarball from:
- http://code.google.com/p/qse/downloads/list
Unpack the tarball and run configure and make to compile it:
@code
$ ./configure
$ make
$ make install
@endcode
To cross-comiple it for WIN32 with MINGW32, run configure as shown below:
@code
$ ./configure --host=i586-mingw32msvc --target=i586-mingw32msvc
$ make
$ make install
@endcode
@note For cross-compilation, get a cross-compiler installed first.
@subsection build_mchar BUILING FOR MULTI-BYTE CHARACTER MODE
The library can be built for two different character modes:
- multi-byte character mode
- wide character mode
Under the multi-byte character mode:
- #QSE_CHAR_IS_MCHAR is defined.
- #qse_char_t maps to #qse_mchar_t.
- #QSE_T("x") becomes "x".
Under the wide character mode:
- #QSE_CHAR_IS_WCHAR is defined.
- #qse_char_t maps to #qse_wchar_t.
- #QSE_T("x") becomes L"x".
Typically, #qse_mchar_t maps char and #qse_wchar_t is maps to wchar_t in both modes.
By default, the library is built for the wide character mode. To compile it
for the multi-byte character mode, run configure with the @b --disable-wchar option
specified explicitly.
@code
$ ./configure --disable-wchar
$ make
$ make install
@endcode
@section MODULES @section MODULES
QSE includes various modules: QSE includes various modules:
- @ref awk "AWK" - @subpage awk "AWK"
- @ref sed "SED" - @subpage sed "SED"
*/ */

View File

@ -1,5 +1,5 @@
/* /*
* $Id: types.h 172 2009-06-01 13:33:01Z hyunghwan.chung $ * $Id: types.h 173 2009-06-02 01:40:23Z hyunghwan.chung $
* *
Copyright 2006-2009 Chung, Hyung-Hwan. Copyright 2006-2009 Chung, Hyung-Hwan.
@ -223,12 +223,12 @@ typedef qse_uint8_t qse_byte_t;
* The qse_ssize_t type defines a signed integer type that is as large as * The qse_ssize_t type defines a signed integer type that is as large as
* to hold a pointer value. * to hold a pointer value.
*/ */
typedef qse_int_t qse_ssize_t; typedef qse_int_t qse_ssize_t;
/** /**
* The qse_word_t type redefines qse_uint_t. * The qse_word_t type redefines qse_uint_t.
*/ */
typedef qse_uint_t qse_word_t; typedef qse_uint_t qse_word_t;
/** @typedef qse_real_t /** @typedef qse_real_t
* The qse_real_t type defines the largest floating-pointer number type * The qse_real_t type defines the largest floating-pointer number type