From 5bcd206b9270d9a79e212f91723ea1a08a4d4859 Mon Sep 17 00:00:00 2001 From: Christian Linke Date: Thu, 11 Feb 2016 07:28:47 +0100 Subject: * rework of the build structure, adopt to standard cmake package structure * check versions when loading the libs * introduction of the AudioManagerCore * give control plugin as file or directory * remove SQLITE * either find and use gmock or build and install it * fixed [Bug 411] * compile flag gnu11 is now used Signed-off-by: Christian Linke Signed-off-by: Christian Linke --- docx/01_mainpage.dox | 30 + docx/02_license.dox | 38 + docx/02_x_dependecies.dox | 26 + docx/02_y_versioning.dox | 31 + docx/03_architecture_overview.dox | 85 + docx/03_x_uml_model.dox | 49 + docx/04_components.dox | 99 + docx/04_d_commonAPI.dox | 30 + docx/04_x_elements.dox | 63 + docx/04_y_audiomanager_and_sources.dox | 92 + docx/05_unique.dox | 36 + docx/06_classification.dox | 32 + docx/07_interrupts.dox | 36 + docx/08_connections.dox | 33 + docx/09_lipsync.dox | 37 + docx/10_early_audio.dox | 31 + docx/11_views.dox | 33 + docx/12_volumes.dox | 29 + docx/13_properties.dox | 33 + docx/13_x_notifications.dox | 64 + docx/14_misc.dox | 39 + docx/14_u_last_user_mode.dox | 37 + docx/14_x_mainloop.dox | 49 + docx/14_y_watchdog.dox | 44 + docx/14_zz_Startup_Rundown.dox | 30 + docx/15_a_CommandLineParsing.dox | 45 + docx/15_dlt_support.dox | 23 + docx/15_x_eclipse.dox | 91 + docx/16_readme.dox | 20 + docx/Doxyfile.in | 2326 +++++++++++++++++++++ docx/images/AudioDomains.gif | Bin 0 -> 18948 bytes docx/images/AudioManagement.png | Bin 0 -> 34386 bytes docx/images/AvailabilityofSinks.png | Bin 0 -> 37630 bytes docx/images/AvailabilityofSources.png | Bin 0 -> 37577 bytes docx/images/CancelRundown.png | Bin 0 -> 61007 bytes docx/images/ChangeofAudioformatduringplaytime.png | Bin 0 -> 46422 bytes docx/images/ClassDiagramm.png | Bin 0 -> 220221 bytes docx/images/Deferred_Call_async.png | Bin 0 -> 27008 bytes docx/images/Deferred_Call_sync.png | Bin 0 -> 39301 bytes docx/images/Gateway.gif | Bin 0 -> 14829 bytes docx/images/GatewayMatrix.png | Bin 0 -> 12269 bytes docx/images/Interaction_with_sourcessinks.png | Bin 0 -> 19385 bytes docx/images/Interacton_Overview.png | Bin 0 -> 62617 bytes docx/images/InterruptStatusChange.png | Bin 0 -> 22021 bytes docx/images/LastUserModeHandlingExample.png | Bin 0 -> 49412 bytes docx/images/Levels.png | Bin 0 -> 52975 bytes docx/images/Lifecylerequest.png | Bin 0 -> 48509 bytes docx/images/Mainloop.png | Bin 0 -> 46228 bytes docx/images/NodeStateManagementRelations.png | Bin 0 -> 19326 bytes docx/images/Notifications.png | Bin 0 -> 23940 bytes docx/images/PluginCommandInterfaceCAPI.png | Bin 0 -> 114519 bytes docx/images/PluginRoutingInterfaceCAPI.png | Bin 0 -> 167624 bytes docx/images/Register_Domain.png | Bin 0 -> 17905 bytes docx/images/Registrations.png | Bin 0 -> 38991 bytes docx/images/Rundown.png | Bin 0 -> 75612 bytes docx/images/SettingConnectionFormats.png | Bin 0 -> 26690 bytes docx/images/SoundPropertyChangeofSink.png | Bin 0 -> 34583 bytes docx/images/SoundPropertyChangeofSource.png | Bin 0 -> 32592 bytes docx/images/SourceStates.png | Bin 0 -> 32217 bytes docx/images/Startup.png | Bin 0 -> 86887 bytes docx/images/StartupWithLastUserMode.png | Bin 0 -> 22247 bytes docx/images/VolumeChangesofSinks.png | Bin 0 -> 47122 bytes docx/images/VolumeChangesofSources.png | Bin 0 -> 41243 bytes docx/images/bus_topology.png | Bin 0 -> 21535 bytes docx/images/daemon_insight.png | Bin 0 -> 64057 bytes docx/images/delay.jpg | Bin 0 -> 17066 bytes docx/images/dependencies.png | Bin 0 -> 38376 bytes docx/images/dependencies_test.png | Bin 0 -> 59908 bytes docx/images/dependency_created.png | Bin 0 -> 119569 bytes docx/images/early.png | Bin 0 -> 18557 bytes docx/images/example_system.png | Bin 0 -> 10379 bytes docx/images/genivilogo.png | Bin 0 -> 9537 bytes docx/images/late.png | Bin 0 -> 15928 bytes docx/images/routing_hierarchy.png | Bin 0 -> 11645 bytes docx/images/unique.svg | 209 ++ docx/images/versioning.png | Bin 0 -> 23647 bytes docx/images/versioning_new.png | Bin 0 -> 18298 bytes docx/images/views.png | Bin 0 -> 65262 bytes 78 files changed, 3820 insertions(+) create mode 100644 docx/01_mainpage.dox create mode 100644 docx/02_license.dox create mode 100644 docx/02_x_dependecies.dox create mode 100644 docx/02_y_versioning.dox create mode 100644 docx/03_architecture_overview.dox create mode 100644 docx/03_x_uml_model.dox create mode 100644 docx/04_components.dox create mode 100644 docx/04_d_commonAPI.dox create mode 100644 docx/04_x_elements.dox create mode 100644 docx/04_y_audiomanager_and_sources.dox create mode 100644 docx/05_unique.dox create mode 100644 docx/06_classification.dox create mode 100644 docx/07_interrupts.dox create mode 100644 docx/08_connections.dox create mode 100644 docx/09_lipsync.dox create mode 100644 docx/10_early_audio.dox create mode 100644 docx/11_views.dox create mode 100644 docx/12_volumes.dox create mode 100644 docx/13_properties.dox create mode 100644 docx/13_x_notifications.dox create mode 100644 docx/14_misc.dox create mode 100644 docx/14_u_last_user_mode.dox create mode 100644 docx/14_x_mainloop.dox create mode 100644 docx/14_y_watchdog.dox create mode 100644 docx/14_zz_Startup_Rundown.dox create mode 100644 docx/15_a_CommandLineParsing.dox create mode 100644 docx/15_dlt_support.dox create mode 100644 docx/15_x_eclipse.dox create mode 100644 docx/16_readme.dox create mode 100644 docx/Doxyfile.in create mode 100644 docx/images/AudioDomains.gif create mode 100755 docx/images/AudioManagement.png create mode 100644 docx/images/AvailabilityofSinks.png create mode 100644 docx/images/AvailabilityofSources.png create mode 100755 docx/images/CancelRundown.png create mode 100755 docx/images/ChangeofAudioformatduringplaytime.png create mode 100755 docx/images/ClassDiagramm.png create mode 100644 docx/images/Deferred_Call_async.png create mode 100644 docx/images/Deferred_Call_sync.png create mode 100644 docx/images/Gateway.gif create mode 100644 docx/images/GatewayMatrix.png create mode 100644 docx/images/Interaction_with_sourcessinks.png create mode 100644 docx/images/Interacton_Overview.png create mode 100755 docx/images/InterruptStatusChange.png create mode 100755 docx/images/LastUserModeHandlingExample.png create mode 100644 docx/images/Levels.png create mode 100755 docx/images/Lifecylerequest.png create mode 100644 docx/images/Mainloop.png create mode 100755 docx/images/NodeStateManagementRelations.png create mode 100755 docx/images/Notifications.png create mode 100644 docx/images/PluginCommandInterfaceCAPI.png create mode 100644 docx/images/PluginRoutingInterfaceCAPI.png create mode 100644 docx/images/Register_Domain.png create mode 100755 docx/images/Registrations.png create mode 100755 docx/images/Rundown.png create mode 100755 docx/images/SettingConnectionFormats.png create mode 100644 docx/images/SoundPropertyChangeofSink.png create mode 100644 docx/images/SoundPropertyChangeofSource.png create mode 100755 docx/images/SourceStates.png create mode 100755 docx/images/Startup.png create mode 100755 docx/images/StartupWithLastUserMode.png create mode 100755 docx/images/VolumeChangesofSinks.png create mode 100644 docx/images/VolumeChangesofSources.png create mode 100644 docx/images/bus_topology.png create mode 100755 docx/images/daemon_insight.png create mode 100644 docx/images/delay.jpg create mode 100644 docx/images/dependencies.png create mode 100644 docx/images/dependencies_test.png create mode 100644 docx/images/dependency_created.png create mode 100644 docx/images/early.png create mode 100644 docx/images/example_system.png create mode 100644 docx/images/genivilogo.png create mode 100644 docx/images/late.png create mode 100644 docx/images/routing_hierarchy.png create mode 100644 docx/images/unique.svg create mode 100644 docx/images/versioning.png create mode 100755 docx/images/versioning_new.png create mode 100644 docx/images/views.png (limited to 'docx') diff --git a/docx/01_mainpage.dox b/docx/01_mainpage.dox new file mode 100644 index 0000000..ad0848b --- /dev/null +++ b/docx/01_mainpage.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) + * + */ + +/*! +\mainpage + +\image html genivilogo.png + +\par More information +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/docx/02_license.dox b/docx/02_license.dox new file mode 100644 index 0000000..d7fc220 --- /dev/null +++ b/docx/02_license.dox @@ -0,0 +1,38 @@ +/* + * 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 lic License +\section proj Open Source Projects in the source tree +The AudioManger comes with some open source software distributed in the source tree: +- Google Mock (in \googleMock), licensed under MIT license +- Tclap ( in \tclap-1.2.1), licensed under MIT license +\section split License Split +The licenses of this project are split into two parts:\n +1. the AudioManagerDaemon, licensed under MPL 2.0\n +2. all other parts that serve as example code that can be taken to build up an own project with it these parts are licensed +\section mpl Mozilla Public License, v. 2.0 +http://mozilla.org/MPL/2.0/ +\section mit MIT license +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, +including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR +THE USE OR OTHER DEALINGS IN THE SOFTWARE. +*/ \ No newline at end of file diff --git a/docx/02_x_dependecies.dox b/docx/02_x_dependecies.dox new file mode 100644 index 0000000..ff5c346 --- /dev/null +++ b/docx/02_x_dependecies.dox @@ -0,0 +1,26 @@ +/* + * 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 dep Dependencies +\section deps Dependency Graph +\image html dependencies.png +\section deptest Depedency Graph for Tests +\image html dependencies_test.png +\section depgen Generated Dependency Graph +\image html dependency_created.png +*/ \ No newline at end of file diff --git a/docx/02_y_versioning.dox b/docx/02_y_versioning.dox new file mode 100644 index 0000000..864a04e --- /dev/null +++ b/docx/02_y_versioning.dox @@ -0,0 +1,31 @@ +/* + * 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 ver Versioning +\section new_ver New versioning scheme +Due to the unclearness in the versioning scheme, the versioning scheme changed with release 7.0. +Beginning with the 7.0 version, the versioning changed to the semantic versioning described here: http://semver.org/. +For every version that released for GENIVI (independent from the compliance), a stable branch will be created which will start with a minor number increase. On the masterbranch, no minor number increases are foreseen. +\image html versioning_new.png +\section ver_graph The versioning scheme until 7.0 +The versioning scheme was decided in the February face2face 2012. +\image html versioning.png +For the daemon the third number (for example 1.0.X) describes the patch version. The versions are automatically created by git during the build process. +The versioning scheme is used for the AudioManager daemon itself and for each of it's interfaces. The versioning of the Interfaces in EA is defined via the tag "version" and the name of the interfaceversion versionName, for example "CommandReceiveVersion". This information is generated into the interface header files and is used then by cmake to set the interface versions. +Whenever changes are done, the minor version of the interface needs to be incremented. +*/ diff --git a/docx/03_architecture_overview.dox b/docx/03_architecture_overview.dox new file mode 100644 index 0000000..c38bb60 --- /dev/null +++ b/docx/03_architecture_overview.dox @@ -0,0 +1,85 @@ +/* + * 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 architecturepage Architecture Overview + +The architecture concept bases on the partition of management (logic) and routing (action). Sinks and sources are clustered +into independent parts which are capable of exchanging audio with each other (AudioDomains). Between these AudioDomains, +Audio can be interchanged via Gateways. \n +Since the routing and the management shall be independent from the actual used system, it is realized as an OwnedComponent, +the AudioManager. Each AudioDomain has a Routing Adapter which implements some necessary logic and is the interface between +the AudioManager and the AudioDomains. + +\section domains Audio Domains + +\image html AudioDomains.gif +An Audio Domain consists of sinks and sources that can exchange audio with each other. To make the most out of the concept, +AudioDomains shall be chosen in such a way that they are implemented by already existing audio routing engines. + +The AudioManager assumes that there are no restrictions in interconnection of sinks and sources. One or more sources can be +connected to one sink and one or more sinks can be connected to one source. Since real hardware or software might end up in +having restrictions, the knowledge of this must exist in the AudioManager and handled by him accordingly. This shall be +accomplished via a plug-in mechanism. An AudioDomain is not tied to a hardware or software implementation. It can be software +or hardware or even a combination of both. \n + +Examples for possible audio domains:\n +PulseAudio, Alsa, Jack, DSP, FPGA, MOST, In-chip switching matrix\n + +The clustering and usage of the AudioDomains will vary from each product. Care must be taken while choosing the right AudioDomains +in regards to system load (due to resampling), latency and of course flexibility.\n +In special implementations of the AudioDomain, it is capable of operation a certain time without interaction to the AudioManager. +This is needed to fulfill the requirements for Early & Late Audio, more information can be found below. +am::am_Domain_s describe the attribiutes of a domain. + +\section routing_adaptor Routing Adapter + +Via this adapter, the interconnection from the AudioManager to the AudioDomains is accomplished. An AudioDomain shall have exactly +one RoutingAdapter. In the terms of GENIVI, a RoutingAdapter is an AbstractComponent, this means that we define an API and a certain +behavior in UML models but do not maintain components itself. Existing implementations from Proof of Concepts are shipped as example +Adapters "as is" but cannot be seen as maintained components.\n +The implementation of a routing adapter can and will vary from each project to another since the combination of sinks and sources, +the used hardware etc has influence on the adapters. Besides interchanging and abstracting information between the AudioManager and +the sinks and sources, the Adapters also need to implement some business logic in order to interact with the AudioManager. +This include for example the registering of components, managing the current state, error handling etc.\n +In the special case of an EarlyDomain, the routing adapter also has to manage start-up and rundown including persistence for his +domain while the AudioManager is not started or already stopped. During this periods of time, these special adapters have to be able +to fulfill basic tasks like changing volumes, for example (this implies that the Adapter is implemented on a different piece of +hardware, e.g. vehicle processor). + +\section gateway Gateway + +\image html Gateway.gif + +Gateways are used to let audio flow between two domains. They always have a direction and can only transport one stream at a time. +Several gateways connecting the same domains together can exist in parallel so that more than one source can be connected to more +than one sink from the same domains at the same time.\n +In principle, gateways have the ability to convert the connectionFormat of an audiostream, for example the sink could receive audio +in a digital form and output it as analog (sound card). In order to express the conversion capabilities of a gateway, a matrix of +all source/sink connectionFormats is given (details below). The sources and sinks of a gateway are registered like ordinary sources +and sinks where the domains have the responsibility to register "their" sinks and sources.\n +For every gateway, a controlDomain is defined, this is the domain that registered the gateway. At the time of registering, the ID of +the "other end" of the gateway might be unknown. To handle this situation, a domain can "peek" Domains, Sources and Sinks. When +something is peeked, it means that an ID is reserved for a unique name without registering it.\n +If a gateway is deregistered, the source or sink of the controlling domain is deregistered as well - not the one in the "other" domain. + +\section converter Converter + +Converters are very similar to gateways - the only difference is that they work inside a domain. The usage of gateways is analog to +gateways. + +*/ diff --git a/docx/03_x_uml_model.dox b/docx/03_x_uml_model.dox new file mode 100644 index 0000000..802d181 --- /dev/null +++ b/docx/03_x_uml_model.dox @@ -0,0 +1,49 @@ + /* + * 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 uml UML Model auf the AudioManager +\section svn Audio Manager Branch +The SVN link to the AudioManager branch can be found here: https://svn.genivi.org/uml-model/genivi/branch/eg-mg-audiomanager +The last valid version that is compliant can be found on the trunk.\n +For more information about the EA model, please see here: https://collab.genivi.org/wiki/display/genivi/Audio+Management+UML+Model +After the EA Model is updated via "Get All latest", the relevant parts for Audio Management are:\n +- Requirements on System Level +\code +GENIVI Model -> Requirements View -> Media and Graphics -> Audio Management +\endcode +- Use Cases on System Level +\code +GENIVI Model -> Use Case View -> Audio Management +\endcode +- Requirements on Component Level +\code +GENIVI Model -> Logical View -> SW platform Requirements -> Multimedia -> AudioManagement +\endcode +- Use Cases on Component Level +\code +GENIVI Model -> Logical View -> Use Case Realizations -> AudioManagement +\endcode +- Component Diagram +\code +GENIVI Model -> Logical View -> SW Platform Components -> Audio Management +\endcode +- Implementation Class & Component diagrams: +\code +GENIVI Implementation -> Implementation View -> Audio Management +\endcode +*/ diff --git a/docx/04_components.dox b/docx/04_components.dox new file mode 100644 index 0000000..7c8f9b4 --- /dev/null +++ b/docx/04_components.dox @@ -0,0 +1,99 @@ + /* + * 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 audiomanagercomponentspage AudioManager Components + \image html AudioManagement.png + + The AudioManager is the central managing instance of the Audio architecture. It is designed as an OwnedComponent, this means that the + software is maintained within GENIVI as open source component. The AudioManager consists of 4 central components.\n + + + \section audiomanagercomponents AudioManagerDaemon + + This component is owned and maintained by Genivi. It is the central audio framework component. There can be only one daemon in a system (singleton).\n + The AudioManagerDaemon is subject to this documentation. + \subsection daemonover Daemon Overview + Here is an class overview of the AudioManagerDaemon: + \image html daemon_insight.png + + \section commander AudioManagerCommandPlugin + + This describes the interface towards the Commanding Instances of the AudioManagerDaemon. This is the HMI and interrupt sources that use this + interface to start their interrupt and stop it again. The interface shall be asynchronous. Via this interface all user interactions are handled. + This component is designed to be a dynamic linked library that will be loaded on the startup of the AudioManager. There can be more than one + CommandPlugin at a time. + Since the implementation of this component is project specific, only examples are included.\n + An example Dbus Implementation can be found in the folder PluginCommandInterfaceDbus. + + \subsection commandIface Interfaces + All commands that must be fulfilled by an AudioManagerCommandPlugin are described in am::IAmCommandSend.\n + All commands that are presented to AudioManagerCommandPlugin by the AudioManagerDaemon are described in am::IAmCommandReceive.\n + + \section controller AudioManagerController + The controller is the intelligent "heart" of the AudioManager and it is project specific. In principle, the controller gets commands from the command + interface or events from outside and reacts to them. For this purpose, some basic commands are in the "toolbox" of the Controller that he can use + to interact with the rest of the system.\n + Among this there are commands to read/write the database and to perform actions on the Audiodomains like connect or disconnect. There must be only one + Controller in the system at a time, like the AudioManagerCommandPlugins, the Controller is loaded at startup by the daemon\n + A simple example Implementation can be found in the folder PluginControlInterface. + + \subsection controlIface Interfaces + All commands that must be fulfilled by an AudioManagerController are described in am::IAmControlSend.\n + All commands that are presented to AudioManagerController by the AudioManagerDaemon are described in am::IAmControlReceive.\n + + \section router Routing AudioManagerRoutingPlugin + + The AudioManagerRoutingPlugins are used to abstract the actual Hard- and Software that does the routing. There can be more than one plugins at a + time, they are loaded at startup time like the commandplugins. \n + The AudioManager expects a bus-like structure behind each plug-in, so that a plug-in can implement a bus interface and proxy the messages to the + routing adapters - the AudioManager is capable of addressing more than one adapter one each plug-in. The AudioManagerController does not have to + know anything about the real system plugins - he sends his commands to sources and sinks. The daemon does the dispatching of these commands. + The interface is mainly asynchronous.\ + Sample plugins can be found in the directory, for example PluginRoutingInterfaceAsync.\n + + \subsection routingIface Interfaces + All commands that must be fulfilled by an AudioManagerRoutingPlugin are described in am::IAmRoutingSend.\n + All commands that are presented to AudioManagerRoutingPlugins by the AudioManagerDaemon are described in am::IAmRoutingReceive.\n + + \subsection subrouter Bus topology + The AudioManagerDaemon expects a bus behind each of the plugins. On one of these buses there can be several domains. In order to + reflect this, a domain has always a bus(plugin) and a node that it belongs to. So if a message needs to be transmitted to a domain, + it will always be sent to a node on a bus. + Here is a diagram showing the topology from the view of the AudioManagerDaemon: + \image html bus_topology.png + \subsection busname Busname + Since a plugin represents a bus for the AudioManagerDaemon, each plugin it has its unique name, the busname that is returned by + 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/docx/04_d_commonAPI.dox b/docx/04_d_commonAPI.dox new file mode 100644 index 0000000..7e837dd --- /dev/null +++ b/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/docx/04_x_elements.dox b/docx/04_x_elements.dox new file mode 100644 index 0000000..7990d37 --- /dev/null +++ b/docx/04_x_elements.dox @@ -0,0 +1,63 @@ + /* + * 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 elementspage Elements of the AudioManagement + + \section cDiag Overview Class Diagram + This class diagram shows a logical overview of the relevant elements in the AudioManager with their relations. + \image html ClassDiagramm.png + + The audiomanagement in principle consists of the following elements: + + \section source Sources + This is where audio comes from, for examples tuner, mediaplayer. But sources can also be part of a building block that processes audio, examples + are here crossfaders or gateways. Several Sinks can be connected to one source.\n + \subsection sourceattributes Attributes + - am::am_SourceType_s describes the attributes that are accessible from the AudioManagerCommandPlugins.\n + - am::am_Source_s describes the general attributes.\n + + \section sinks Sinks + This is where audio flows to, for examples amplifier, headphones. But sources can also be part of a building block that processes audio, + examples are here crossfaders or gateways. Several Sources can be connected to one sink.\n + \subsection sinkattributes Attributes + - am::am_SinkType_s describes the attribiutes that are accessible form the AudioManagerCommandPlugins.\n + - am::am_Sink_s describes the general attributes.\n + + \section gw Gateways + Gateways are described here: \ref gateway + A specialitry of a gateways is the convertionmatrix. It indicates which sinksoundformats can be transferred in which sourcesoundformats. A convertion + matrix looks like this: + \image html GatewayMatrix.png + \subsection gwattributes Attributes + - am::am_Gateway_s describe the attribiutes of a gateway\n + + \section crossfaders Crossfaders + Cross-faders are special elements that can perform cross-fading between two sources connected to the sinks of the crossfader. The audio of either source + or both (mixed, during the fade) is put out at the source of the fader. Cross-fading within a source (for example from one song to another) is out of + scope audio management and must be performed in the source.\n + A crossfader has two sinks and one source, where one sink is the "hot" one. It is in the duty of the AudioManagerController to connect the correct + sources to the sinks in order to perform a cross-fade. When fading is started, the hotSink changes from either HS_SINKA or HS_SINKB to HS_INTERMEDIATE, + when the fading is finished, it changes to HS_SINKA or HS_SINKB (the sink that was "cold" before).Fading itself is done in the RoutingAdapters, the + implementation has to ensure the smooth and synchronous change of volumes. With different rampTypes, different kinds of cross-fade ramps can be supported. + The actual status of the "hot" sink is reported by the routingAdapter. Care has to be taken that the correct "hot" end of the crossfader is given + at registration time.\n + \subsection cfattributes Attributes + - am::am_Crossfader_s describes the attribiutes of a Crossfader + + +*/ \ No newline at end of file diff --git a/docx/04_y_audiomanager_and_sources.dox b/docx/04_y_audiomanager_and_sources.dox new file mode 100644 index 0000000..fd0f1e3 --- /dev/null +++ b/docx/04_y_audiomanager_and_sources.dox @@ -0,0 +1,92 @@ + /* + * 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 sourcesink The relation of sources & sinks with the AudioManager + +\section claDi Class diagramm of the relation between sources, sinks and the AudioManager +In general, the relationship is defined as well as the interfaces that are used to communicate the informations back and forth. But since the +exchange of these informations is abstracted by the RoutingPlugins, the architecture cannot define explicit mechanisms here.\n +A lot of attributes that are part of sources and sinks belong logical to them and might be implemented by the RoutingPlugin. The relation between +sources, sinks and the AudioManagerDaemon is shown in this \ref cDiag . + +\section boil The REAL interaction +A lot of information is related to sources and sinks as can be seen here: \ref cDiag . But not all informations are actually communicated to the +sources and sinks since the routing adaptor will take care of handling some of these informations.\n +Here are some informations that is believed to be actually communicated to the sources and sinks: + + \section conFormats Connection Formats + The am::am_CustomAvailabilityReason_t formats for a connection are chosen when the connection is build up. So if there are more than one possbilities + that can be used for a connection (am::am_Sink_s::listConnectionFormats and am::am_Source_s::listConnectionFormats) the correct one is chosen + upon a connect. If this is relevant to the sources and sinks, the routingAdaptor must communicate to the sources and sinks accordingly. + \image html SettingConnectionFormats.png + + + \section sstates Source States + This diagrams shows the sequence that is used to set the sources states am::am_SourceState_e. Since the source states are set by the + AudioManagerController, the exact behavior is product specific. + \image html SourceStates.png + + \section avail Availability + This diagram shows the sequence that is used to communicate the availability am::am_Availability_s. from the sources. Please note that the availability reasons + am::am_CustomAvailabilityReason_t are product specific. + \image html AvailabilityofSources.png + Here is the same for the sinks: + \image html AvailabilityofSinks.png + + \section vol Volumes + Volumes am::am_volume_t are set to the sinks, mainly, but depending on the used audio routing system it might be that they can be set on the source level as well. + If this is not the case, proper measures must be taken to do this. + Changes of a source: + \image html VolumeChangesofSources.png + Changes of a sink: + \image html VolumeChangesofSinks.png + + \section SoundProperties + The am::am_SoundProperty_s are set to the sources and sinks. More information about SoundProperties can be found here: \ref prop. + Changes of a sink: + \image html SoundPropertyChangeofSink.png + Changes of a source: + \image html SoundPropertyChangeofSource.png + + \section in Interrupt States + The am::am_InterruptState_e are reported by low level interrupts from the sources to the AudioManagement. More details here: \ref interrupts . + \image html InterruptStatusChange.png + + + + + + + + + + + + + + + + + + + + + + + +*/ \ No newline at end of file diff --git a/docx/05_unique.dox b/docx/05_unique.dox new file mode 100644 index 0000000..5bf021a --- /dev/null +++ b/docx/05_unique.dox @@ -0,0 +1,36 @@ + /* + * 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 uniquepage About unique IDs : Static vs Dynamic IDs + + \section why Why having two different kinds of ids? + The complexity of up-to-date IVI-systems demand to support sources and sinks dynamically added and removed in order to support the variety of CE products, + but parts of the system are never going to change - to start a dynamic registration here is a waste of system capacity.\n + \section setup The setup + The AudioManagement is capable of handling static, dynamic or mixed setups. In case of a dynamic setup, all elements of the system like domains, sinks, + sources, gateways etc are registered at system start-up. In a static setup, the IDs of the elements are known and fixed - no further registration is needed. + The start-up for static elements works as follows:\n + when a domain known as static (this is knowledge of the AudioManagerController, recognized by the unique name of the domain) registers, the + AudioManagerController enters all elements of this domain in the database. Still, this domain can register additional elements during runtime. + In case of static setups, the RoutingAdapter needs to ensure that all static elements are ready to be used when the domain registers.\n + In order to ensure the uniqueness of IDs, there exist two separate ID areas (for each of sources, sinks, gateways and crossfaders):\n\n + \image html unique.svg + In case of dynamic added elements, the audiomanagerdaemon ensures the uniqueness of the ID's, in case of the static setup, the project has to ensure the + uniqueness by assigning the IDs wisely. The knowledge of the static IDs need to be in the AudioManagerController, the RoutingAdapters and in the HMI + (optional because IDs will be reported anyway).\n + Domains cannot be static because registering them is the trigger for the AudioManagerController to enter the static values into the database. +*/ diff --git a/docx/06_classification.dox b/docx/06_classification.dox new file mode 100644 index 0000000..0fb72cd --- /dev/null +++ b/docx/06_classification.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 classficationpage Classification of Sinks and Sources + \section classification Classification + The AudioManagement offers classification for sources and sinks. It can be used to group sources and sinks together and link certain behaviors to these groups. + An example for such a use is to group all interrupt sources in a class together and let the AudioManagerController react different for this class.\n + Elements can only have one class at a time. The AudioManagerDaemon will take care of registration of sourceClasses, sinkClasses and will assign unique IDs, + but the parameters of the Classes itself are product specific and have to be interpreted by the AudioManagerController. This concept allows for very individual + implementations of system behaviors.\n + Since Classes are held in the database, Classes can be registered and deregistered during runtime, it is recommended that the AudioManagerController enters + all source & sink classes at start-up into the database.A ClassProperty exists out of an enumeration (am_CustomClassProperty_t, project specific) and a corresponding + value (integer) that is interpreted by the AudioManagerController according to am_CustomClassProperty_t.\n + There is no restriction to the number of properties a class can have and how many classes can exist in a system.\n + \section attributes Attributes + - am::am_SourceClass_s describes the attributes of a source class\n + - am::am_SinkClass_s describes the attributes of a sink class\n +*/ diff --git a/docx/07_interrupts.dox b/docx/07_interrupts.dox new file mode 100644 index 0000000..0e26b88 --- /dev/null +++ b/docx/07_interrupts.dox @@ -0,0 +1,36 @@ + /* + * 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 interrupts Interrups & Low Level Interrupts + \section diff Differences + The only difference between a "normal" interrupt and a source for the audioManagement may lie in it's classification, so playing a "normal" interrupt is not + different to changing a source. An exception here are the so called "low level interrupts".\n + \section crit Criterias + These are special sources that fulfill the following criteria: + - direct connection to a sink that is "always on", so no extra actions and communications need to be done in order to play audio + - no dependencies to the current system state need to be checked before playing. This means that the source knows if it is allowed to play at the moment it + wants to play + - all information for the source that is needed to judge if it is allowed to play or not is either directly retrieved by the source or set static via a property. + + This becomes very handy for implementing such things like park distance control. When the source is informed that it needs to output signals + (due to an emerging wall for example) it outputs the beeps directly to the amplifier that then overlays the sound to the current active source.\n + Settings that influence the behavior of low level interrupts like for example volume offset for park distance control or sound on/off for it need to be done via + sourceProperties on the source level, so that the judgment and the adoptions that need to be taken can be taken by the source without system interaction. + In order to give the AudioManagerController the chance to react on a low level interrupt (by lowering the main volume for example), a feedback path is provided + and the AudioManagerController is informed about the current state of the low level interrupt (via hooklInterruptStatusChange).\n +*/ diff --git a/docx/08_connections.dox b/docx/08_connections.dox new file mode 100644 index 0000000..fd8a194 --- /dev/null +++ b/docx/08_connections.dox @@ -0,0 +1,33 @@ + /* + * 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 connpage Connections & MainConnections + \section con Connections + A connection connects a source to a sink to let audio data flow. The direction of the flow is always source to sink. For each connection the connectionFormat + must be defined when the connection is demanded, if source or sink is not capable of supporting this format, the connection cannot be established. + ConnectionFormats are product specific, also are some standard formats defined within GENIVI that can be enhanced in the product area. Examples of formats: + analog, autodefined, stereo 48khz 16bit PCM, .... + + \section maincon Mainconnections + is visible to the HMI and consists out of one or more connections. A MainConnection shall always connect a Source and a Sink visible to the HMI. + In contradiction to connections, the MainConnection does not know about connectionFormat. MainConnections are demanded by the commandInterface. + This picture demonstrates the relation between MainConnections and connections: + \image html Levels.png + + \section att Attributes + - am::am_Connection_s describes the attributes of a conenction + - */ \ No newline at end of file diff --git a/docx/09_lipsync.dox b/docx/09_lipsync.dox new file mode 100644 index 0000000..6229198 --- /dev/null +++ b/docx/09_lipsync.dox @@ -0,0 +1,37 @@ + /* + * 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 lip Lipsync + + \section t The Task of the Audiomanager + It is the job of the AudioManager to retrieve all latency timing information from each connection, to aggregate this information and provide a latency # + information on a per MainConnection Basis. It is not the task of the AudioManager to actually delay or speed up video or audio signals to achieve a lipsync. + The actual correction shall be done in the with the information provided by the AudioManager. + The time information is always reported by the routingadapters for each connection. Delays that are introduced in a sink or a gateway are counting for the + connection that connects to this sink or gateway. + \section ex Example + \image html delay.jpg + + This graph shows how the delay is calculated: + - Connection 1 has a delay 2ms + 60ms that is added due to the gateway + - Connection 2 has a delay 0ms + 10ms due to sink + So the routing adapters report 62ms and 10ms, the audiomanager will add this to 72ms and report this value for the main connection from sink to source. + The videoplayer getting this information can now delay his video against the audio for 72ms and be in perfect lipsync.\n + After the buildup of a connection the first timing information needs to be sent within 5 seconds, the timing information from the routing adapters need to + be sent via 4 seconds. If the latency for a connection is variable and changes over lifetime of the connection, the routing adapters shall resend the value + and the audiomanager will correct the over all latency. +*/ diff --git a/docx/10_early_audio.dox b/docx/10_early_audio.dox new file mode 100644 index 0000000..bdd72f5 --- /dev/null +++ b/docx/10_early_audio.dox @@ -0,0 +1,31 @@ + /* + * 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 early Early Audio +\section req The Requirement +The requirement reviews showed that one very important aspect of managing audio within GENIVI is the early/late phase where the Linux part of the system is +not available. This feature is addressed via special domains: EarlyDomains. These domains are acting "unmanaged" - meaning without the interaction with the +AudioManager - providing a simpler set of features until the AudioManager is up and running. When the Linux system is then fully operable a handover is done +from the EarlyDomains towards the AudioManager. In order to be able to operate without the Linux up and running, the EarlyDomains must be implemented on a +second fast-boot or always-on controller, e.g. the so called vehicle processor.\n +\section earlys Early Startup +This picture shows the principle of the early startup: +\image html early.png +\section late Late Rundown +This picture shows the principle of the late rundown: +\image html late.png +*/ \ No newline at end of file diff --git a/docx/11_views.dox b/docx/11_views.dox new file mode 100644 index 0000000..2dda7c9 --- /dev/null +++ b/docx/11_views.dox @@ -0,0 +1,33 @@ + /* + * 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 views The two views of the AudioManager +In general, there are two views of the system:\n +\section command The CommandInterface View View +This is an abstracted view that the HMI and other controlling Instances have of the system. Every Information (with some little exceptions) here is maintained +by the AudioManagerController, so that he can "fake" situations for the HMI. +So why is that? Depending on the actual project it might be - for example - that not the volume at the sink must be changed, but instead of the source. +The HMI does not know about sourceVolumes (and does not need to!) so the HMI would change the sink volume and the AudioManagerController can translate it to a +sourceVolumeChange. The metrics of the volumes are different as well. +It is the duty of the AudioManagementController to keep the commandInterface information consistent with the "real" situation. +\section route RoutingInterface View +Here are the "real" system states. All changes that are done on this interface are maintained by the AudioMangerDaemon and here is the actual situation always +consistent with the reality. All actions on this interface are either triggered by the AudioManagerController or by the domains itself, like registration for +example. +\section over Overview +\image html views.png +*/ \ No newline at end of file diff --git a/docx/12_volumes.dox b/docx/12_volumes.dox new file mode 100644 index 0000000..60603bc --- /dev/null +++ b/docx/12_volumes.dox @@ -0,0 +1,29 @@ + /* + * 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 vol Volumes & MainVolumes +\section mainVol MainVolumes +This is the volume at the CommanInterface level. The exact definition is project specific and can be adopted for each project since the AudioManagerController +and the HMI are the only ones who need to interfere with this volume. The actual value is an integer. +- am::am_mainVolume_t defines the mainvolume + +\section volv Volumes +These are the actual volumes that are set for sources and sinks. The unit is 0.1 db steps,The smallest value -3000 (=AM_MUTE). The minimum and maximum can be +limited by actual project. +- am::am_volume_t describes the volume +*/ diff --git a/docx/13_properties.dox b/docx/13_properties.dox new file mode 100644 index 0000000..2597fdf --- /dev/null +++ b/docx/13_properties.dox @@ -0,0 +1,33 @@ + /* + * 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 prop Properties + \section soundprop SoundProperties & MainSoundProperties +SoundProperties are properties that are related to either a source or a sink. They are product specific and are used to set source or sink specific properties. +This could be for example: equalizer settings, relative volume offsets but also bool information "surround sound on/off". +A soundProperty is defined by its type (am_SoundProperty_e, a product specific enum) and a value (integer) that is interpreted according to the type. +There are not limits how many properties a sink or a source can have. SoundProperties in contradiction to MainSoundProperties are not visible to the +CommandInterface.\n +- am::am_SoundProperty_s describe the of the SoundProperties +- am::am_MainSoundProperty_s describe the attributes of MainSoundProperties + * +\section sys SystemProperties +are properties that apply to the whole system or parts of it but cannot be tight to a specific sink or source. They are product specific and could be used +for example to set general behavior like all interrupts on/off for example. The information is only exchanged between the commandInterface and the +AudioManagerController. The AudioManagerController has to interpret the value and react accordingly. +- am::am_SystemProperty_s describes the attributes of Systemproperties +*/ \ No newline at end of file diff --git a/docx/13_x_notifications.dox b/docx/13_x_notifications.dox new file mode 100644 index 0000000..135d4a5 --- /dev/null +++ b/docx/13_x_notifications.dox @@ -0,0 +1,64 @@ + /* + * 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 notifi Notifications +\section notifi_ex What are notifications? +The notification feature can be used to gather information from sources or sinks periodically or on certain thresholds.It can be used to implement a graphical spectrum for example or other information need to be passed back from sources or sinks. + +\section notifi_overview Overview +\image html Notifications.png + +\section notifi_command CommandInterface +all this methods have to do with MainNotifications (Information level between command and control) +- am::IAmCommandSend::cbSinkNotification +- am::IAmCommandSend::cbSourceNotification +- am::IAmCommandSend::cbMainSinkNotificationConfigurationChanged +- am::IAmCommandSend::cbMainSourceNotificationConfigurationChanged +- am::IAmCommandReceive::getListMainSourceNotificationConfigurations +- am::IAmCommandReceive::getListMainSinkNotificationConfigurations +- am::IAmCommandReceive::setMainSourceNotificationConfiguration +- am::IAmCommandReceive::setMainSinkNotificationConfiguration +\section notifi_control ControlInterface +all this methods have to do with MainNotifications (Information level between command and control) +- am::IAmControlSend::hookUserSetMainSinkNotificationConfiguration +- am::IAmControlSend::hookUserSetMainSourceNotificationConfiguration +- am::IAmControlReceive::changeMainSinkNotificationConfigurationDB +- am::IAmControlReceive::changeMainSourceNotificationConfigurationDB +- am::IAmControlReceive::sendMainSinkNotificationPayload +- am::IAmControlReceive::sendMainSourceNotificationPayload + +all this methods have to do with notifications (Information level between cotrol and routing) +- am::IAmControlSend::cbAckSetSinkNotificationConfiguration +- am::IAmControlSend::cbAckSetSourceNotificationConfiguration +- am::IAmControlSend::hookSinkNotificationDataChanged +- am::IAmControlSend::hookSourceNotificationDataChanged +- am::IAmControlReceive::setSinkNotificationConfiguration +- am::IAmControlReceive::setSourceNotificationConfiguration +\section notifi_routing RoutingInterface +all this methods have to do with notifications (Information level between cotrol and routing) +- am::IAmRoutingSend::asyncSetSinkNotificationConfiguration +- am::IAmRoutingSend::asyncSetSourceNotificationConfiguration +- am::IAmRoutingReceive::ackSinkNotificationConfiguration +- am::IAmRoutingReceive::ackSourceNotificationConfiguration +- am::IAmRoutingReceive::hookSinkNotificationDataChange +- am::IAmRoutingReceive::hookSourceNotificationDataChange + +\section notifi_levels Notification Levels +For notifications it's the same as for the soundproperties: there are two levels of information. One is between the Command Interface and the Control Interface +here it is in the duty of the controller to handle the notification data. The other one is between Control and Routing Interface. This could be used for example +to route the information from a source to the command interface. +*/ \ No newline at end of file diff --git a/docx/14_misc.dox b/docx/14_misc.dox new file mode 100644 index 0000000..8ae15c2 --- /dev/null +++ b/docx/14_misc.dox @@ -0,0 +1,39 @@ + /* + * 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 misc Miscellaneous + +\section misc_connfor Connection Formats +Every flow of audio is using a format to exchange data. The format that the source and the sink uses must match together in order to have an undisturbed +experience. It is common that sources and sinks are capable of supporting more than one audioformat.\n +So all sources and sinks register with a list of connectionFormats that they support and for each connection a format must be chosen that is then used +to transport the audio data. Gateways (and Soundconverters) have the information which connectionFormat can be transformed into another one. +am::am_CustomAvailabilityReason_t has all formats listed.\n +There is a special usecase that is worth showing as an example in this regard: the change of a connectionFormat when switching from one song to another. Here is an +example of how the project specific parts could handle this: +\image html ChangeofAudioformatduringplaytime.png + + +\section misc_pers Persistence +The persistence client library is defined as an abstract component with a c-like library interface. Since the AudioManagerController is the only one to know +what is to be made persistent, he is the one interfacing with that library. This is the reason why there is no specific interface for the persistence here. + +\section misc_speed Speed dependent volume +The adjustments for the speed are done product specific in the controller. The speed information itself is retrieved by the AudioManagerDaemon, sampled and +quantified and forwarded to the controller. The interface in not yet defined !\n +Turning speed controlled volume on/off and possible settings are achieved via SinkSoundProperty settings. +*/ \ No newline at end of file diff --git a/docx/14_u_last_user_mode.dox b/docx/14_u_last_user_mode.dox new file mode 100644 index 0000000..0c90f89 --- /dev/null +++ b/docx/14_u_last_user_mode.dox @@ -0,0 +1,37 @@ + /* + * 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 luc Last User Mode +\section luc_concept Last User Mode concept +In general last user modes are project specific. So it is not mandatory to do it like described here - it is just a suggestion how it could be implemented +together with the LUC handler (Last User Concept). The LUC handler is a part of the NSC (Node State Controller) which is a GENIVI component. More information can be +found within GENIVI.\n +For implementing the suggested method here, the AudioManagerController has to take care of communicating with the LUC handler. The AudioManager is the +component that knows the last heard source that should be started earlier than others in order to reduce the timespan until the customer can hear it's last +source.\n +In order to fullfull this, the controller has to keep a map that links sources to unit files. The sequence that shall be an example of how it could be realized.\n + +\section luc_rundown The handling in the rundown context: +\image html LastUserModeHandlingExample.png + +\section luc_startup The next startup: +\image html StartupWithLastUserMode.png + + + + */ diff --git a/docx/14_x_mainloop.dox b/docx/14_x_mainloop.dox new file mode 100644 index 0000000..8f112bc --- /dev/null +++ b/docx/14_x_mainloop.dox @@ -0,0 +1,49 @@ + /* + * 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 mainl Mainloop concept +\section mconcept Mainloop +The AudioManager comes with a build in mainloop that can be utilized by the plug-ins to serve their needs of communication and thread-safe calling. +The mainloop, implemented in CAmSocketHandler works like this:\n +\image html Mainloop.png + +\section sec Using the Mainloop +Adding and removing callbacks and timers work via the am::CAmSocketHandler.\n +To add a callback, use am::CAmSocketHandler::addFDPoll, to remove one, use am::CAmSocketHandler::removeFDPoll.\n +To add a timer callback, use am::CAmSocketHandler::addTimer, use am::CAmSocketHandler::removeTimer and am::CAmSocketHandler::restartTimer and +am::CAmSocketHandler::stopTimer.\n +The mainloop is started via am::CAmSocketHandler::start_listenting and stopped via am::CAmSocketHandler::stop_listening. +Example code can be found in am::CAmDbusWrapper. + +\section util Utilizing The Mainloop as Threadsafe Call Method +The AudioManager itself is singlethreaded, so any calls from other threads inside the plugins directly to the interfaces is forbidden, the +behavior is undefined. The reason for this is that communication and routing plugins are often only communication interfaces that can are ideally used +with the am::CAmSocketHandler.\n +am::CAmSerializer creates an intermediate object on the heap holding all informations of the function to be called and a pointer to the object to be called. +After that, the class writes to a pipe witch triggers the mainloop to call the callback am::CAmSerializer::receiverCallback from the maincontext. The +callback uses the intermediate object to do the actual call. \n +\warning asynchronous calls can be used within the main thread, but synchronous not -> the call would block forever !\n +For each thread that needs to use synchronous calls independent an own instance of am::CAmSerializer needs to be used. +\subsection async Asynchronous calls +\image html Deferred_Call_async.png +\subsection sync Synchronous calls +\image html Deferred_Call_sync.png + + + + */ diff --git a/docx/14_y_watchdog.dox b/docx/14_y_watchdog.dox new file mode 100644 index 0000000..a1facc5 --- /dev/null +++ b/docx/14_y_watchdog.dox @@ -0,0 +1,44 @@ + /* + * 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 watchd The watchdog +\section watchdconcept The watchdog concept +The watchdog concept of the audiomanger is based on systemd. When systemd is configured via the unit file to use a watchdog and watchdog support is activated +in the audiomanager, the audiomanager will reset the watchdog via the mainloop in the given interval to prevent systemd from restarting the audiomanager.\n +If the audiomanager is stuck for whatever reason, systemd will not get this update and restart the audiomanager. + + +\section configwatch Watchdog configuration +By default, the watchdog is enabled in the audiomanager, you can disable the watchdog functionality by setting the cmake build option "WITH_SYSTEMD_WATCHDOG" to +OFF, either by modifying the cmake cache with ccache or by passing -DWITH_SYSTEMD_WATCHDOG=OFF to cmake.\n +The interval for checking the watchdog can be set in the unitfile of systemd by setting "WatchdogSec". The other settings need to be done as well: +\code +Restart=always +WatchdogSec=2 +NotifyAccess=main +\endcode +The intervall for pinging systemd is set to the half of "WatchdogSec". + +\section winteg Integration with systemd +The audiomanager will use the library proviced by "libsystemd-daemon" if it is available on the system. If this library is not available, the files sd-daemon.c and sd-daemon.h +that are provided with the audiomanager and released under MIT licence by Lennard Poettering will be used to connect to systemd. + +more information can be found here: am::CAmWatchdog and sd-daemon.h . + + + */ diff --git a/docx/14_zz_Startup_Rundown.dox b/docx/14_zz_Startup_Rundown.dox new file mode 100644 index 0000000..88f8dc6 --- /dev/null +++ b/docx/14_zz_Startup_Rundown.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 start Startup and Rundown +\section start_Start Startup +This flow describes the startup of the AudioManager: +\image html Startup.png +\section start_Rundown Rundown +This flow describes the rundown of the AudioManager: +\image html Rundown.png +\section start_Cancel Cancelled Rundown +This flow describes the cancel rundown of the AudioManager: +\image html CancelRundown.png + + */ diff --git a/docx/15_a_CommandLineParsing.dox b/docx/15_a_CommandLineParsing.dox new file mode 100644 index 0000000..74dd2e0 --- /dev/null +++ b/docx/15_a_CommandLineParsing.dox @@ -0,0 +1,45 @@ + /* + * 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 cmdline CommandLineParsing +\section tclap TCLAP +Commandline parsing is accomplished via a template library that is added to the source tree of the Audiomanager: TCLAP. +The license of this libraty is MIT. +It manages commandline parsing in a handy way. More information can be found here: +http://tclap.sourceforge.net +\section cmdplugins CommandLine Parsing in the Plugins +The commandline Class that parses the commandline can be accessed via am::CAmCommandLineSingleton . This factory creates +a commandline object that can be accessed everywhere in the Audiomanager. +In the constructor of a plugin, the plugins can add commandline arguments they hold as member. +Here the member, in this case of type TCLAP::ValueArg mCommandLineArg; + +\code +mCommandLineArg("K","controllerPluginArg","a test argument for the controller",false,"bla","string") +\endcode + +In the constructor, add the argument to the commandline like this +\code +CAmCommandLineSingleton::instance()->add(mCommandLineArg); +\endcode +And then in the startup controller routine (or later) you can get the value of the argument, like +\code +mCommandLineArg.getValue() +\endcode + +An example can be found in the plugins repository in the test controller. + +*/ diff --git a/docx/15_dlt_support.dox b/docx/15_dlt_support.dox new file mode 100644 index 0000000..ca34896 --- /dev/null +++ b/docx/15_dlt_support.dox @@ -0,0 +1,23 @@ + /* + * 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 dlt Dlt support +\section compile Compilerswitch +The AudioManager can be compiled with or without DLT support, in case that DLT is not compiled in (cmake option WITH_DLT), logging is switched off. +You can log to the commandline by starting the Audiomanager with the option -V.\n +If you want to log to the commandline and you have dlt compiled in, use the environment variable of the dlt to log to the command line. +*/ \ No newline at end of file diff --git a/docx/15_x_eclipse.dox b/docx/15_x_eclipse.dox new file mode 100644 index 0000000..95c8e9f --- /dev/null +++ b/docx/15_x_eclipse.dox @@ -0,0 +1,91 @@ + /* + * 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 eclip Download Compile Debug +\section dw Get the source +For compiling the source, you need to use git and the following packages:\n +\code +sudo apt-get install libdbus-1-dev libsqlite3-dev doxygen libgtest-dev google-mock git cmake build-essential python2.6-dev +\endcode +Getting the source got works with following command +\code +git clone https://:@git.genivi.org/srv/git/AudioManager +\endcode +\section build Compile +In order to build the project (out of source build), please follow these instructions on the commandline: +\code +mkdir /build +cd build +cmake .. +\endcode +if you want to influence the build options, you can use ccmake for example (apt-get install ccmake) +\code +ccmake .. +\endcode +You will get a menue that let's you select different options for the build. Compiling with a simple +\code +make +\endcode +after the script finished, you should have: +- a bin/ folder which contains all executables and the libraries: +- a build/ folder which has all build objects (erase that if you need a clean build) +- a doc/ folder in case you turned the documentation on + +in order to install the AudioManager, you can do +\code +sudo make install +\endcode +package generation is supported via CPack. To build packages, you have to +\code +make genivi_package +\endocde +this will create one package if your CMake version is < 2.8.5 (all binaries stripped): +\code +AudioManager--Linux.deb +\endcode +if your version is above, you will get 4 packages (all binaries stripped) : +\code +AudioManager--Linux-bin.deb [AudioManager binary] +AudioManager--Linux-dev.deb [header files needed to compile plugins] +AudioManager--Linux-sampleplugins.deb [sample plugins] +AudioManager--Linux-tests.deb [tests including tests for sample plugins, +installed in the ~/AudioMAnagerTests] +\endcode +to create a tar.gz file of all sources (not including .git, build and bin folder,config files), you can do: +\code +make package_source +\endcode +This will create the following package: +\code +AudioManager--Source.tar.gz +\endcode +All packages will be placed in a folder called packages +\section ec Using Eclipse +First you need to get eclipse, for example by downloading it from http://www.eclipse.org/ use the C++ CDT version. +Import the project with\n +File-> import project\n +Select "existing code as makefile project" and choose the root folder auf the AudioManager\n +In order to build with eclipse you need to tell eclipse where the makefile can be found:\n +In project properties enter as build command: +\code +"make -j4 -C build" as build command +\endcode +\section deb Debugging with eclipse +For debugging you need to modify debug configurations, choose the audiomanager as binary, the debugging should work. +*/ diff --git a/docx/16_readme.dox b/docx/16_readme.dox new file mode 100644 index 0000000..7798fee --- /dev/null +++ b/docx/16_readme.dox @@ -0,0 +1,20 @@ + /* + * 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 comp Compiling & Co + README +*/ \ No newline at end of file diff --git a/docx/Doxyfile.in b/docx/Doxyfile.in new file mode 100644 index 0000000..802d5f8 --- /dev/null +++ b/docx/Doxyfile.in @@ -0,0 +1,2326 @@ +# Doxyfile 1.8.10 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = AudioManager + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = @DAEMONVERSION@ + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Native Application Runtime Environment" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = "@GEN_DOC_DIR@" + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@ \ + @PROJECT_BINARY_DIR@ + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = @ENABLED_SECTIONS@ + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = YES + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = NO + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = NO + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = NO + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = @CMAKE_CURRENT_SOURCE_DIR@ + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, +# *.vhdl, *.ucf, *.qsf, *.as and *.js. + +FILE_PATTERNS = *.cpp \ + *.h \ + *.dox + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# 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 = */test/* */build*/* */cmake/* */googleMock/* */tclap*/* + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = @CMAKE_SOURCE_DIR@/docx/images + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /