diff options
author | Kevin Rocard <kevinx.rocard@intel.com> | 2013-07-18 09:13:51 +0200 |
---|---|---|
committer | David Wagner <david.wagner@intel.com> | 2014-02-12 17:04:07 +0100 |
commit | 325bf97a49f9d1225a7815de8bd9c16b556d5070 (patch) | |
tree | 8689227ee0dd8942d8ddf4d8c70ce8150b5f2ff1 /remote-processor | |
parent | 2448cf71ad24cbbcbbc89cc7522c431413617692 (diff) | |
download | external_parameter-framework-325bf97a49f9d1225a7815de8bd9c16b556d5070.zip external_parameter-framework-325bf97a49f9d1225a7815de8bd9c16b556d5070.tar.gz external_parameter-framework-325bf97a49f9d1225a7815de8bd9c16b556d5070.tar.bz2 |
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 <kevinx.rocard@intel.com>
Reviewed-on: http://android.intel.com:8080/119424
Reviewed-by: Centelles, Sylvain <sylvain.centelles@intel.com>
Tested-by: Barthes, FabienX <fabienx.barthes@intel.com>
Reviewed-by: cactus <cactus@intel.com>
Tested-by: cactus <cactus@intel.com>
Diffstat (limited to 'remote-processor')
-rw-r--r-- | remote-processor/RemoteCommandHandlerTemplate.h | 18 |
1 files changed, 12 insertions, 6 deletions
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 CCommandParser> 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: |