From dc63e51bd6bf71559829f61030b94c1bfdbf4401 Mon Sep 17 00:00:00 2001
From: Szczepan Zalega <szczepan@nitrokey.com>
Date: Tue, 14 Mar 2017 20:45:16 +0100
Subject: Add function comment

Signed-off-by: Szczepan Zalega <szczepan@nitrokey.com>
---
 NitrokeyManager.cc | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'NitrokeyManager.cc')

diff --git a/NitrokeyManager.cc b/NitrokeyManager.cc
index 140d4d3..12f4671 100644
--- a/NitrokeyManager.cc
+++ b/NitrokeyManager.cc
@@ -15,6 +15,13 @@ namespace nitrokey{
     std::mutex mex_dev_com;
 
 
+  /**
+   * Copies string from pointer to fixed size C-style array. Src needs to be a valid C-string - eg. ended with '\0'.
+   * Throws when source is bigger than destination.
+   * @tparam T type of destination array
+   * @param dest fixed size destination array
+   * @param src pointer to source c-style valid string
+   */
     template <typename T>
     void strcpyT(T& dest, const char* src){
 
-- 
cgit v1.2.1