point at franca docs for dbus

diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
index 1e04e84..3893326 100644 (file)
--- a/docs/CMakeLists.txt
+++ b/docs/CMakeLists.txt
@@ -1,4 +1,5 @@
 if(enable_docs)
   install (DIRECTORY amb DESTINATION ${DOC_INSTALL_DIR} COMPONENT Docs)
   install (DIRECTORY dbus DESTINATION ${DOC_INSTALL_DIR} COMPONENT Docs)
+  install (FILES ${CMAKE_CURRENT_SOURCE_DIR}/amb.idl DESTINATION ${DOC_INSTALL_DIR}/dbus COMPONENT Docs)
 endif(enable_docs)

diff --git a/docs/amb.idl b/docs/amb.idl
index 40e5b04..cea5498 100644 (file)
--- a/docs/amb.idl
+++ b/docs/amb.idl
@@ -1,36 +1,7 @@
-/*!
-* \mainpage Automotive Message Broker DBus API Documentation
-*
-* \section intro Instroduction
-* AMB organizes the API into two general interfaces.  First a Manager interface (see manager.txt)
-* which includes tools for using the other interfaces.  Second is a series of interfaces that
-* represent vehicle data.  The latter follows the schema of "org.automotive.DataType" and are
-* contained in verious DBus paths.  The DBus paths are generally organized by
-* /{source}/{zone}/DataType.  "source" refers to the AMB source that produces the data.  "zone"
-* refers to the zone in which the data type is located in the vehicle or "0" for no zone.
-*
-* The data types are documented in the various *.txt files in this document folder.  The manager
-* interface is documented in the manager.txt document.
-*
-* \section basic_usage Basic Recommended Usage
-*
-* It is recomended that the Manager interface be used to find the DBus Object that contains the
-* data type you need.  This is done through the FindObject() call.  It is expected that DBus
-* Object Paths may change and so it is not appropriate to hard code DBus Object Paths.  The
-* DBus paths in the various documents are examples of paths and are not gauranteed.
-*
-* \section example Usage Example
-* Here is a pseudo-code example of how the api is to be used:
-*
-* \code
-* var manager = dbus.interface("org.automotive.Manager", "/");
-*
-* var speedObjectPaths = manager.FindObject("VehicleSpeed");
-*
-* var speedObject = dbus.interface("org.automotive.VehicleSpeed", speedObjectPaths[0]);
-*
-* console.log("Vehicle Speed: " + speedObject.Speed);
-* \endcode
+/*! amb.idl
+* /brief This document describes the DBus interfaces and data types for the
+* Automotive Message Broker API.  The data types are intended to as-close-as-
+* possible be compatible with the W3C vehicle <a href="https://rawgit.com/w3c/automotive-bg/master/data_spec.html>data spec</a>.
 */
 
 /*!

diff --git a/docs/dbus.idl b/docs/dbus.idl
new file mode 100644 (file)
index 0000000..8b13bcb
--- /dev/null
+++ b/docs/dbus.idl
@@ -0,0 +1,34 @@
+/*!
+* \mainpage Automotive Message Broker DBus API Documentation
+*
+* \section intro Introduction
+* AMB organizes the API into two general interface categories.  First the Manager interface (see manager.txt)
+* which includes tools for using the other interfaces.  Second is a number of interfaces that
+* represent vehicle data.  The latter follows the schema of "org.automotive.DataType" and are
+* contained in verious DBus paths.  The DBus paths are generally organized by
+* /{source}/{zone}/DataType.  "source" refers to the AMB source that produces the data.  "zone"
+* refers to the zone in which the data type is located in the vehicle or "0" for no zone.
+*
+* The interfaces and data types are documented in <a href="amb_8idl_source.html">amb.idl</a>.  Franca IDL
+* tools can be used to generate DBus introspection xml which can be used to generate bindings
+* for your language of choice.
+*
+* \section basic_usage Basic Recommended Usage
+*
+* It is recomended that the Manager interface be used to find the DBus Object that contains the
+* data type you need.  This is done through the FindObject() call.  It is expected that DBus
+* Object Paths may change and so it is not appropriate to hard code DBus Object Paths.  
+*
+* \section example Usage Example
+* Here is a pseudo-code example of how the api is to be used:
+*
+* \code
+* var manager = dbus.interface("org.automotive.Manager", "/");
+*
+* var speedObjectPaths = manager.FindObject("VehicleSpeed");
+*
+* var speedObject = dbus.interface("org.automotive.VehicleSpeed", speedObjectPaths[0]);
+*
+* console.log("Vehicle Speed: " + speedObject.Speed);
+* \endcode
+*/