diff options
Diffstat (limited to 'src/components/policy/policy_regular/doc/doxygen/components/JSONHandler/Formatters/index.txt')
| -rw-r--r-- | src/components/policy/policy_regular/doc/doxygen/components/JSONHandler/Formatters/index.txt | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/src/components/policy/policy_regular/doc/doxygen/components/JSONHandler/Formatters/index.txt b/src/components/policy/policy_regular/doc/doxygen/components/JSONHandler/Formatters/index.txt new file mode 100644 index 0000000000..9854b88d5f --- /dev/null +++ b/src/components/policy/policy_regular/doc/doxygen/components/JSONHandler/Formatters/index.txt @@ -0,0 +1,9 @@ +/*! \page components_jsonhandler_formatters Smart Objects Formatters + +In order to create JSON string representation from Smart Object or create Smart Object data structure from JSON string representation JSON Handler component has special classes called formatters. + +The interface of formatter is quite simple and defined by NsSmartDeviceLink::NsJSONHandler::Formatters::CFormatterJsonBase class. Actually it has two methods - NsSmartDeviceLink::NsJSONHandler::Formatters::CFormatterJsonBase::objToJsonValue to convert JSON string to object and NsSmartDeviceLink::NsJSONHandler::Formatters::CFormatterJsonBase::jsonValueToObj to create JSON string from object. + +Current implementation has two different implementations of NsSmartDeviceLink::NsJSONHandler::Formatters::CFormatterJsonBase class: NsSmartDeviceLink::NsJSONHandler::Formatters::CFormatterJsonALRPCv1 for ALRPC.v1 and NsSmartDeviceLink::NsJSONHandler::Formatters::CFormatterJsonALRPCv2 for ALRPC.v2. These implementations handle specifics of each format. + +*/ |