* added some documentation, removed sample project since it seems to addle users. Now the fidls are the matching final the EA version.

Signed-off-by: Christian Linke <christian.linke@bmw.de>

11 files changed, 48 insertions, 2 deletions

diff --git a/AudioManagerDaemon/docx/04_components.dox b/AudioManagerDaemon/docx/04_components.dox
index c4084b8..7c8f9b4 100644
--- a/AudioManagerDaemon/docx/04_components.dox
+++ b/AudioManagerDaemon/docx/04_components.dox
@@ -81,5 +81,19 @@
  am::IAmRoutingSend::returnBusName. The AudioManagerDaemon used this information to link a plugin with a domain. All other elements like
  sinks, sources etc are linked to domains. This is how the hierarchy looks like that is used:
  \image html routing_hierarchy.png
+ 
+ \subsection CAPIplugins CommonAPI plugins
+ As "sample code" with MIT license, PluginCommandInterfaceCAPI and PluginRoutingInterfaceCAPI are provided with the source code. The FRANCA 
+ fidls have been generated out of the Enterprise architect model, so they might be used to draw project specific behavior in sequences.
+ The sources in src-gen have been generated out of the provided fidl files.
+ 
+ \image html PluginCommandInterfaceCAPI.png
+ 
+ \image html PluginRoutingInterfaceCAPI.png
+ 
+ There is no fixed domain associated with this plugin. So you have to implement the interface org::genivi::am::RoutingControlStub and report
+ busname and path to the routingplugin on the interface org::genivi::am::RoutingControlObserverStub like this:
+ 
+ \image html Register_Domain.png
 
 */
diff --git a/AudioManagerDaemon/docx/04_d_commonAPI.dox b/AudioManagerDaemon/docx/04_d_commonAPI.dox
new file mode 100644
index 0000000..7e837dd
--- /dev/null
+++ b/AudioManagerDaemon/docx/04_d_commonAPI.dox
@@ -0,0 +1,30 @@
+ /*
+ * Copyright (C) 2012, BMW AG
+ *
+ * This file is part of GENIVI Project AudioManager.
+ *
+ * Contributions are licensed to the GENIVI Alliance under one or more
+ * Contribution License Agreements.
+ *
+ * \copyright
+ * This Source Code Form is subject to the terms of the
+ * Mozilla Public License, v. 2.0. If a  copy of the MPL was not distributed with
+ * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * \\author Christian Linke (christian.linke@bmw.de)
+ *
+ */
+ 
+ /*!
+ \page comminAPI AudioManager and CommonAPI
+The audiomanager supports CommonAPI in very comfortable way. It will register CommonAPI in the audiomanager mainloop (am::CAmSocketHandler) and make
+threadsafe calls to the stubs registered via the factory provided by the wrapper.
+ If enabled (by default) via cmake, the am::CAmCommonAPIWrapper is created. It is instantiated as singleton
+and every Plugin can use it.
+First, you have to create the interfaces out of the FIDL data like usual. 
+Then, you can access the singletons via am::CAmCommonAPIWrapper::factory and am::CAmCommonAPIWrapper::runtime.
+
+More information about CommonAPI can be found here:
+http://projects.genivi.org/commonapi/
+
+*/
diff --git a/AudioManagerDaemon/docx/14_z_nodeStateManagement.dox b/AudioManagerDaemon/docx/14_z_nodeStateManagement.dox
index 216338a..e149310 100644
--- a/AudioManagerDaemon/docx/14_z_nodeStateManagement.dox
+++ b/AudioManagerDaemon/docx/14_z_nodeStateManagement.dox
@@ -21,6 +21,8 @@
 The nodestatemanager is part of the GENIVI compliance. It basically handles startup and rundown of components in the IVI context.\n
 For more information, please go to http://projects.genivi.org
 
+The Nodestatemanagement will either work with CommonAPI or DBus native.
+
 \section nsmiact The Interaction between the NodeStateManager and the AudioManager
 It is the job of am::CAmNodeStateCommunicator to interact with the nodestatemanager via DBUS.\n
 The ControllerPlugin can register by the NSM to be informed when a shutdown will occour. For this, the Audiomanager presents an DBus interface, defined in LifeCycleConsumer.xml that will be called from the NSM during a shutdown,
diff --git a/AudioManagerDaemon/docx/16_readme.dox b/AudioManagerDaemon/docx/16_readme.dox
index 9483a68..7798fee 100644
--- a/AudioManagerDaemon/docx/16_readme.dox
+++ b/AudioManagerDaemon/docx/16_readme.dox
@@ -16,5 +16,5 @@
  */
 /*!
 \page comp Compiling & Co
- <a href=../../README.html>README</a>
+ <a href=README.html>README</a>
 */
\ No newline at end of file
diff --git a/AudioManagerDaemon/docx/Doxyfile.in b/AudioManagerDaemon/docx/Doxyfile.in
index a71d39d..a17e7c6 100644
--- a/AudioManagerDaemon/docx/Doxyfile.in
+++ b/AudioManagerDaemon/docx/Doxyfile.in
@@ -93,7 +93,7 @@ FILE_PATTERNS          = *.h *.cpp *.dox
 RECURSIVE              = YES
 EXCLUDE                = 
 EXCLUDE_SYMLINKS       = NO
-EXCLUDE_PATTERNS       = */test/* */Plugin*/* */build*/* */cmake/* */exampleCode/* */googleMock/* */ProjectSpecific/*
+EXCLUDE_PATTERNS       = */test/* */Plugin*DBus*/* */PluginControl*/* */build*/* */cmake/* */exampleCode/* */googleMock/* */ProjectSpecific/*
 EXCLUDE_SYMBOLS        =
 EXAMPLE_PATH           = @CMAKE_SOURCE_DIR@
 EXAMPLE_PATTERNS       = 
diff --git a/AudioManagerDaemon/docx/images/PluginCommandInterfaceCAPI.png b/AudioManagerDaemon/docx/images/PluginCommandInterfaceCAPI.png
new file mode 100644
index 0000000..882be93
--- /dev/null
+++ b/AudioManagerDaemon/docx/images/PluginCommandInterfaceCAPI.png
diff --git a/AudioManagerDaemon/docx/images/PluginRoutingInterfaceCAPI.png b/AudioManagerDaemon/docx/images/PluginRoutingInterfaceCAPI.png
new file mode 100644
index 0000000..0ae79f5
--- /dev/null
+++ b/AudioManagerDaemon/docx/images/PluginRoutingInterfaceCAPI.png
diff --git a/AudioManagerDaemon/docx/images/Register_Domain.png b/AudioManagerDaemon/docx/images/Register_Domain.png
new file mode 100644
index 0000000..09a1251
--- /dev/null
+++ b/AudioManagerDaemon/docx/images/Register_Domain.png
diff --git a/AudioManagerDaemon/docx/images/daemon_insight.png b/AudioManagerDaemon/docx/images/daemon_insight.png
index 78c0928..341e3ab 100755
--- a/AudioManagerDaemon/docx/images/daemon_insight.png
+++ b/AudioManagerDaemon/docx/images/daemon_insight.png
diff --git a/AudioManagerDaemon/docx/images/dependencies.png b/AudioManagerDaemon/docx/images/dependencies.png
index f5c925d..30d272f 100755..100644
--- a/AudioManagerDaemon/docx/images/dependencies.png
+++ b/AudioManagerDaemon/docx/images/dependencies.png
diff --git a/AudioManagerDaemon/docx/images/dependencies_test.png b/AudioManagerDaemon/docx/images/dependencies_test.png
index 05a30ad..870bc26 100644
--- a/AudioManagerDaemon/docx/images/dependencies_test.png
+++ b/AudioManagerDaemon/docx/images/dependencies_test.png