diff options
author | Murray Cumming <murrayc@murrayc.com> | 2010-05-03 23:38:35 +0200 |
---|---|---|
committer | Murray Cumming <murrayc@murrayc.com> | 2010-05-03 23:38:35 +0200 |
commit | f4c74d287c79bd920625e40351e505231428c98a (patch) | |
tree | ed643af57592aa97fa84eb4cb64a702bd9b8c747 /glib/glibmm.h | |
parent | a02e4b5ec4230a964830abd0e98cda16eafcc3fc (diff) | |
download | glibmm-f4c74d287c79bd920625e40351e505231428c98a.tar.gz |
Documentation: Add more links to main page, and mention giomm.
* glib/glibmm.h: Add more doxggen links to groups and classes, based on
http://www.gtkmm.org/documentation.shtml and a look at the classes list.
Mention giomm features and add giomm to the pkg-config calls and mention
giomm.h
Diffstat (limited to 'glib/glibmm.h')
-rw-r--r-- | glib/glibmm.h | 33 |
1 files changed, 25 insertions, 8 deletions
diff --git a/glib/glibmm.h b/glib/glibmm.h index 2945add4..76a2f0d8 100644 --- a/glib/glibmm.h +++ b/glib/glibmm.h @@ -24,33 +24,50 @@ * * @section description Description * - * glibmm is the official C++ interface for the popular library %Glib. See also - * the <a href="http://library.gnome.org/devel/gtkmm-tutorial/stable/"> + * glibmm is the official C++ interface for the popular cross-platform library %Glib. + * It provides non-UI API that is not available in standard C++ and makes it + * possible for gtkmm to wrap GObject-based APIs. + * See also the <a href="http://library.gnome.org/devel/gtkmm-tutorial/stable/"> * Programming with gtkmm</a> book for a tutorial on programming with gtkmm and * glibmm. * * @section features Features * - * - A UTF-8 string class that has the interface of std::string. - * - A reference-counting smartpointer for easy memory management. - * - Intermediate types for compatibility with STL containers. + * - Glib::ustring: A UTF-8 string class that can be used interchangably with std::string. Plus @ref StringUtils + * - Glib::RefPtr: A reference-counting smartpointer, for use with Glib::ObjectBase or similar + * - @ref CharsetConv + * - Glib::Regex: Regular expression string matching. + * - Glib::KeyFile: Parsing and writing of key files (similar to .ini files) + * - Glib::Checksum + * - Glib::Date, Glib::Timer, Glib::TimeVal + * - Glib::Dispatcher: Inter-thread communication + * - @ref FileUtils and @ref UriUtils + * - @ref MainLoop + * - @ref Spawn + * - @ref Threads + * - @ref MiscUtils + * + * giomm (part of the glibmm project) also contains: + * - Asynchronous IO. See Gio::File and the @ref Streams. + * - @ref NetworkIO * * @section basics Basic Usage * - * Include the glibmm header: + * Include the glibmm header, plus giomm if necessary: * @code * #include <glibmm.h> + * #include <giomm.h> * @endcode * (You may include individual headers, such as @c glibmm/ustring.h instead.) * * If your source file is @c program.cc, you can compile it with: * @code - * g++ program.cc -o program `pkg-config --cflags --libs glibmm-2.4` + * g++ program.cc -o program `pkg-config --cflags --libs glibmm-2.4 giomm-2.4` * @endcode * * Alternatively, if using autoconf, use the following in @c configure.ac: * @code - * PKG_CHECK_MODULES([GLIBMM], [glibmm-2.4]) + * PKG_CHECK_MODULES([GLIBMM], [glibmm-2.4 giomm-2.4]) * @endcode * Then use the generated @c GLIBMM_CFLAGS and @c GLIBMM_LIBS variables in the * project Makefile.am files. For example: |