[libvtemm/libvtemm-0-24] Made main page consistent with rest of *mm modules.
- From: Krzesimir Nowak <krnowak src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libvtemm/libvtemm-0-24] Made main page consistent with rest of *mm modules.
- Date: Fri, 28 May 2010 17:21:40 +0000 (UTC)
commit fafe49bcc03f2c06359b2106288d5bc8654f85b8
Author: Krzesimir Nowak <qdlacz gmail com>
Date: Fri May 28 19:21:22 2010 +0200
Made main page consistent with rest of *mm modules.
* libvte/libvtemm.h: Updated main page.
libvte/libvtemm.h | 83 ++++++++++++++++-------------------------------------
1 files changed, 25 insertions(+), 58 deletions(-)
---
diff --git a/libvte/libvtemm.h b/libvte/libvtemm.h
index 905ede1..3bea44b 100644
--- a/libvte/libvtemm.h
+++ b/libvte/libvtemm.h
@@ -25,64 +25,31 @@
*
* @section description Description
*
- * vte is a library implementing Gtk+ widget emulating terminal. The libvtemm
- * C++ binding provides a C++ interface on top of the vte C library.
- *
- * @section overview Overview
- *
- * The libvtemm API provides a subset of vte functionality. It wraps only
- * @c VteTerminal, leaving @c VteReaper, which is deprecated, and
- * @c VteTerminalAccessible, which author does not see any purpose for
- * programmists using this widget.
- *
- * @section use Use
- *
- * To use libvtemm in your C++ application, include the central header file
- * <tt>\<libvtemm.h\></tt> or, for terminal widget only,
- * <tt>\<libvtemm/terminal.h\></tt>. The libvtemm package ships a @c pkg-config
- * file with the correct include path and link command-line for the compiler.
- *
- * The source code of the @ref simple/main.cc "Simple Terminal" and
- * @ref gettexter/main.cc "GetTexter" example programs demonstrate the
- * basic usage of the libvtemm API.
- *
- * @section contact Contact
- *
- * The best way to ask questions about libvtemm is to use one of below:
- *
- * @subsection mailinglist Mailing list
- *
- * Send a mail to gtkmm-list gnome org
- *
- * @subsection irc IRC
- *
- * Join c++ channel on irc.gnome.org and ask away.
- *
- * @section sourcecode Source code
- *
- * Library is developed and placed on GNOME git repository and release tarballs
- * are put on GNOME FTP site.
- *
- * @subsection browse Browsing the source code
- *
- * See <tt>http://git.gnome.org/browse/libvtemm/</tt>.
- *
- * @subsection bleedingedge Getting bleeding edge source code
- *
- * <tt>git clone git://git.gnome.org/libvtemm libvtemm</tt>
- *
- * @subsection tarballs Getting release tarballs
- *
- * See <tt>http://download.gnome.org/sources/libvtemm/</tt>.
- *
- * @section license License
- *
- * libvtemm is licensed under GNU Lesser Public License version 3 or (at your
- * option) any later.
- *
- * @section authors Author
- *
- * This library was written and is maintained by Krzesimir Nowak.
+ * libvtemm is a C++ interface VTE library implementing a terminal widget using
+ * GTK+.
+ *
+ * @section basics Basic usage
+ *
+ * Include the libvtemm header:
+ * @code
+ * #include <libvtemm.h>
+ * @endcode
+ * This includes every header installed by libvtemmmm, so can slow down
+ * compilation, but suffices for this simple example. Assuming that your
+ * program source file is @c program.cc, compile it with:
+ * @code
+ * g++ program.cc -o program `pkg-config --cflags --libs libvtemm-1.2`
+ * @endcode
+ * Alternatively, if using autoconf, use the following in @c configure.ac:
+ * @code
+ * PKG_CHECK_MODULES([LIBVTEMM], [libvtemm-1.2])
+ * @endcode
+ * Then use the generated @c LIBVTEMM_CFLAGS and @c LIBVTEMM_LIBS variables in
+ * the project @c Makefile.am files. For example:
+ * @code
+ * program_CPPFLAGS = $(LIBVTEMM_CFLAGS)
+ * program_LDADD = $(LIBVTEMM_LIBS)
+ * @endcode
*/
#include <gtkmm.h>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]