From ec26628bc5f5d0f87a44f84a5c3e4959899d7ac7 Mon Sep 17 00:00:00 2001 From: Timo Lotterbach Date: Thu, 29 Nov 2012 01:09:46 -0800 Subject: [PATCH] Documentation: updated doxygen documentation - minor improvements in reference document files - added missing API documentation Signed-off-by: Timo Lotterbach --- LayerManagerCommands/include/GetOptimizationModeCommand.h | 1 + LayerManagerCommands/include/LayerSetChromaKeyCommand.h | 2 +- LayerManagerCommands/include/SetOptimizationModeCommand.h | 1 + LayerManagerCommands/include/SurfaceGetKeyboardFocusCommand.h | 2 +- LayerManagerCommands/include/SurfaceSetChromaKeyCommand.h | 2 +- .../WLChromakeyExample/include/serverinfo-client-protocol.h | 2 +- LayerManagerService/include/GraphicalObject.h | 10 +++++----- LayerManagerService/include/ICommandExecutor.h | 6 ++---- LayerManagerService/include/IRenderer.h | 2 +- LayerManagerService/include/IScene.h | 4 ++++ LayerManagerService/include/Shader.h | 1 + LayerManagerService/include/ShaderProgram.h | 1 + LayerManagerService/src/InputManager.cpp | 2 +- doc/11_communications_package.dox | 8 ++++---- doc/13_implementation_notes.dox | 6 ++++-- 15 files changed, 29 insertions(+), 21 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 diff --git a/LayerManagerExamples/WLChromakeyExample/include/serverinfo-client-protocol.h b/LayerManagerExamples/WLChromakeyExample/include/serverinfo-client-protocol.h index a68358e..db8f7e0 100644 --- a/LayerManagerExamples/WLChromakeyExample/include/serverinfo-client-protocol.h +++ b/LayerManagerExamples/WLChromakeyExample/include/serverinfo-client-protocol.h @@ -36,7 +36,7 @@ struct serverinfo; extern const struct wl_interface serverinfo_interface; struct serverinfo_listener { - /** + /* * connection_id - (none) * @connection_id: (none) */ diff --git a/LayerManagerService/include/GraphicalObject.h b/LayerManagerService/include/GraphicalObject.h index 2440ed9..542c57b 100644 --- a/LayerManagerService/include/GraphicalObject.h +++ b/LayerManagerService/include/GraphicalObject.h @@ -79,9 +79,9 @@ public: /** * @brief Get chroma key values - * @param[out] The current Red Value between 0 and 255 - * @param[out] The current Green Value between 0 and 255 - * @param[out] The current Blue Value between 0 and 255 + * @param[out] red The current Red Value between 0 and 255 + * @param[out] green The current Green Value between 0 and 255 + * @param[out] blue The current Blue Value between 0 and 255 */ void getChromaKey(unsigned char& red, unsigned char& green, unsigned char& blue) const; @@ -118,13 +118,13 @@ public: /** * @brief add a client application to be notified on property changes of this graphical object. - * @param applicationHash UUID of application, as registered during ServiceConnect() in the client API + * \param[in] client handle to connected client that wants to receive notifications on changes of this object */ void addNotification(t_ilm_client_handle client); /** * @brief remove a client application from the notification list on property changes of this graphical object. - * @param applicationHash UUID of application, as registered during ServiceConnect() in the client API + * \param[in] client handle to connected client that does not want to receive notifications on changes of this object any longer */ void removeNotification(t_ilm_client_handle client); diff --git a/LayerManagerService/include/ICommandExecutor.h b/LayerManagerService/include/ICommandExecutor.h index 342f55f..59f143d 100644 --- a/LayerManagerService/include/ICommandExecutor.h +++ b/LayerManagerService/include/ICommandExecutor.h @@ -66,9 +66,6 @@ public: /** * \brief start layer management * \ingroup ServiceAPI - * \param[in] width width of screen to be used for layer management - * \param[in] height height of screen to be used for layer management - * \param[in] displayName name of screen to be used for layer management * \return TRUE: start management successful * \return FALSE: start management failed */ @@ -174,6 +171,7 @@ public: /** * \brief add application to list of currently registered applications * \ingroup ServiceAPI + * \param[in] client handle to connected client application * \param[in] applicationReference pointer to application object */ virtual void addApplicationReference(t_ilm_client_handle client, IApplicationReference* applicationReference) = 0; @@ -181,7 +179,7 @@ public: /** * \brief remove application from list of currently registered applications * \ingroup ServiceAPI - * \param[in] applicationReference pointer to application object + * \param[in] client handle to connected client application */ virtual void removeApplicationReference(t_ilm_client_handle client) = 0; diff --git a/LayerManagerService/include/IRenderer.h b/LayerManagerService/include/IRenderer.h index 4c16e79..13c16d8 100644 --- a/LayerManagerService/include/IRenderer.h +++ b/LayerManagerService/include/IRenderer.h @@ -169,7 +169,7 @@ public: * \return TRUE: id is valid and mode was returned * \return FALSE: id was invalid and/or mode was not returned */ - virtual bool getOptimizationMode(OptimizationType, OptimizationModeType *mode) = 0; + virtual bool getOptimizationMode(OptimizationType id, OptimizationModeType *mode) = 0; }; #endif /* _IRENDERER_H_ */ diff --git a/LayerManagerService/include/IScene.h b/LayerManagerService/include/IScene.h index 5296b60..0542430 100644 --- a/LayerManagerService/include/IScene.h +++ b/LayerManagerService/include/IScene.h @@ -52,6 +52,7 @@ public: * \brief Creates a new layer within the scene. * \ingroup SceneAPI * \param[in] id id of layer + * \param[in] creatorPid client process id that requested the creation of this layer * \return pointer to layer */ virtual Layer* createLayer(const uint id, int creatorPid) = 0; @@ -60,6 +61,7 @@ public: * \brief Creates a new surface within the scene. * \ingroup SceneAPI * \param[in] id id of surface + * \param[in] creatorPid client process id that requested the creation of this surface * \return pointer to surface */ virtual Surface* createSurface(const uint id, int creatorPid) = 0; @@ -68,6 +70,7 @@ public: * \brief Create a new layer group within the scene. * \ingroup SceneAPI * \param[in] id id of the layer group + * \param[in] creatorPid client process id that requested the creation of this layer group * \return pointer to layer group */ virtual LayerGroup* createLayerGroup(const uint id, int creatorPid) = 0; @@ -76,6 +79,7 @@ public: * \brief Create a new surface group within the scene. * \ingroup SceneAPI * \param[in] id id of the new surface group + * \param[in] creatorPid client process id that requested the creation of this surface group * \return pointer to surface group */ virtual SurfaceGroup* createSurfaceGroup(const uint id, int creatorPid) = 0; diff --git a/LayerManagerService/include/Shader.h b/LayerManagerService/include/Shader.h index 5936d34..5c8c074 100644 --- a/LayerManagerService/include/Shader.h +++ b/LayerManagerService/include/Shader.h @@ -84,6 +84,7 @@ public: * size, opacity, etc... * * @param uniforms Uniform values + * @param texCount texture count */ void loadCommonUniforms(const ShaderProgram::CommonUniforms& uniforms, const int texCount) const { diff --git a/LayerManagerService/include/ShaderProgram.h b/LayerManagerService/include/ShaderProgram.h index 7c8cc59..82fb32c 100644 --- a/LayerManagerService/include/ShaderProgram.h +++ b/LayerManagerService/include/ShaderProgram.h @@ -88,6 +88,7 @@ public: * size, opacity, etc... * * @param uniforms Uniform values + * @param texCount texture count */ void loadCommonUniforms(const CommonUniforms& uniforms, const int texCount) const; diff --git a/LayerManagerService/src/InputManager.cpp b/LayerManagerService/src/InputManager.cpp index d13611a..c1c15f2 100644 --- a/LayerManagerService/src/InputManager.cpp +++ b/LayerManagerService/src/InputManager.cpp @@ -125,7 +125,7 @@ bool InputManager::updateInputEventAcceptanceOn(unsigned int surfId, InputDevice /** * @brief Report keyboard event. * @param[in] state The state of the key. Can be either INPUT_STATE_PRESSED or INPUT_STATE_RELEASED - * @param[in] keyId A uniq identifier for the key being reported. See @ref. + * @param[in] keyId A uniq identifier for the key being reported. * @return The Surface to which to report the event, or NULL */ Surface * InputManager::reportKeyboardEvent(InputEventState state, long keyId) diff --git a/doc/11_communications_package.dox b/doc/11_communications_package.dox index 3dac5e7..9a1f12e 100644 --- a/doc/11_communications_package.dox +++ b/doc/11_communications_package.dox @@ -50,7 +50,7 @@ is needed to execute the command, the parameters, the type of command etc. Chang the list of layers and properties are then performed at a central point within the layermanager. -An implementation of a communication library must subclass BaseCommunicator and +An implementation of a communication library must subclass ICommunicator and implement the inherited start() and stop() methods, as well as a way to load the library dynamically at runtime. @@ -73,7 +73,7 @@ Browser, Navigation) to hide the used InterProcessCommunication scheme. \section communicationsPackageExample Example: Create the communication library “MyCommunicator” -(1) Create the class MyCommunicator, which inherits BaseCommunicator +(1) Create the class MyCommunicator, which inherits ICommunicator (2) Implement the virtual class functions @@ -105,10 +105,10 @@ void destroyMyCommunicator(MyCommunicator* pCommunicator) \section communicationsPackageReferenceImplementation Reference Implementation The LayerManagement package contains a reference -implementation for a communicator, which is based on DBUS. +implementation for a communicator, which internally can use DBUS or TCP/IP. The source code is available in the -\code /LayerManagerPlugins/Communicators/DBUSCommunicator \endcode +\code /LayerManagerPlugins/Communicators/GenericCommunicator \endcode directory. \section communicationsPackagePublicInterface Public Interface diff --git a/doc/13_implementation_notes.dox b/doc/13_implementation_notes.dox index f689b88..0a030a4 100644 --- a/doc/13_implementation_notes.dox +++ b/doc/13_implementation_notes.dox @@ -27,8 +27,10 @@ implemented. \section implementationNotesReferenceCommunicator Reference Communicator -The GENIVI reference communicator implementation depends on -\li DBUS interface. +The GENIVI reference communicator implementation depends on either +\li DBUS interface +or +\li TCP/IP sockets. \section implementationNotesOpenGLRenderer OpenGL Reference Renderer -- 2.7.4