From 325bf97a49f9d1225a7815de8bd9c16b556d5070 Mon Sep 17 00:00:00 2001 From: Kevin Rocard Date: Thu, 18 Jul 2013 09:13:51 +0200 Subject: Wrap lines too longs and add doxygen BZ: 122982 Some lines were not compliant with the coding style. Wrap them and add doxigen. Change-Id: I5271b78b1e879a39914a4405a58d7366148b6972 Signed-off-by: Kevin Rocard Reviewed-on: http://android.intel.com:8080/119424 Reviewed-by: Centelles, Sylvain Tested-by: Barthes, FabienX Reviewed-by: cactus Tested-by: cactus --- remote-processor/RemoteCommandHandlerTemplate.h | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) (limited to 'remote-processor') diff --git a/remote-processor/RemoteCommandHandlerTemplate.h b/remote-processor/RemoteCommandHandlerTemplate.h index 6223b9c..1f5a9c0 100644 --- a/remote-processor/RemoteCommandHandlerTemplate.h +++ b/remote-processor/RemoteCommandHandlerTemplate.h @@ -7,15 +7,21 @@ template class TRemoteCommandHandlerTemplate : public IRemoteCommandHandler { public: - // Remote command execution status + /** Remote command parser execution return status */ enum CommandStatus { - EDone, - ESucceeded, - EFailed, - EShowUsage + EDone, /** Command succeded, return "Done" */ + ESucceeded, /** Command succeeded */ + EFailed, /** Command failed */ + EShowUsage /** Command failed, show usage */ }; - // Remote command parsers + /** Type of the remote command callbacks + * + * @param[in] remoteCommand contains the arguments of the received command. + * @param[out] strResult a string containing the result of the command. + * + * @return the command execution status, @see CommandStatus + */ typedef CommandStatus (CCommandParser::*RemoteCommandParser)(const IRemoteCommand& remoteCommand, std::string& strResult); private: -- cgit v1.1