* updated license headers

* updated documentation

1 files changed, 24 insertions, 81 deletions

diff --git a/AudioManagerDaemon/include/CAmRoutingSender.h b/AudioManagerDaemon/include/CAmRoutingSender.h
index c6a7677..41d48de 100644
--- a/AudioManagerDaemon/include/CAmRoutingSender.h
+++ b/AudioManagerDaemon/include/CAmRoutingSender.h
@@ -1,24 +1,22 @@
 /**
- * Copyright (C) 2011, BMW AG
+ * Copyright (C) 2012, GENIVI Alliance, Inc.
+ * Copyright (C) 2012, BMW AG
  *
- * GeniviAudioMananger AudioManagerDaemon
+ * This file is part of GENIVI Project AudioManager.
  *
- * \file CAmRoutingSender.h
+ * 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/.
  *
- * \date 20-Oct-2011 3:42:04 PM
- * \author Christian Mueller (christian.ei.mueller@bmw.de)
  *
- * \section License
- * GNU Lesser General Public License, version 2.1, with special exception (GENIVI clause)
- * Copyright (C) 2011, BMW AG Christian Mueller  Christian.ei.mueller@bmw.de
+ * \author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012
  *
- * This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License, version 2.1, as published by the Free Software Foundation.
- * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License, version 2.1, for more details.
- * You should have received a copy of the GNU Lesser General Public License, version 2.1, along with this program; if not, see <http://www.gnu.org/licenses/lgpl-2.1.html>.
- * Note that the copyright holders assume that the GNU Lesser General Public License, version 2.1, may also be applicable to programs even in cases in which the program is not a library in the technical sense.
- * Linking AudioManager statically or dynamically with other modules is making a combined work based on AudioManager. You may license such other modules under the GNU Lesser General Public License, version 2.1. If you do not want to license your linked modules under the GNU Lesser General Public License, version 2.1, you may use the program under the following exception.
- * As a special exception, the copyright holders of AudioManager give you permission to combine AudioManager with software programs or libraries that are released under any license unless such a combination is not permitted by the license of such a software program or library. You may copy and distribute such a system following the terms of the GNU Lesser General Public License, version 2.1, including this special exception, for AudioManager and the licenses of the other code concerned.
- * Note that people who make modified versions of AudioManager are not obligated to grant this special exception for their modified versions; it is their choice whether to do so. The GNU Lesser General Public License, version 2.1, gives permission to release a modified version without this exception; this exception also makes it possible to release a modified version which carries forward this exception.
+ * \file CAmRoutingSender.h
+ * For further information see http://www.genivi.org/.
  *
  */
 
@@ -46,57 +44,16 @@ public:
     CAmRoutingSender(const std::vector<std::string>& listOfPluginDirectories);
     ~CAmRoutingSender();
 
-    /**
-     * removes a handle from the list
-     * @param handle to be removed
-     * @return E_OK in case of success
-     */
     am_Error_e removeHandle(const am_Handle_s& handle);
-
-    /**
-     * @author Christian
-     * this adds the domain to the lookup table of the Router. The data is used to have a quick lookup of the correct pluginInterface.
-     * This must be done whenever a domain is registered.
-     */
     am_Error_e addDomainLookup(const am_Domain_s& domainData);
-    /**
-     * @author Christian
-     * this adds the Source to the lookup table of the Router. The data is used to have a quick lookup of the correct pluginInterface.
-     * This must be done whenever a Source is registered.
-     */
     am_Error_e addSourceLookup(const am_Source_s& sourceData);
-    /**
-     * @author Christian
-     * this adds the Sink to the lookup table of the Router. The data is used to have a quick lookup of the correct pluginInterface.
-     * This must be done whenever a Sink is registered.
-     */
     am_Error_e addSinkLookup(const am_Sink_s& sinkData);
-    /**
-     * @author Christian
-     * this adds the Crossfader to the lookup table of the Router. The data is used to have a quick lookup of the correct pluginInterface.
-     * This must be done whenever a Crossfader is registered.
-     */
     am_Error_e addCrossfaderLookup(const am_Crossfader_s& crossfaderData);
-    /**
-     * @author Christian
-     * this removes the Domain to the lookup table of the Router. This must be done everytime a domain is deregistered.
-     */
     am_Error_e removeDomainLookup(const am_domainID_t domainID);
-    /**
-     * @author Christian
-     * this removes the Source to the lookup table of the Router. This must be done everytime a source is deregistered.
-     */
     am_Error_e removeSourceLookup(const am_sourceID_t sourceID);
-    /**
-     * @author Christian
-     * this removes the Sink to the lookup table of the Router. This must be done everytime a sink is deregistered.
-     */
     am_Error_e removeSinkLookup(const am_sinkID_t sinkID);
-    /**
-     * @author Christian
-     * this removes the Crossfader to the lookup table of the Router. This must be done everytime a crossfader is deregistered.
-     */
     am_Error_e removeCrossfaderLookup(const am_crossfaderID_t crossfaderID);
+
     am_Error_e startupInterfaces(CAmRoutingReceiver* iRoutingReceiver);
     void setRoutingReady();
     void setRoutingRundown();
@@ -116,15 +73,13 @@ public:
     am_Error_e getListPlugins(std::vector<std::string>& interfaces) const;
     void getInterfaceVersion(std::string& version) const;
 
-    //!< is used to pair interfaces with busnames
-    struct InterfaceNamePairs
+    struct InterfaceNamePairs //!< is used to pair interfaces with busnames
     {
-        IAmRoutingSend* routingInterface;
-        std::string busName;
+        IAmRoutingSend* routingInterface; //!< pointer to the routingInterface
+        std::string busName; //!< the busname
     };
 
-    //!< is used to store data related to handles
-    class am_handleData_c
+    class am_handleData_c //!< is used to store data related to handles
     {
     public:
         union
@@ -134,6 +89,7 @@ public:
             am_crossfaderID_t crossfaderID;
             am_connectionID_t connectionID;
         };
+
         union
         {
             am_SoundProperty_s soundPropery;
@@ -145,21 +101,14 @@ public:
 
     };
 
+    am_handleData_c returnHandleData(const am_Handle_s handle) const; //!< returns the handle data associated with a handle
+
 #ifdef UNIT_TEST //this is needed to test RoutingSender
     friend class IAmRoutingBackdoor;
 #endif
 
-    /**
-     * returns the data that belong to handles
-     * @param handle the handle
-     * @return a class holding the handle data
-     */
-    am_handleData_c returnHandleData(const am_Handle_s handle) const;
-
 private:
-
-    //!< is needed to sort the handles in the map
-    struct comparator
+    struct comparator //!< is needed to sort the handles in the map
     {
         bool operator()(const am_Handle_s& a, const am_Handle_s& b) const
         {
@@ -167,13 +116,7 @@ private:
         }
     };
 
-    /**
-     * creates a handle and adds it to the list of handles
-     * @param handleData the data that should be saves together with the handle
-     * @param type the type of handle to be created
-     * @return the handle
-     */
-    am_Handle_s createHandle(const am_handleData_c& handleData, const am_Handle_e type);
+    am_Handle_s createHandle(const am_handleData_c& handleData, const am_Handle_e type); //!< creates a handle
     void unloadLibraries(void); //!< unloads all loaded plugins
 
     typedef std::map<am_domainID_t, IAmRoutingSend*> DomainInterfaceMap; //!< maps domains to interfaces
@@ -194,7 +137,7 @@ private:
     SinkInterfaceMap mMapSinkInterface; //!< map of sinks to interfaces
     SourceInterfaceMap mMapSourceInterface; //!< map of sources to interfaces
     HandleInterfaceMap mMapHandleInterface; //!< map of handles to interfaces
-    CAmRoutingReceiver *mRoutingReceiver;
+    CAmRoutingReceiver *mpRoutingReceiver; //!< pointer to routing receiver
 };
 
 }