summaryrefslogtreecommitdiffstats
path: root/parameter/Subsystem.h
diff options
context:
space:
mode:
authorKevin Rocard <kevinx.rocard@intel.com>2013-04-02 19:49:40 +0200
committerDavid Wagner <david.wagner@intel.com>2014-02-12 17:03:49 +0100
commit3414f994f9d2bf971caa4abd03932529619a81ec (patch)
treeede2de5fb606125898eacff2fc0bf6b8def51694 /parameter/Subsystem.h
parent084cafba76fa5c987cdffeaaa7401202473554cb (diff)
downloadexternal_parameter-framework-3414f994f9d2bf971caa4abd03932529619a81ec.zip
external_parameter-framework-3414f994f9d2bf971caa4abd03932529619a81ec.tar.gz
external_parameter-framework-3414f994f9d2bf971caa4abd03932529619a81ec.tar.bz2
PFW: Coding style violation correction
BZ: 98166 Some code is not following the coding style. Wrap too long lines according to coding style, add doxygen annotations. Change-Id: I1c160c5f2b4bedab159baadc034042ec9956cd0e Signed-off-by: Kevin Rocard <kevinx.rocard@intel.com> Reviewed-on: http://android.intel.com:8080/99545 Reviewed-by: Gonzalve, Sebastien <sebastien.gonzalve@intel.com> Reviewed-by: cactus <cactus@intel.com> Tested-by: Dixon, CharlesX <charlesx.dixon@intel.com> Reviewed-by: buildbot <buildbot@intel.com> Tested-by: buildbot <buildbot@intel.com>
Diffstat (limited to 'parameter/Subsystem.h')
-rw-r--r--parameter/Subsystem.h14
1 files changed, 12 insertions, 2 deletions
diff --git a/parameter/Subsystem.h b/parameter/Subsystem.h
index 5a0f844..996b546 100644
--- a/parameter/Subsystem.h
+++ b/parameter/Subsystem.h
@@ -82,8 +82,18 @@ private:
// Mapping execution
bool mapSubsystemElements(string& strError);
- // Generic subsystem mapping error handling
- void getMappingError(string& strError, const string& strKey, const string& strMessage, const CInstanceConfigurableElement* pInstanceConfigurableElement);
+ /**
+ * Generic subsystem mapping error handling
+ *
+ * Format an human readable error string from a key and a message in case of mapping error
+ *
+ * @param[out] strError The formated error string
+ * @param[in] strKey The key on which the error refers
+ * @param[in] strMessage The error message
+ * @param[in] pInstanceConfigurableElement The element on wich the error refers
+ */
+ void getMappingError(string& strError, const string& strKey, const string& strMessage,
+ const CInstanceConfigurableElement* pInstanceConfigurableElement);
/**
* Handle a configurable element mapping.