[librsvgmm] Customize the reference documentation main page

[Daniel Elstner <daniel src gnome org>]

commit 778adab657a08a6e0e4242dd827293936f572513
Author: Daniel Elstner <daniel kitta gmail com>
Date:   Sat Oct 17 19:53:31 2009 +0200

    Customize the reference documentation main page
    
    * doc/reference/mainpage.h: New pseudo source input file for Doxygen,
    consisting solely of documentation directives and text to customize
    the main page of the reference documentation.
    * doc/Makefile.am (doc_input), (dist_noinst_DATA): List mainpage.h.

 doc/Makefile.am          |    6 +++++-
 doc/reference/mainpage.h |   36 ++++++++++++++++++++++++++++++++++++
 2 files changed, 41 insertions(+), 1 deletions(-)
---
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 9e30a6d..f039cdb 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -18,7 +18,11 @@
 include $(top_srcdir)/librsvg/src/filelist.am
 include $(top_srcdir)/librsvg/librsvgmm/filelist.am
 
+librsvgmm_files_h = $(addprefix $(top_srcdir)/librsvg/librsvgmm/,$(files_built_h))
+
 book_name = $(LIBRSVGMM_MODULE_NAME)
-doc_input = $(addprefix $(top_srcdir)/librsvg/librsvgmm/,$(files_built_h))
+doc_input = $(srcdir)/reference/mainpage.h $(librsvgmm_files_h)
 
 include $(top_srcdir)/build/doc-reference.am
+
+dist_noinst_DATA += reference/mainpage.h
diff --git a/doc/reference/mainpage.h b/doc/reference/mainpage.h
new file mode 100644
index 0000000..85bf465
--- /dev/null
+++ b/doc/reference/mainpage.h
@@ -0,0 +1,36 @@
+/*!
+ mainpage librsvgmm Reference Manual
+
+ section description Description
+
+librsvg is a component used within software applications to enable support for
+SVG-format scalable graphics.  In contrast to raster formats, scalable vector
+graphics provide users and artists a way to create, view, and provide imagery
+that is not limited to the pixel or dot density that an output device is
+capable of.
+
+The librsvgmm C++ binding provides a C++ interface on top of the librsvg
+C library.
+
+ section overview Overview
+
+Due to its limited scope, the librsvgmm API is very small.  SVG images are
+represented by Rsvg::Handle objects, loaded either by filename or from an
+in-memory buffer.  The Rsvg::Handle class also provides methods to access
+image properties and for rendering through cairo.  A number of methods throw
+Rsvg::Error exceptions on failure to access or interpret an external resource
+at runtime.
+
+Before using any other part of the library, Rsvg::init() must be called once
+to initialize librsvgmm, typically from an application's @c %main() function.
+The Rsvg::term() function may be called after use in order to release some
+of the resources allocated during initialization, which is primarily useful
+as an aid to memory allocation profilers.
+
+ note
+The convenience methods for rendering to a @c GdkPixbuf, which are still
+available in the librsvg C API, are not included in the C++ binding.  These
+methods have been deliberately omitted in order to avoid an otherwise
+unnecessary dependency on gtkmm.  The basic functionality of loading an SVG
+into a @c GdkPixbuf is already available through the rsvg pixbuf loader module.
+*/