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>

1 files changed, 46 insertions, 18 deletions

diff --git a/test/test-platform/TestPlatform.h b/test/test-platform/TestPlatform.h
index 47f81f8..a415a85 100644
--- a/test/test-platform/TestPlatform.h
+++ b/test/test-platform/TestPlatform.h
@@ -38,6 +38,7 @@ class ISelectionCriterionInterface;
 class CTestPlatform
 {
     typedef TRemoteCommandHandlerTemplate<CTestPlatform> CCommandHandler;
+    typedef CCommandHandler::CommandStatus CommandReturn;
 public:
     CTestPlatform(const string &strclass, int iPortNumber);
     virtual ~CTestPlatform();
@@ -48,34 +49,61 @@ public:
 private:
     //////////////// Remote command parsers
     /// Selection Criterion
-    CCommandHandler::CommandStatus createExclusiveSelectionCriterionFromStateListCommandProcess(const IRemoteCommand& remoteCommand, string& strResult);
-    CCommandHandler::CommandStatus createInclusiveSelectionCriterionFromStateListCommandProcess(const IRemoteCommand& remoteCommand, string& strResult);
+    CommandReturn createExclusiveSelectionCriterionFromStateList(
+            const IRemoteCommand& remoteCommand, string& strResult);
+    CommandReturn createInclusiveSelectionCriterionFromStateList(
+            const IRemoteCommand& remoteCommand, string& strResult);
 
-    CCommandHandler::CommandStatus createExclusiveSelectionCriterionCommandProcess(const IRemoteCommand& remoteCommand, string& strResult);
-    CCommandHandler::CommandStatus createInclusiveSelectionCriterionCommandProcess(const IRemoteCommand& remoteCommand, string& strResult);
-    CCommandHandler::CommandStatus startParameterMgrCommandProcess(const IRemoteCommand& remoteCommand, string& strResult);
-    CCommandHandler::CommandStatus setCriterionStateCommandProcess(const IRemoteCommand& remoteCommand, string& strResult);
-    CCommandHandler::CommandStatus applyConfigurationsCommandProcess(const IRemoteCommand& remoteCommand, string& strResult);
+    CommandReturn createExclusiveSelectionCriterion(
+            const IRemoteCommand& remoteCommand, string& strResult);
+    CommandReturn createInclusiveSelectionCriterion(
+            const IRemoteCommand& remoteCommand, string& strResult);
 
-    /** Callback to set if the PFW start should fail in case of missing subsystems.
+    /** Callback to set a criterion's value, see ISelectionCriterionInterface::setCriterionState.
+     * @see CCommandHandler::RemoteCommandParser for detail on each arguments and return
+     *
+     * @param[in] remoteCommand the first argument should be the name of the criterion to set.
+     *                          if the criterion is provided in lexical space,
+     *                              the folowing arguments should be criterion new values
+     *                          if the criterion is provided in numerical space,
+     *                              the second argument should be the criterion new value
+     */
+    CommandReturn setCriterionState(
+            const IRemoteCommand& remoteCommand, string& strResult);
+
+    /** Callback to start the PFW, see CParameterMgrPlatformConnector::start.
+     * @see CCommandHandler::RemoteCommandParser for detail on each arguments and return
      *
-     * @param[in] remoteCommand contains the arguments of the received command.
-     * @param[out] strResult a string containing the result of the command.
+     * @param[in] remoteCommand is ignored
+     */
+    CommandReturn startParameterMgr(
+            const IRemoteCommand& remoteCommand, string& strResult);
+
+    /** Callback to apply PFW configuration, see CParameterMgrPlatformConnector::applyConfiguration.
+     * @see CCommandHandler::RemoteCommandParser for detail on each arguments and return
+     *
+     * @param[in] remoteCommand is ignored
+     *
+     * @return EDone (never fails)
+     */
+    CommandReturn applyConfigurations(
+            const IRemoteCommand& remoteCommand, string& strResult);
+
+    /** Callback to set if the PFW start should fail in case of missing subsystems.
+     * @see CCommandHandler::RemoteCommandParser for detail on each arguments and return
      *
-     * @return CCommandHandler::ESucceeded if command succeeded
-     *         or CCommandHandler::EFailed otherwise
+     * @param[in] remoteCommand the first argument should be ether "on" or "off".
      */
-    CCommandHandler::CommandStatus setFailureOnMissingSubsystemCommandProcess(
+    CommandReturn setFailureOnMissingSubsystem(
             const IRemoteCommand& remoteCommand, string& strResult);
     /** Callback to get if the PFW start should fail in case of missing subsystems.
+     * @see CCommandHandler::RemoteCommandParser for detail on each arguments and return
      *
-     * @param[in] remoteCommand contains the arguments of the received command.
-     * @param[out] strResult a string containing the result of the command.
+     * @param[in] remoteCommand is ignored
      *
-     * @return CCommandHandler::ESucceeded if command succeeded
-     *         or CCommandHandler::EFailed otherwise
+     * @return EDone (never fails)
      */
-    CCommandHandler::CommandStatus getFailureOnMissingSubsystemCommandProcess(
+    CommandReturn getFailureOnMissingSubsystem(
             const IRemoteCommand& remoteCommand, string& strResult);
 
     // Commands