summaryrefslogtreecommitdiff
path: root/AudioManagerDaemon/docx
diff options
context:
space:
mode:
authorchristian linke <christian.linke@bmw.de>2012-12-17 16:15:11 +0100
committerchristian linke <christian.linke@bmw.de>2012-12-17 16:15:11 +0100
commit54c5e965fe8f9a53a78834028fd65c792493da2b (patch)
tree560d7b1209e6a8d4798de9568e4b4a947c2ab42a /AudioManagerDaemon/docx
parent215e8a72dc81e8a86dd5b3a8ca40fd2c7c6a0b9c (diff)
downloadaudiomanager-54c5e965fe8f9a53a78834028fd65c792493da2b.tar.gz
* added new interfaces & nsm support + nsm tests + fixed some unit tests + fixed rundown
Signed-off-by: christian linke <christian.linke@bmw.de>
Diffstat (limited to 'AudioManagerDaemon/docx')
-rw-r--r--AudioManagerDaemon/docx/01_mainpage.dox1
-rw-r--r--AudioManagerDaemon/docx/02_license.dox2
-rw-r--r--AudioManagerDaemon/docx/02_x_dependecies.dox2
-rw-r--r--AudioManagerDaemon/docx/02_y_versioning.dox2
-rw-r--r--AudioManagerDaemon/docx/03_architecture_overview.dox2
-rw-r--r--AudioManagerDaemon/docx/03_x_uml_model.dox2
-rw-r--r--AudioManagerDaemon/docx/04_components.dox2
-rw-r--r--AudioManagerDaemon/docx/04_x_elements.dox2
-rw-r--r--AudioManagerDaemon/docx/04_y_audiomanager_and_sources.dox2
-rw-r--r--AudioManagerDaemon/docx/05_unique.dox2
-rw-r--r--AudioManagerDaemon/docx/06_classification.dox2
-rw-r--r--AudioManagerDaemon/docx/07_interrupts.dox2
-rw-r--r--AudioManagerDaemon/docx/08_connections.dox2
-rw-r--r--AudioManagerDaemon/docx/09_lipsync.dox2
-rw-r--r--AudioManagerDaemon/docx/10_early_audio.dox2
-rw-r--r--AudioManagerDaemon/docx/11_views.dox2
-rw-r--r--AudioManagerDaemon/docx/12_volumes.dox2
-rw-r--r--AudioManagerDaemon/docx/13_properties.dox2
-rw-r--r--AudioManagerDaemon/docx/14_misc.dox2
-rw-r--r--AudioManagerDaemon/docx/14_x_mainloop.dox2
-rw-r--r--AudioManagerDaemon/docx/14_y_watchdog.dox2
-rw-r--r--AudioManagerDaemon/docx/14_z_nodeStateManagement.dox32
-rw-r--r--AudioManagerDaemon/docx/15_dlt_support.dox2
-rw-r--r--AudioManagerDaemon/docx/15_x_eclipse.dox2
-rw-r--r--AudioManagerDaemon/docx/16_readme.dox2
-rw-r--r--AudioManagerDaemon/docx/Doxyfile.in8
26 files changed, 60 insertions, 27 deletions
diff --git a/AudioManagerDaemon/docx/01_mainpage.dox b/AudioManagerDaemon/docx/01_mainpage.dox
index a890180..ad0848b 100644
--- a/AudioManagerDaemon/docx/01_mainpage.dox
+++ b/AudioManagerDaemon/docx/01_mainpage.dox
@@ -26,4 +26,5 @@ can be found at https://collab.genivi.org/wiki/display/genivi/GENIVI+Home \n
\par About AudioManager
The AudioManager is a Deamon that manages all Audio Connections in a GENIVI headunit.
It is a managing instance that uses so called RoutingAdaptors to control AudioDomains that then do the "real" connections.
+
*/ \ No newline at end of file
diff --git a/AudioManagerDaemon/docx/02_license.dox b/AudioManagerDaemon/docx/02_license.dox
index 1a31d63..45f68f3 100644
--- a/AudioManagerDaemon/docx/02_license.dox
+++ b/AudioManagerDaemon/docx/02_license.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
diff --git a/AudioManagerDaemon/docx/02_x_dependecies.dox b/AudioManagerDaemon/docx/02_x_dependecies.dox
index f334e37..ff5c346 100644
--- a/AudioManagerDaemon/docx/02_x_dependecies.dox
+++ b/AudioManagerDaemon/docx/02_x_dependecies.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
diff --git a/AudioManagerDaemon/docx/02_y_versioning.dox b/AudioManagerDaemon/docx/02_y_versioning.dox
index f6c0990..b166beb 100644
--- a/AudioManagerDaemon/docx/02_y_versioning.dox
+++ b/AudioManagerDaemon/docx/02_y_versioning.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
diff --git a/AudioManagerDaemon/docx/03_architecture_overview.dox b/AudioManagerDaemon/docx/03_architecture_overview.dox
index ec399f2..230a99a 100644
--- a/AudioManagerDaemon/docx/03_architecture_overview.dox
+++ b/AudioManagerDaemon/docx/03_architecture_overview.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
diff --git a/AudioManagerDaemon/docx/03_x_uml_model.dox b/AudioManagerDaemon/docx/03_x_uml_model.dox
index 93077ca..802d181 100644
--- a/AudioManagerDaemon/docx/03_x_uml_model.dox
+++ b/AudioManagerDaemon/docx/03_x_uml_model.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
diff --git a/AudioManagerDaemon/docx/04_components.dox b/AudioManagerDaemon/docx/04_components.dox
index 09acd1a..c4084b8 100644
--- a/AudioManagerDaemon/docx/04_components.dox
+++ b/AudioManagerDaemon/docx/04_components.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
diff --git a/AudioManagerDaemon/docx/04_x_elements.dox b/AudioManagerDaemon/docx/04_x_elements.dox
index 4afdd35..7990d37 100644
--- a/AudioManagerDaemon/docx/04_x_elements.dox
+++ b/AudioManagerDaemon/docx/04_x_elements.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
diff --git a/AudioManagerDaemon/docx/04_y_audiomanager_and_sources.dox b/AudioManagerDaemon/docx/04_y_audiomanager_and_sources.dox
index a333141..113cf6b 100644
--- a/AudioManagerDaemon/docx/04_y_audiomanager_and_sources.dox
+++ b/AudioManagerDaemon/docx/04_y_audiomanager_and_sources.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
diff --git a/AudioManagerDaemon/docx/05_unique.dox b/AudioManagerDaemon/docx/05_unique.dox
index a575ef8..5bf021a 100644
--- a/AudioManagerDaemon/docx/05_unique.dox
+++ b/AudioManagerDaemon/docx/05_unique.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
/*!
diff --git a/AudioManagerDaemon/docx/06_classification.dox b/AudioManagerDaemon/docx/06_classification.dox
index 0b77bde..ccedffc 100644
--- a/AudioManagerDaemon/docx/06_classification.dox
+++ b/AudioManagerDaemon/docx/06_classification.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
/*!
diff --git a/AudioManagerDaemon/docx/07_interrupts.dox b/AudioManagerDaemon/docx/07_interrupts.dox
index 51de73b..0e26b88 100644
--- a/AudioManagerDaemon/docx/07_interrupts.dox
+++ b/AudioManagerDaemon/docx/07_interrupts.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
/*!
diff --git a/AudioManagerDaemon/docx/08_connections.dox b/AudioManagerDaemon/docx/08_connections.dox
index f57f9a3..fd8a194 100644
--- a/AudioManagerDaemon/docx/08_connections.dox
+++ b/AudioManagerDaemon/docx/08_connections.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
/*!
diff --git a/AudioManagerDaemon/docx/09_lipsync.dox b/AudioManagerDaemon/docx/09_lipsync.dox
index 6d75343..6229198 100644
--- a/AudioManagerDaemon/docx/09_lipsync.dox
+++ b/AudioManagerDaemon/docx/09_lipsync.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
/*!
diff --git a/AudioManagerDaemon/docx/10_early_audio.dox b/AudioManagerDaemon/docx/10_early_audio.dox
index 1811049..bdd72f5 100644
--- a/AudioManagerDaemon/docx/10_early_audio.dox
+++ b/AudioManagerDaemon/docx/10_early_audio.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
/*!
diff --git a/AudioManagerDaemon/docx/11_views.dox b/AudioManagerDaemon/docx/11_views.dox
index b9efc92..2dda7c9 100644
--- a/AudioManagerDaemon/docx/11_views.dox
+++ b/AudioManagerDaemon/docx/11_views.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
/*!
diff --git a/AudioManagerDaemon/docx/12_volumes.dox b/AudioManagerDaemon/docx/12_volumes.dox
index c58b7f8..60603bc 100644
--- a/AudioManagerDaemon/docx/12_volumes.dox
+++ b/AudioManagerDaemon/docx/12_volumes.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
diff --git a/AudioManagerDaemon/docx/13_properties.dox b/AudioManagerDaemon/docx/13_properties.dox
index 577c743..2597fdf 100644
--- a/AudioManagerDaemon/docx/13_properties.dox
+++ b/AudioManagerDaemon/docx/13_properties.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
/*!
diff --git a/AudioManagerDaemon/docx/14_misc.dox b/AudioManagerDaemon/docx/14_misc.dox
index 1623f95..eae0caf 100644
--- a/AudioManagerDaemon/docx/14_misc.dox
+++ b/AudioManagerDaemon/docx/14_misc.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
/*!
diff --git a/AudioManagerDaemon/docx/14_x_mainloop.dox b/AudioManagerDaemon/docx/14_x_mainloop.dox
index cf327bc..8f112bc 100644
--- a/AudioManagerDaemon/docx/14_x_mainloop.dox
+++ b/AudioManagerDaemon/docx/14_x_mainloop.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
diff --git a/AudioManagerDaemon/docx/14_y_watchdog.dox b/AudioManagerDaemon/docx/14_y_watchdog.dox
index 8e7fb49..a1facc5 100644
--- a/AudioManagerDaemon/docx/14_y_watchdog.dox
+++ b/AudioManagerDaemon/docx/14_y_watchdog.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
diff --git a/AudioManagerDaemon/docx/14_z_nodeStateManagement.dox b/AudioManagerDaemon/docx/14_z_nodeStateManagement.dox
new file mode 100644
index 0000000..2e9150e
--- /dev/null
+++ b/AudioManagerDaemon/docx/14_z_nodeStateManagement.dox
@@ -0,0 +1,32 @@
+ /*
+ * 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 nsm The Node state management
+\section The Node state managemer
+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
+
+\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,
+but only after the Controller registered by the NSM via am::CAmNodeStateCommunicator::nsmRegisterShutdownClient.\n
+The controller has to answer this request during the timeout with am::CAmNodeStateCommunicator::nsmSendLifecycleRequestComplete .
+For more information, check am::CAmNodeStateCommunicator and http://projects.genivi.org
+
+
+ */
diff --git a/AudioManagerDaemon/docx/15_dlt_support.dox b/AudioManagerDaemon/docx/15_dlt_support.dox
index 93be712..ca34896 100644
--- a/AudioManagerDaemon/docx/15_dlt_support.dox
+++ b/AudioManagerDaemon/docx/15_dlt_support.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
/*!
diff --git a/AudioManagerDaemon/docx/15_x_eclipse.dox b/AudioManagerDaemon/docx/15_x_eclipse.dox
index 1a06c64..95c8e9f 100644
--- a/AudioManagerDaemon/docx/15_x_eclipse.dox
+++ b/AudioManagerDaemon/docx/15_x_eclipse.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
diff --git a/AudioManagerDaemon/docx/16_readme.dox b/AudioManagerDaemon/docx/16_readme.dox
index 18a9002..9483a68 100644
--- a/AudioManagerDaemon/docx/16_readme.dox
+++ b/AudioManagerDaemon/docx/16_readme.dox
@@ -11,7 +11,7 @@
* 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 Mueller (christian.ei.mueller@bmw.de)
+ * \\author Christian Linke (christian.linke@bmw.de)
*
*/
/*!
diff --git a/AudioManagerDaemon/docx/Doxyfile.in b/AudioManagerDaemon/docx/Doxyfile.in
index 4c6f48a..a71d39d 100644
--- a/AudioManagerDaemon/docx/Doxyfile.in
+++ b/AudioManagerDaemon/docx/Doxyfile.in
@@ -78,9 +78,9 @@ LAYOUT_FILE =
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = YES
-WARNINGS = YES
-WARN_IF_UNDOCUMENTED = YES
-WARN_IF_DOC_ERROR = YES
+WARNINGS = NO
+WARN_IF_UNDOCUMENTED = NO
+WARN_IF_DOC_ERROR = NO
WARN_NO_PARAMDOC = NO
WARN_FORMAT = "$file:$line: $text "
WARN_LOGFILE =
@@ -93,7 +93,7 @@ FILE_PATTERNS = *.h *.cpp *.dox
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
-EXCLUDE_PATTERNS = */test/* */Plugin*/* */build*/*
+EXCLUDE_PATTERNS = */test/* */Plugin*/* */build*/* */cmake/* */exampleCode/* */googleMock/* */ProjectSpecific/*
EXCLUDE_SYMBOLS =
EXAMPLE_PATH = @CMAKE_SOURCE_DIR@
EXAMPLE_PATTERNS =