BasicTypes: Rename getUTF8String(..) -> decodeUTF8String(..): Adding API doc section with reference to used algov2.1.2

1 files changed, 5 insertions, 1 deletions

diff --git a/api/direct_bt/BasicTypes.hpp b/api/direct_bt/BasicTypes.hpp
index 231d8e03..e75b537b 100644
--- a/api/direct_bt/BasicTypes.hpp
+++ b/api/direct_bt/BasicTypes.hpp
@@ -414,8 +414,12 @@ namespace direct_bt {
      * In case a non UTF-8 character has been detected,
      * the content will be cut off and the decoding loop ends.
      * </p>
+     * <p>
+     * Method utilizes a finite state machine detecting variable length UTF-8 codes.
+     * See Bjoern Hoehrmann's site <http://bjoern.hoehrmann.de/utf-8/decoder/dfa/> for details.
+     * </p>
      */
-    std::string getUTF8String(const uint8_t *buffer, const size_t buffer_size);
+    std::string decodeUTF8String(const uint8_t *buffer, const size_t buffer_size);
 
 } // namespace direct_bt