[atkmm] Documentation: Added main page.
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [atkmm] Documentation: Added main page.
- Date: Mon, 28 Jun 2010 08:47:49 +0000 (UTC)
commit f98b2a878d1265609bf9f6a81e050dbd6f3f3f80
Author: Murray Cumming <murrayc murrayc com>
Date: Mon Jun 28 10:47:42 2010 +0200
Documentation: Added main page.
* atk/atkmm.h: Added text based on pangomm.h from pangomm.
ChangeLog | 8 ++++++++
atk/atkmm.h | 33 ++++++++++++++++++++++++++++++++-
2 files changed, 40 insertions(+), 1 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index ca3bab1..3e0cb78 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2010-06-28 Murray Cumming <murrayc murrayc com>
+
+ Documentation: Added main page.
+
+ * atk/atkmm.h: Added text based on pangomm.h from pangomm.
+
+2.21.1
+
2010-06-23 Murray Cumming <murrayc murrayc com>
Reduce version to 2.21, because atkmm has not broken ABI (yet?)
diff --git a/atk/atkmm.h b/atk/atkmm.h
index db70166..d593ea9 100644
--- a/atk/atkmm.h
+++ b/atk/atkmm.h
@@ -22,6 +22,38 @@
#ifndef _ATKMM_H
#define _ATKMM_H
+
+/** @mainpage atkmm Reference Manual
+ *
+ * @section description Description
+ *
+ * atkmm is the official C++ interface for the <a href="http://library.gnome.org/devel/atk/stable/">ATK</a> accessibility toolkit library. It may be used, for instance, by user interfaces implemented with gtkmm.
+ *
+ * @section basics Basic usage
+ *
+ * Include the atkmm header:
+ * @code
+ * #include <atkmm.h>
+ * @endcode
+ * This includes every header installed by atkmm, 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 atkmm-1.6`
+ * @endcode
+ * Alternatively, if using autoconf, use the following in @c configure.ac:
+ * @code
+ * PKG_CHECK_MODULES([ATKMM], [atkmm-1.6])
+ * @endcode
+ * Then use the generated @c ATKMM_CFLAGS and @c ATKMM_LIBS variables in
+ * the project @c Makefile.am files. For example:
+ * @code
+ * program_CPPFLAGS = $(ATKMM_CFLAGS)
+ * program_LDADD = $(ATKMM_LIBS)
+ * @endcode
+ */
+
+
#include <atkmm/action.h>
#include <atkmm/component.h>
#include <atkmm/document.h>
@@ -39,4 +71,3 @@
#include <atkmm/value.h>
#endif /* _ATKMM_H */
-
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]