[telepathy-qt4/master] examples.dox: Added examples page on documentation.

Andre Moreira Magalhaes (andrunko) andre.magalhaes at collabora.co.uk
Wed Apr 1 20:42:27 PDT 2009


---
 TelepathyQt4/Makefile.am  |    1 +
 TelepathyQt4/examples.dox |  199 +++++++++++++++++++++++++++++++++++++++++++++
 TelepathyQt4/main.dox     |    1 +
 doxygen.cfg.in            |    2 +-
 4 files changed, 202 insertions(+), 1 deletions(-)
 create mode 100644 TelepathyQt4/examples.dox

diff --git a/TelepathyQt4/Makefile.am b/TelepathyQt4/Makefile.am
index 16bbd32..fefa8ae 100644
--- a/TelepathyQt4/Makefile.am
+++ b/TelepathyQt4/Makefile.am
@@ -19,6 +19,7 @@ EXTRA_DIST = \
     dbus-introspectable.xml \
     dbus-peer.xml \
     dbus-properties.xml \
+    examples.dox \
     main.dox \
     media-session-handler.xml \
     media-stream-handler.xml \
diff --git a/TelepathyQt4/examples.dox b/TelepathyQt4/examples.dox
new file mode 100644
index 0000000..2008f6f
--- /dev/null
+++ b/TelepathyQt4/examples.dox
@@ -0,0 +1,199 @@
+/*
+ * This file is part of TelepathyQt4
+ *
+ * Copyright (C) 2008 Collabora Ltd. <http://www.collabora.co.uk/>
+ * Copyright (C) 2008 Nokia Corporation
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+/**
+ * \page examples Examples
+ *
+ * This is the list of examples in Telepathy-Qt4's examples directory.
+ * The examples demonstrate Telepathy-Qt4 features in small, self-contained
+ * programs. They are not all designed to be impressive when you run them,
+ * but their source code is carefully written to show good Telepathy-Qt4
+ * programming practices.
+ *
+ * \li \subpage accounts_example
+ * \li \subpage roster_example
+ * \li \subpage call_example
+ */
+
+/**
+ * \page accounts_example Accounts Example
+ *
+ * \li \subpage accounts_example_account_item_cpp
+ * \li \subpage accounts_example_account_item_h
+ * \li \subpage accounts_example_accounts_window_cpp
+ * \li \subpage accounts_example_accounts_window_h
+ * \li \subpage accounts_example_main
+ */
+
+/**
+ * \page accounts_example_account_item_cpp accounts/account-item.cpp
+ * \include examples/accounts/account-item.cpp
+ */
+
+/**
+ * \page accounts_example_account_item_h accounts/account-item.h
+ * \include examples/accounts/account-item.h
+ */
+
+/**
+ * \page accounts_example_accounts_window_cpp accounts/accounts-window.cpp
+ * \include examples/accounts/accounts-window.cpp
+ */
+
+/**
+ * \page accounts_example_accounts_window_h accounts/accounts-window.h
+ * \include examples/accounts/accounts-window.h
+ */
+
+/**
+ * \page accounts_example_main accounts/main.cpp
+ * \include examples/accounts/main.cpp
+ */
+
+/**
+ * \page roster_example Roster Example
+ *
+ * \li \subpage roster_example_main
+ * \li \subpage roster_example_roster_item_cpp
+ * \li \subpage roster_example_roster_item_h
+ * \li \subpage roster_example_roster_widget_cpp
+ * \li \subpage roster_example_roster_widget_h
+ * \li \subpage roster_example_roster_window_cpp
+ * \li \subpage roster_example_roster_window_h
+ */
+
+/**
+ * \page roster_example_main roster/main.cpp
+ * \include examples/roster/main.cpp
+ */
+
+/**
+ * \page roster_example_roster_item_cpp roster/roster-item.cpp
+ * \include examples/roster/roster-item.cpp
+ */
+
+/**
+ * \page roster_example_roster_item_h roster/roster-item.h
+ * \include examples/roster/roster-item.h
+ */
+
+/**
+ * \page roster_example_roster_widget_cpp roster/roster-widget.cpp
+ * \include examples/roster/roster-widget.cpp
+ */
+
+/**
+ * \page roster_example_roster_widget_h roster/roster-widget.h
+ * \include examples/roster/roster-widget.h
+ */
+
+/**
+ * \page roster_example_roster_window_cpp roster/roster-window.cpp
+ * \include examples/roster/roster-window.cpp
+ */
+
+/**
+ * \page roster_example_roster_window_h roster/roster-window.h
+ * \include examples/roster/roster-window.h
+ */
+
+/**
+ * \page call_example Call Example
+ *
+ * \li \subpage call_example_call_handler_cpp
+ * \li \subpage call_example_call_handler_h
+ * \li \subpage call_example_call_roster_widget_cpp
+ * \li \subpage call_example_call_roster_widget_h
+ * \li \subpage call_example_call_widget_cpp
+ * \li \subpage call_example_call_widget_h
+ * \li \subpage call_example_call_window_cpp
+ * \li \subpage call_example_call_window_h
+ * \li \subpage call_example_farsight_channel_cpp
+ * \li \subpage call_example_farsight_channel_h
+ * \li \subpage call_example_main
+ * \li \subpage call_example_video_widget_cpp
+ * \li \subpage call_example_video_widget_h
+ */
+
+/**
+ * \page call_example_call_handler_cpp call/call-handler.cpp
+ * \include examples/call/call-handler.cpp
+ */
+
+/**
+ * \page call_example_call_handler_h call/call-handler.h
+ * \include examples/call/call-handler.h
+ */
+
+/**
+ * \page call_example_call_roster_widget_cpp call/call-roster-widget.cpp
+ * \include examples/call/call-roster-widget.cpp
+ */
+
+/**
+ * \page call_example_call_roster_widget_h call/call-roster-widget.h
+ * \include examples/call/call-roster-widget.h
+ */
+
+/**
+ * \page call_example_call_widget_cpp call/call-widget.cpp
+ * \include examples/call/call-widget.cpp
+ */
+
+/**
+ * \page call_example_call_widget_h call/call-widget.h
+ * \include examples/call/call-widget.h
+ */
+
+/**
+ * \page call_example_call_window_cpp call/call-window.cpp
+ * \include examples/call/call-window.cpp
+ */
+
+/**
+ * \page call_example_call_window_h call/call-window.h
+ * \include examples/call/call-window.h
+ */
+
+/**
+ * \page call_example_farsight_channel_cpp call/farsight-channel.cpp
+ * \include examples/call/farsight-channel.cpp
+ */
+
+/**
+ * \page call_example_farsight_channel_h call/farsight-channel.h
+ * \include examples/call/farsight-channel.h
+ */
+
+/**
+ * \page call_example_main call/main.cpp
+ * \include examples/call/main.cpp
+ */
+
+/**
+ * \page call_example_video_widget_cpp call/video-widget.cpp
+ * \include examples/call/video-widget.cpp
+ */
+
+/**
+ * \page call_example_video_widget_h call/video-widget.h
+ * \include examples/call/video-widget.h
+ */
diff --git a/TelepathyQt4/main.dox b/TelepathyQt4/main.dox
index 29e1971..11a2622 100644
--- a/TelepathyQt4/main.dox
+++ b/TelepathyQt4/main.dox
@@ -25,6 +25,7 @@
  * \section getting_started Getting Started
  * \li \subpage introduction
  * \li \subpage installation
+ * \li \subpage examples
  *
  * \section developer_resources Developer Resources
  * \li \subpage bugreport
diff --git a/doxygen.cfg.in b/doxygen.cfg.in
index fd1fae0..950cc1d 100644
--- a/doxygen.cfg.in
+++ b/doxygen.cfg.in
@@ -584,7 +584,7 @@ EXCLUDE_SYMBOLS        =
 # directories that contain example code fragments that are included (see 
 # the \include command).
 
-EXAMPLE_PATH           = $(SRCDIR)
+EXAMPLE_PATH           = @abs_top_srcdir@/examples
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
-- 
1.5.6.5




More information about the telepathy-commits mailing list