Add some Documentation to Plugins (#375)

15 files changed, 134 insertions, 32 deletions

diff --git a/navit/Doxyfile b/navit/Doxyfile
index 0960da8b9..6b3bc777a 100644
--- a/navit/Doxyfile
+++ b/navit/Doxyfile
@@ -809,7 +809,7 @@ EXCLUDE_SYMLINKS       = NO
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories for example use the pattern */test/*
 
-EXCLUDE_PATTERNS       =
+EXCLUDE_PATTERNS       = */support/*
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the
@@ -1504,7 +1504,7 @@ MATHJAX_CODEFILE       =
 # The default value is: YES.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-SEARCHENGINE           = NO
+SEARCHENGINE           = YES
 
 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
 # implemented using a web server instead of a web client using Javascript. There
diff --git a/navit/plugin.c b/navit/plugin.c
index 8c61bc9b7..aae09c470 100644
--- a/navit/plugin.c
+++ b/navit/plugin.c
@@ -1,4 +1,4 @@
-/**
+/*
  * Navit, a modular navigation system.
  * Copyright (C) 2005-2008 Navit Team
  *
@@ -38,6 +38,13 @@
 #include "item.h"
 #include "debug.h"
 
+/**
+ * @defgroup plugins
+ * @brief A interface to handle all plugins inside navit
+ *
+ * @{
+ */
+
 #ifdef USE_PLUGINS
 #ifndef HAVE_GMODULE
 typedef void * GModule;
diff --git a/navit/vehicle.c b/navit/vehicle.c
index 33cecb0e9..26dc457cb 100644
--- a/navit/vehicle.c
+++ b/navit/vehicle.c
@@ -18,6 +18,8 @@
  */
  
 /** @file vehicle.c
+ * @defgroup vehicle-plugins vehicle plugins
+ * @ingroup plugins
  * @brief Generic components of the vehicle object.
  * 
  * This file implements the generic vehicle interface, i.e. everything which is
@@ -52,6 +54,7 @@
 #include "vehicle.h"
 #include "navit_nls.h"
 
+
 struct vehicle {
 	NAVIT_OBJECT
 	struct vehicle_methods meth;
diff --git a/navit/vehicle/android/vehicle_android.c b/navit/vehicle/android/vehicle_android.c
index 89882d048..4165b9b31 100644
--- a/navit/vehicle/android/vehicle_android.c
+++ b/navit/vehicle/android/vehicle_android.c
@@ -1,6 +1,4 @@
-/** @file vehicle_android.c
- * @brief android uses dbus signals
- *
+/*
  * Navit, a modular navigation system.
  * Copyright (C) 2005-2008 Navit Team
  *
@@ -18,8 +16,6 @@
  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA  02110-1301, USA.
  *
- * @Author Tim Niemeyer <reddog@mastersword.de>
- * @date 2008-2009
  */
 
 #include <config.h>
@@ -35,6 +31,15 @@
 #include "android.h"
 #include "vehicle.h"
 
+/**
+ * @defgroup vehicle-android Vehicle Android
+ * @ingroup vehicle-plugins
+ * @brief The Vehicle to gain position data from android. Android uses dbus signals
+ * @author Tim Niemeyer <reddog@mastersword.de>
+ * @date 2008-2009
+ *
+ */
+
 struct vehicle_priv {
 	struct callback_list *cbl;
 	struct coord_geo geo;      /**< The last known position of the vehicle **/
@@ -294,3 +299,5 @@ plugin_init(void)
 	dbg(lvl_debug, "enter\n");
 	plugin_register_category_vehicle("android", vehicle_android_new_android);
 }
+
+/** @} */
diff --git a/navit/vehicle/demo/vehicle_demo.c b/navit/vehicle/demo/vehicle_demo.c
index 4a47c1476..1e2991300 100644
--- a/navit/vehicle/demo/vehicle_demo.c
+++ b/navit/vehicle/demo/vehicle_demo.c
@@ -1,4 +1,4 @@
-/**
+/*
  * Navit, a modular navigation system.
  * Copyright (C) 2005-2008 Navit Team
  *
@@ -34,6 +34,13 @@
 #include "event.h"
 #include "util.h"
 
+/**
+ * @defgroup vehicle-demo Vehicle Demo
+ * @ingroup vehicle-plugins
+ * @brief The Vehicle for a demo. It followes the route automatically
+ *
+ */
+
 struct vehicle_priv {
 	int interval;
 	int position_set;
@@ -302,3 +309,6 @@ plugin_init(void)
 	dbg(lvl_debug, "enter\n");
 	plugin_register_category_vehicle("demo", vehicle_demo_new);
 }
+
+
+/** @} */
diff --git a/navit/vehicle/file/vehicle_file.c b/navit/vehicle/file/vehicle_file.c
index affa05d24..81b99f829 100644
--- a/navit/vehicle/file/vehicle_file.c
+++ b/navit/vehicle/file/vehicle_file.c
@@ -1,4 +1,4 @@
-/**
+/*
  * Navit, a modular navigation system.
  * Copyright (C) 2005-2008 Navit Team
  *
@@ -59,6 +59,14 @@ int inet_aton(const char *cp, struct in_addr *inp)
 }
 #endif
 
+/**
+ * @defgroup vehicle-file Vehicle File
+ * @ingroup vehicle-plugins
+ * @brief The Vehicle to gain position data from a file, pipe, serial interface or a socket
+ *
+ * @{
+ */
+
 static void vehicle_file_disable_watch(struct vehicle_priv *priv);
 static void vehicle_file_enable_watch(struct vehicle_priv *priv);
 static int vehicle_file_parse(struct vehicle_priv *priv, char *buffer);
diff --git a/navit/vehicle/gpsd/vehicle_gpsd.c b/navit/vehicle/gpsd/vehicle_gpsd.c
index 27025c0a6..975d9c68a 100644
--- a/navit/vehicle/gpsd/vehicle_gpsd.c
+++ b/navit/vehicle/gpsd/vehicle_gpsd.c
@@ -1,4 +1,4 @@
-/**
+/*
  * Navit, a modular navigation system.
  * Copyright (C) 2005-2008 Navit Team
  *
@@ -35,6 +35,14 @@
 #include "event.h"
 #include "types.h"
 
+/**
+ * @defgroup vehicle-gpsd Vehicle Gpsd
+ * @ingroup vehicle-plugins
+ * @brief The Vehicle to gain position data from the gpsd service
+ *
+ * @{
+ */
+
 static struct vehicle_priv {
 	char *source;
 	char *gpsd_query;
diff --git a/navit/vehicle/gpsd_dbus/vehicle_gpsd_dbus.c b/navit/vehicle/gpsd_dbus/vehicle_gpsd_dbus.c
index fa5eb8780..ebdf08707 100644
--- a/navit/vehicle/gpsd_dbus/vehicle_gpsd_dbus.c
+++ b/navit/vehicle/gpsd_dbus/vehicle_gpsd_dbus.c
@@ -1,4 +1,4 @@
-/**
+/*
  * Navit, a modular navigation system.
  * Copyright (C) 2005-2008 Navit Team
  *
@@ -34,6 +34,14 @@
 #include "vehicle.h"
 #include "event.h"
 
+/**
+ * @defgroup vehicle-gpsd-dbus Vehicle Gpsd DBus
+ * @ingroup vehicle-plugins
+ * @brief The Vehicle to gain position data from Gpsd over DBus
+ *
+ * @{
+ */
+
 static char *vehicle_gpsd_dbus_prefix="gpsd_dbus:";
 
 struct vehicle_priv {
diff --git a/navit/vehicle/gypsy/vehicle_gypsy.c b/navit/vehicle/gypsy/vehicle_gypsy.c
index 589e53a3f..16175f2e8 100644
--- a/navit/vehicle/gypsy/vehicle_gypsy.c
+++ b/navit/vehicle/gypsy/vehicle_gypsy.c
@@ -1,6 +1,4 @@
-/** @file vehicle_gypsy.c
- * @brief gypsy uses dbus signals
- *
+/*
  * Navit, a modular navigation system.
  * Copyright (C) 2005-2008 Navit Team
  *
@@ -18,8 +16,6 @@
  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA  02110-1301, USA.
  *
- * @Author Tim Niemeyer <reddog@mastersword.de>
- * @date 2008-2009
  */
 
 #include <config.h>
@@ -47,6 +43,16 @@
 #include "item.h"
 #include "vehicle.h"
 
+/**
+ * @defgroup vehicle-gypsy Vehicle gypsy
+ * @ingroup vehicle-plugins
+ * @brief The Vehicle to gain position data from gypsy. gypsy uses dbus signals
+ * @Author Tim Niemeyer <reddog@mastersword.de>
+ * @date 2008-2009
+ *
+ * @{
+ */
+
 static struct vehicle_priv {
 	char *source;
 	GypsyControl *control;
diff --git a/navit/vehicle/iphone/vehicle_iphone.c b/navit/vehicle/iphone/vehicle_iphone.c
index 94fec114a..f8ce5b644 100644
--- a/navit/vehicle/iphone/vehicle_iphone.c
+++ b/navit/vehicle/iphone/vehicle_iphone.c
@@ -1,4 +1,4 @@
-/**
+/*
  * Navit, a modular navigation system.
  * Copyright (C) 2005-2008 Navit Team
  *
@@ -33,6 +33,14 @@
 #include "event.h"
 #include "corelocation.h"
 
+/**
+ * @defgroup vehicle-iphone Vehicle iPhone
+ * @ingroup vehicle-plugins
+ * @brief The Vehicle to gain position data from iPhone.
+ *
+ * @{
+ */
+
 struct vehicle_priv {
 	int interval;
 	int position_set;
diff --git a/navit/vehicle/maemo/vehicle_maemo.c b/navit/vehicle/maemo/vehicle_maemo.c
index d686a6a03..015f1c8e3 100644
--- a/navit/vehicle/maemo/vehicle_maemo.c
+++ b/navit/vehicle/maemo/vehicle_maemo.c
@@ -1,4 +1,4 @@
-/**
+/*
  * Navit, a modular navigation system.
  * Copyright (C) 2005-2008 Navit Team
  *
@@ -18,14 +18,6 @@
  */
 
 
-/* 
-	Plugin for new Maemo's  liblocation API.
- 
-	<vehicle source="maemo://any" retry_interval="1"/>
-   source cound be on of "any","cwp","acwp","gnss","agnss"
-   retry_interval could be one of "1","2","5","10","20","30","60","120" measured in seconds
-*/
-
 #include <config.h>
 #include <string.h>
 #include <glib.h>
@@ -40,6 +32,19 @@
 #include "vehicle.h"
 #include "event.h"
 
+/**
+ * @defgroup vehicle-iphone Vehicle Maemo
+ * @ingroup vehicle-plugins
+ * @brief The Vehicle to gain position data from Maemo.
+ *
+ * Plugin for new Maemo's  liblocation API.
+ * <vehicle source="maemo://any" retry_interval="1"/>
+ *  source cound be on of "any","cwp","acwp","gnss","agnss"
+ *  retry_interval could be one of "1","2","5","10","20","30","60","120" measured in seconds
+ *
+ * @{
+ */
+
 static struct vehicle_priv {
 	LocationGPSDControl *control;
 	LocationGPSDevice *device;
diff --git a/navit/vehicle/null/vehicle_null.c b/navit/vehicle/null/vehicle_null.c
index 643945c71..6b723f9ff 100644
--- a/navit/vehicle/null/vehicle_null.c
+++ b/navit/vehicle/null/vehicle_null.c
@@ -1,4 +1,4 @@
-/** @file vehicle_null.c
+/*
  * @brief null uses dbus signals
  *
  * Navit, a modular navigation system.
@@ -34,6 +34,14 @@
 #include "item.h"
 #include "vehicle.h"
 
+/**
+ * @defgroup vehicle-null Vehicle Null
+ * @ingroup vehicle-plugins
+ * @brief A dummy Vehicle to have a null movement.
+ *
+ * @{
+ */
+
 struct vehicle_priv {
 	struct callback_list *cbl;
 	struct coord_geo geo;
diff --git a/navit/vehicle/qt5/vehicle_qt5.cpp b/navit/vehicle/qt5/vehicle_qt5.cpp
index 2a2b6f5cf..fc8a6635a 100644
--- a/navit/vehicle/qt5/vehicle_qt5.cpp
+++ b/navit/vehicle/qt5/vehicle_qt5.cpp
@@ -1,5 +1,4 @@
-/** @file vehicle_null.c
- * @brief null uses dbus signals
+/*
  *
  * Navit, a modular navigation system.
  * Copyright (C) 2005-2017 Navit Team
@@ -41,6 +40,15 @@ extern "C" {
 #include "vehicle_qt5.h"
 #include "vehicle_qt5.moc"
 #include <QDateTime>
+
+/**
+ * @defgroup vehicle-qt5 Vehicle QT5
+ * @ingroup vehicle-plugins
+ * @brief The Vehicle to gain position data from qt5
+ *
+ * @{
+ */
+
 QNavitGeoReceiver::QNavitGeoReceiver(QObject* parent, struct vehicle_priv* c)
     : QObject(parent)
 {
diff --git a/navit/vehicle/webos/vehicle_webos.c b/navit/vehicle/webos/vehicle_webos.c
index a5bba4bce..c4bdcbaf2 100644
--- a/navit/vehicle/webos/vehicle_webos.c
+++ b/navit/vehicle/webos/vehicle_webos.c
@@ -1,4 +1,4 @@
-/**
+/*
  * vim: sw=3 ts=3
  *
  * Navit, a modular navigation system.
@@ -37,6 +37,14 @@
 #include "vehicle_webos.h"
 #include "bluetooth.h"
 
+/**
+ * @defgroup vehicle-webos Vehicle WebOS
+ * @ingroup vehicle-plugins
+ * @brief The Vehicle to gain position data from WebOS
+ *
+ * @{
+ */
+
 static char *vehicle_webos_prefix="webos:";
 
 /*******************************************************************/
diff --git a/navit/vehicle/wince/vehicle_wince.c b/navit/vehicle/wince/vehicle_wince.c
index aee3394b2..49f90b1f5 100644
--- a/navit/vehicle/wince/vehicle_wince.c
+++ b/navit/vehicle/wince/vehicle_wince.c
@@ -1,4 +1,4 @@
-/**
+/*
  * Navit, a modular navigation system.
  * Copyright (C) 2005-2008 Navit Team
  *
@@ -44,6 +44,14 @@
 #include <wchar.h>
 #include "support/win32/ConvertUTF.h"
 
+/**
+ * @defgroup vehicle-wince Vehicle WinCE
+ * @ingroup vehicle-plugins
+ * @brief The Vehicle to gain position data from WinCE
+ *
+ * @{
+ */
+
 #define SwitchToThread() Sleep(0)
 
 typedef int (WINAPI *PFN_BthSetMode)(DWORD pBthMode);