[libvtemm] Add a mainpage and tweak docs.

[Krzesimir Nowak <krnowak src gnome org>]

commit c8abd1016a3faff519e7001c0636b0b17b166c54
Author: Krzesimir Nowak <qdlacz gmail com>
Date:   Wed Jan 13 22:37:14 2010 +0100

    Add a mainpage and tweak docs.
    
    * libvte/libvtemm.h: Add a main page describing a project, examples
    and stuff.
    * docs/Makefile.am: Added main include header to include files for
    Doxygen, so a nice main page will be generated.
    * libvte/src/terminal.hg: Added documentation for enums.

 docs/Makefile.am       |    4 +-
 libvte/libvtemm.h      |   82 +++++++++++++++++++++++++++++++++++++++++++++++-
 libvte/src/terminal.hg |   58 +++++++++++++++++++++++++++++++++-
 3 files changed, 140 insertions(+), 4 deletions(-)
---
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 4d8a853..939f5b8 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,4 +1,4 @@
-## Copyright (c) 2009 libvtemm development team.
+## Copyright (c) 2009, 2010 libvtemm development team.
 
 include $(top_srcdir)/libvte/src/filelist.am
 include $(top_srcdir)/libvte/libvtemm/filelist.am
@@ -6,6 +6,6 @@ include $(top_srcdir)/libvte/libvtemm/filelist.am
 libvtemm_files_h = $(files_built_h) $(filter-out wrap_init.h,$(files_extra_h))
 
 book_name = $(LIBVTEMM_MODULE_NAME)
-doc_input = $(addprefix $(top_srcdir)/libvte/libvtemm/,$(libvtemm_files_h))
+doc_input = $(addprefix $(top_srcdir)/libvte/libvtemm/,$(libvtemm_files_h)) $(top_srcdir)/libvte/libvtemm.h
 
 include $(top_srcdir)/build/doc-reference.am
diff --git a/libvte/libvtemm.h b/libvte/libvtemm.h
index d117fb5..905ede1 100644
--- a/libvte/libvtemm.h
+++ b/libvte/libvtemm.h
@@ -1,6 +1,6 @@
 /* libvtemm.h
  *
- * Copyright (C) 2008, 2009 libvtemm Development Team
+ * Copyright (C) 2008, 2009, 2010 libvtemm Development Team
  *
  * This file is part of libvtemm.
  *
@@ -21,6 +21,70 @@
 #ifndef _LIBVTEMM_H_
 #define _LIBVTEMM_H_
 
+/** @mainpage libvtemm Reference Manual
+ *
+ * @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.
+ */
+
 #include <gtkmm.h>
 
 #include <libvtemm/charattributes.h>
@@ -35,4 +99,20 @@
 #include <libvtemm/textandcharattrs.h>
 #include <libvtemm/wrap_init.h>
 
+/** @example simple/main.cc
+ * The simple terminal launching shell.
+ *
+ * @include simple.h
+ * @include simple.cc
+ */
+
+/** @example gettexter/main.cc
+ * A silly application getting text.
+ *
+ * @include gtterminal.h
+ * @include gtterminal.cc
+ * @include gettexter.h
+ * @include gettexter.cc
+ */
+
 #endif // _LIBVTEMM_H_
diff --git a/libvte/src/terminal.hg b/libvte/src/terminal.hg
index 9c2e0de..c4ec14e 100644
--- a/libvte/src/terminal.hg
+++ b/libvte/src/terminal.hg
@@ -1,6 +1,6 @@
 /* terminal.h
  *
- * Copyright (C) 2008, 2009 libvtemm Development Team
+ * Copyright (C) 2008, 2009, 2010 libvtemm Development Team
  *
  * This file is part of libvtemm.
  *
@@ -47,9 +47,65 @@ namespace Gnome
 namespace Vte
 {
 
+/** TerminalEraseBinding - An enumerated type which can be used to indicate
+ *  which string the terminal should send to an application when the user
+ *  presses the Delete or Backspace keys.
+ */
 _WRAP_ENUM(TerminalEraseBinding, VteTerminalEraseBinding)
+/** @var TerminalEraseBinding ERASE_AUTO
+ * For backspace, attempt to determine the right value from the terminal's IO
+ * settings; for delete, use the control sequence.
+ */
+
+/** @var TerminalEraseBinding ERASE_ASCII_BACKSPACE
+ * Send an ASCII backspace character (0x08).
+ */
+
+/** @var TerminalEraseBinding ERASE_ASCII_DELETE
+ * Send an ASCII delete character (0x7F).
+ */
+
+/** @var TerminalEraseBinding ERASE_DELETE_SEQUENCE
+ * Send the "\ \@7" control sequence.
+ */
+
+/** @var TerminalEraseBinding ERASE_TTY
+ * Send terminal's "erase" setting.
+ */
+
+/** TerminalCursorBlinkMode - An enumerated type which can be used to indicate
+ * the cursor blink mode for the terminal.
+ */
 _WRAP_ENUM(TerminalCursorBlinkMode, VteTerminalCursorBlinkMode)
+/** @var TerminalCursorBlinkMode CURSOR_BLINK_SYSTEM
+ * Follow GTK+ settings for cursor blinking.
+ */
+
+/** @var TerminalCursorBlinkMode CURSOR_BLINK_ON
+ * Cursor blinks.
+ */
+
+/** @var TerminalCursorBlinkMode CURSOR_BLINK_OFF
+ * Cursor does not blink.
+ */
+
+/** TerminalCursorShape - An enumerated type which can be used to indicate what
+ * should the terminal draw at the cursor position.
+ */
 _WRAP_ENUM(TerminalCursorShape, VteTerminalCursorShape)
+/** @var TerminalCursorShape CURSOR_SHAPE_BLOCK
+ * Draw a block cursor - this is the default.
+ */
+
+/** @var TerminalCursorShape CURSOR_SHAPE_IBEAM
+ * Draw a vertical bar on the left side of character - this is similar to the
+ * default cursor for other GTK+ widgets.
+ */
+
+/** @var TerminalCursorShape CURSOR_SHAPE_UNDERLINE
+ * Draw a horizontal bar below the character.
+ */
+
 
 /** Terminal - a terminal emulator implemented as a gtkmm widget.
  */