diff options
author | Timo Lotterbach <timo.lotterbach@bmw-carit.de> | 2012-11-29 01:09:46 -0800 |
---|---|---|
committer | Timo Lotterbach <timo.lotterbach@bmw-carit.de> | 2012-11-29 01:58:10 -0800 |
commit | ec26628bc5f5d0f87a44f84a5c3e4959899d7ac7 (patch) | |
tree | 4ce45e3a831e9ff40b42ec9411b4338d81f729ad /LayerManagerCommands | |
parent | 8254cb9a157aa458becfd865c82392a8c0f9ced4 (diff) | |
download | layer_management-ec26628bc5f5d0f87a44f84a5c3e4959899d7ac7.tar.gz |
Documentation: updated doxygen documentation
- minor improvements in reference document files
- added missing API documentation
Signed-off-by: Timo Lotterbach <timo.lotterbach@bmw-carit.de>
Diffstat (limited to 'LayerManagerCommands')
5 files changed, 5 insertions, 3 deletions
diff --git a/LayerManagerCommands/include/GetOptimizationModeCommand.h b/LayerManagerCommands/include/GetOptimizationModeCommand.h index 5e95aab..96cbeda 100644 --- a/LayerManagerCommands/include/GetOptimizationModeCommand.h +++ b/LayerManagerCommands/include/GetOptimizationModeCommand.h @@ -30,6 +30,7 @@ public: /*! * \action This command returns the current mode for the specified * optimization. + * \param[in] sender client process id that sent this command * \param[in] id id of optimization * \param[in] returnMode location to store mode of optimization on execution * \ingroup Commands diff --git a/LayerManagerCommands/include/LayerSetChromaKeyCommand.h b/LayerManagerCommands/include/LayerSetChromaKeyCommand.h index e2a95cb..9d49222 100644 --- a/LayerManagerCommands/include/LayerSetChromaKeyCommand.h +++ b/LayerManagerCommands/include/LayerSetChromaKeyCommand.h @@ -30,7 +30,7 @@ public: * \action This command sets the chroma key of a layer within the GENIVI LayerManagement * \frequency Called in order to rearrange graphical output. * \param[in] sender process id of application that sent this command - * \param[in] layer Id of the layer to set the chromakey of. + * \param[in] layerid Id of the layer to set the chromakey of. * \param[in] array array of color value which is defined in red, green, blue * \param[in] length length of array provided as argument array * \ingroup Commands diff --git a/LayerManagerCommands/include/SetOptimizationModeCommand.h b/LayerManagerCommands/include/SetOptimizationModeCommand.h index 4afb62c..9a86a1f 100644 --- a/LayerManagerCommands/include/SetOptimizationModeCommand.h +++ b/LayerManagerCommands/include/SetOptimizationModeCommand.h @@ -30,6 +30,7 @@ public: /*! * \action This command sets the mode for the specified optimization. * \frequency Infrequent. + * \param[in] sender client process id that sent this command * \param[in] id id of optimization * \param[in] mode optimization mode to set * \ingroup Commands diff --git a/LayerManagerCommands/include/SurfaceGetKeyboardFocusCommand.h b/LayerManagerCommands/include/SurfaceGetKeyboardFocusCommand.h index b64f0e6..69b1bb6 100644 --- a/LayerManagerCommands/include/SurfaceGetKeyboardFocusCommand.h +++ b/LayerManagerCommands/include/SurfaceGetKeyboardFocusCommand.h @@ -29,7 +29,7 @@ public: * \action This command returns the identifier of the surface which currently hold the keyboard focus * \frequency Whenever it is needed * \param[in] sender process id of application that sent this command - * \param[out] id id of surface + * \param[out] pSurfId id of surface * \ingroup Commands */ SurfaceGetKeyboardFocusCommand(pid_t sender, unsigned int *pSurfId) diff --git a/LayerManagerCommands/include/SurfaceSetChromaKeyCommand.h b/LayerManagerCommands/include/SurfaceSetChromaKeyCommand.h index 02fa3e4..2767b7c 100644 --- a/LayerManagerCommands/include/SurfaceSetChromaKeyCommand.h +++ b/LayerManagerCommands/include/SurfaceSetChromaKeyCommand.h @@ -30,7 +30,7 @@ public: * \action This command sets the chroma key of a surface within the GENIVI LayerManagement * \frequency Called in order to rearrange graphical output. * \param[in] sender process id of application that sent this command - * \param[in] surfaceId Id of the surface to set the chromakey of. + * \param[in] surfaceid Id of the surface to set the chromakey of. * \param[in] array array of color value which is defined in red, green, blue * \param[in] length length of array provided as argument array * \ingroup Commands |