aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJosé Roberto de Souza <zehortigoza@profusion.mobi>2012-11-16 13:07:53 +0000
committerLucas De Marchi <lucas.demarchi@profusion.mobi>2012-11-16 13:07:53 +0000
commitba1f6998833e5cc5e3fbb2f8d8d445e18db053e9 (patch)
treeb0166fbaccee8915747c28b89b1f6bc1a362facc
parentedbus: Rename edbus_object_bus_path_get() to edbus_object_path_get() (diff)
downloadefl-ba1f6998833e5cc5e3fbb2f8d8d445e18db053e9.tar.gz
edbus: Add main page to doxygen
Patch by: José Roberto de Souza <zehortigoza@profusion.mobi> SVN revision: 79388
-rw-r--r--legacy/edbus/doc/examples.dox33
-rw-r--r--legacy/edbus/doc/head.html13
-rw-r--r--legacy/edbus/src/lib/EDBus.h48
-rw-r--r--legacy/edbus/src/lib/edbus_message_eina_value.h3
-rw-r--r--legacy/edbus/src/lib/edbus_message_helper.h3
5 files changed, 68 insertions, 32 deletions
diff --git a/legacy/edbus/doc/examples.dox b/legacy/edbus/doc/examples.dox
index 14b4ba343a..9c70180d73 100644
--- a/legacy/edbus/doc/examples.dox
+++ b/legacy/edbus/doc/examples.dox
@@ -1,18 +1,4 @@
/**
- * @page Examples Examples
- *
- * Here is a page with some EDBus examples:
- *
- * @li @ref banshee
- * @li @ref simple_dbus_client
- * @li @ref simple_dbus_server
- * @li @ref complex_types
- * @li @ref complex_types_server
- * @li @ref connman
- * @li @ref ofono
- */
-
-/**
* @page banshee Banshee dbus client
*
* @include banshee.c
@@ -37,19 +23,26 @@
*/
/**
- * @page complex_types_server Handling with dbus complex types server side
- *
+ * @page complex_types_server Handling with dbus complex types in server side
* @include complex_types_server.c
*/
/**
- * @page connman Connman
- *
+ * @page connman Connman client
* @include connman-list-services.c
*/
/**
- * @page ofono Ofono
- *
+ * @page ofono Ofono client
* @include ofono-dial.c
*/
+
+/**
+ * @page eina_value Eina_Value to/from Message
+ * @include complex_types_client_eina_value.c
+ */
+
+/**
+ * @page signal_emmiter Simple signal emmiter
+ * @include simple-signal-emit.c
+ */
diff --git a/legacy/edbus/doc/head.html b/legacy/edbus/doc/head.html
index 2d841f12c9..5de3a93a87 100644
--- a/legacy/edbus/doc/head.html
+++ b/legacy/edbus/doc/head.html
@@ -44,18 +44,11 @@
</div>
<div class="menu-container">
- <!--<div class="submenu">
+ <div class="submenu">
<ul class="current">
- <li><a href="group__EUkit__Group.html">EUkit</a></li>
- <li><a href="group__EOfono__Group.html">EOfono</a></li>
- <li><a href="group__ENotify__Group.html">ENotify</a></li>
- <li><a href="group__EHal__Group.html">EHal</a></li>
- <li><a href="group__EConnman__Group.html">EConnman</a></li>
- <li><a href="group__EBluez__Group.html">EBluez</a></li>
- <li><a href="group__EDbus__Group.html">EDbus</a></li>
- <li class="current"><a href="index.html">Main Page</a></li>
+ <li class="current"><a href="index.html">Main Page</a></li>
</ul>
- </div>-->
+ </div>
</div>
diff --git a/legacy/edbus/src/lib/EDBus.h b/legacy/edbus/src/lib/EDBus.h
index 9d00674f6c..fac889008e 100644
--- a/legacy/edbus/src/lib/EDBus.h
+++ b/legacy/edbus/src/lib/EDBus.h
@@ -1,3 +1,51 @@
+/**
+ * @mainpage EDBus
+ *
+ * @section edbus_intro_sec Introduction
+ *
+ * EDBus is a wrapper around the
+ * <a href="http://www.freedesktop.org/wiki/Software/dbus">dbus</a>
+ * library, which is a message bus system. It also implements a set of
+ * specifications using dbus as interprocess communication.
+ *
+ * @section edbus_modules_sec Modules
+ *
+ * <ul>
+ * <li> @ref EDBus_Core
+ * <li> @ref EDBus_Conneciton
+ * <li> @ref EDBus_Object_Mapper
+ * <li> @ref EDBus_Proxy
+ * <li> @ref EDBus_Message
+ * <ul>
+ * <li>@ref EDBus_Message_Iter
+ * <li>@ref EDBus_Message_Helpers
+ * <li>@ref Eina_Value
+ * </ul>
+ * <li> @ref EDBus_Signal_Handler
+ * <li> @ref EDBus_Pending
+ * <li> @ref EDBus_Service
+ * <li> @ref EDBus_Basic
+ * </ul>
+ *
+ * @section edbus_examples_sec Examples
+ *
+ * Here some EDBus examples:
+ *
+ * @li @ref banshee
+ * @li @ref simple_dbus_client
+ * @li @ref simple_dbus_server
+ * @li @ref complex_types
+ * @li @ref complex_types_server
+ * @li @ref eina_value
+ * @li @ref signal_emmiter
+ * @li @ref connman
+ * @li @ref ofono
+ *
+ * @author Gustavo Sverzut Barbieri <barbieri@profusion.mobi>
+ * @author José Roberto de Souza <zehortigoza@profusion.mobi>
+ * @author Leandro Pereira <leandro@profusion.mobi>
+ * @author Lucas De Marchi <lucas.demarchi@profusion.mobi>
+ */
#ifndef EDBUS_H
#define EDBUS_H
diff --git a/legacy/edbus/src/lib/edbus_message_eina_value.h b/legacy/edbus/src/lib/edbus_message_eina_value.h
index 4c47f1a2ae..ba11028d45 100644
--- a/legacy/edbus/src/lib/edbus_message_eina_value.h
+++ b/legacy/edbus/src/lib/edbus_message_eina_value.h
@@ -1,5 +1,6 @@
/**
- * @defgroup Eina_Value
+ * @ingroup EDBus_Message
+ * @defgroup Eina_Value Eina_Value to/from Message
* @{
*/
diff --git a/legacy/edbus/src/lib/edbus_message_helper.h b/legacy/edbus/src/lib/edbus_message_helper.h
index 4bad095d01..932e70a694 100644
--- a/legacy/edbus/src/lib/edbus_message_helper.h
+++ b/legacy/edbus/src/lib/edbus_message_helper.h
@@ -1,5 +1,6 @@
/**
- * @defgroup EDBus_Message_Helpers Helpers
+ * @ingroup EDBus_Message
+ * @defgroup EDBus_Message_Helpers Message Helpers
*
* @{
*/