Change some comments to add TBD things

- Change some comments from TODO to TDB.
- Remove 'JAI' from warning messages.

Change-Id: Ib2c39d4e0f0ca34929237ab8ca3d66c9c0d269d0
Signed-off-by: Jonathan Aillet <jonathan.aillet@iot.bzh>

7 files changed, 22 insertions, 19 deletions

diff --git a/4a-hal/4a-hal-controllers/4a-hal-controllers-api-loader.c b/4a-hal/4a-hal-controllers/4a-hal-controllers-api-loader.c
index 15077d8..e634521 100644
--- a/4a-hal/4a-hal-controllers/4a-hal-controllers-api-loader.c
+++ b/4a-hal/4a-hal-controllers/4a-hal-controllers-api-loader.c
@@ -66,7 +66,7 @@ static struct HalUtlApiVerb CtlHalDynApiStaticVerbs[] =
 
 /*******************************************************************************
  *		Dynamic API functions for app controller		       *
- *		TODO JAI : Use API-V3 instead of API-PRE-V3		       *
+ *		TBD JAI : Use API-V3 instead of API-PRE-V3		       *
  ******************************************************************************/
 
 static int HalCtlsInitOneApi(AFB_ApiT apiHandle)
@@ -110,7 +110,7 @@ static int HalCtlsInitOneApi(AFB_ApiT apiHandle)
 	else
 		currentCtlHalData->status = HAL_STATUS_UNAVAILABLE;
 
-	// TODO JAI: handle refresh of hal status using /dev/snd/byId (or /dev/snd/byId)
+	// TBD JAI: handle refresh of hal status for dynamic card (/dev/by-id)
 
 	return CtlConfigExec(apiHandle, ctrlConfig);
 }
diff --git a/4a-hal/4a-hal-manager/4a-hal-manager-cb.c b/4a-hal/4a-hal-manager/4a-hal-manager-cb.c
index 41517f6..e4dc56c 100644
--- a/4a-hal/4a-hal-manager/4a-hal-manager-cb.c
+++ b/4a-hal/4a-hal-manager/4a-hal-manager-cb.c
@@ -32,15 +32,15 @@
  *		HAL Manager event handler function			       *
  ******************************************************************************/
 
-// TODO JAI : to implement
+// TBD JAI : to implement
 void HalMgrDispatchApiEvent(AFB_ApiT apiHandle, const char *evtLabel, json_object *eventJ)
 {
-	AFB_ApiWarning(apiHandle, "JAI :%s not implemented yet", __func__);
+	AFB_ApiWarning(apiHandle, "%s not implemented yet", __func__);
 	// Use "4a-hal-manager-events.h" to handle events
 }
 
 /*******************************************************************************
- *	TODO JAI : Present for test, delete this function when validated       *
+ *	TBD JAI : Present for test, delete this function when validated        *
  ******************************************************************************/
 
 void HalMgrPing(AFB_ReqT request)
@@ -50,9 +50,9 @@ void HalMgrPing(AFB_ReqT request)
 	count++;
 
 	if(request->dynapi)
-		AFB_ReqNotice(request, "JAI :%s (%s): ping count = %d", request->api, request->dynapi->apiname, count);
+		AFB_ReqNotice(request, "%s (%s): ping count = %d", request->api, request->dynapi->apiname, count);
 	else
-		AFB_ReqNotice(request, "JAI: %s: ping count = %d", request->api, count);
+		AFB_ReqNotice(request, "%s: ping count = %d", request->api, count);
 
 	AFB_ReqSucess(request, json_object_new_int(count), NULL);
 
@@ -184,7 +184,7 @@ void HalMgrLoad(AFB_ReqT request)
 		return;
 	}
 
-	// TODO JAI: try connect to the api to test if it really exists
+	// TBD JAI: try connect to the api to test if it really exists
 
 	addedHal = HalUtlAddHalApiToHalList(HalMgrGlobalData);
 
@@ -206,7 +206,7 @@ void HalMgrLoad(AFB_ReqT request)
 	if(date)
 		addedHal->date = strdup(date);
 
-	// TODO JAI: add subscription to this api status events
+	// TBD JAI: add subscription to this api status events
 
 	AFB_ReqSucess(request, NULL, "Api successfully registered");
 }
@@ -260,23 +260,23 @@ void HalMgrUnload(AFB_ReqT request)
 		return;
 	}
 
-	// TODO JAI: remove subscription to this api status events
+	// TBD JAI: remove subscription to this api status events
 
 	AFB_ReqSucess(request, NULL, "Api successfully unregistered");
 }
 
-// TODO JAI : to implement
+// TBD JAI : to implement
 void HalMgrSubscribeEvent(AFB_ReqT request)
 {
-	AFB_ReqWarning(request, "JAI :%s not implemented yet", __func__);
+	AFB_ReqWarning(request, "%s not implemented yet", __func__);
 
 	AFB_ReqSucess(request, json_object_new_boolean(false), NULL);
 }
 
-// TODO JAI : to implement
+// TBD JAI : to implement
 void HalMgrUnsubscribeEvent(AFB_ReqT request)
 {
-	AFB_ReqWarning(request, "JAI :%s not implemented yet", __func__);
+	AFB_ReqWarning(request, "%s not implemented yet", __func__);
 
 	AFB_ReqSucess(request, json_object_new_boolean(false), NULL);
 }
\ No newline at end of file
diff --git a/4a-hal/4a-hal-manager/4a-hal-manager-events.c b/4a-hal/4a-hal-manager/4a-hal-manager-events.c
index 7c1fd65..a2bbe33 100644
--- a/4a-hal/4a-hal-manager/4a-hal-manager-events.c
+++ b/4a-hal/4a-hal-manager/4a-hal-manager-events.c
@@ -26,4 +26,4 @@
 #include "../4a-hal-utilities/4a-hal-utilities-data.h"
 #include "4a-hal-manager-events.h"
 
-// TODO JAI: implement events handlers functions
\ No newline at end of file
+// TBD JAI: implement events handlers functions
\ No newline at end of file
diff --git a/4a-hal/4a-hal-manager/4a-hal-manager-events.h b/4a-hal/4a-hal-manager/4a-hal-manager-events.h
index e1c84c6..30034cf 100644
--- a/4a-hal/4a-hal-manager/4a-hal-manager-events.h
+++ b/4a-hal/4a-hal-manager/4a-hal-manager-events.h
@@ -22,6 +22,6 @@
 
 #include <afb-definitions.h>
 
-// TODO JAI: declare events handlers functions
+// TBD JAI: declare events handlers functions
 
 #endif /* _HALMGR_EVENTS_INCLUDE_ */
\ No newline at end of file
diff --git a/4a-hal/4a-hal-manager/4a-hal-manager.c b/4a-hal/4a-hal-manager/4a-hal-manager.c
index 8df5365..df35d12 100644
--- a/4a-hal/4a-hal-manager/4a-hal-manager.c
+++ b/4a-hal/4a-hal-manager/4a-hal-manager.c
@@ -50,7 +50,7 @@ struct HalUtlApiVerb HalManagerApiStaticVerbs[] =
 
 /*******************************************************************************
  *		Dynamic API functions for hal manager			       *
- *		TODO JAI : Use API-V3 instead of API-PRE-V3		       *
+ *		TBD JAI : Use API-V3 instead of API-PRE-V3		       *
  ******************************************************************************/
 
 static int HalMgrInitApi(AFB_ApiT apiHandle)
@@ -114,7 +114,7 @@ int HalMgrCreateApi(AFB_ApiT apiHandle, struct HalMgrData *HalMgrGlobalData)
 
 /*******************************************************************************
  *		Startup function					       *
- *		TODO JAI : Use API-V3 instead of API-PRE-V3		       *
+ *		TBD JAI : Use API-V3 instead of API-PRE-V3		       *
  ******************************************************************************/
 
 int afbBindingVdyn(AFB_ApiT apiHandle)
diff --git a/4a-hal/4a-hal-utilities/4a-hal-utilities-data.h b/4a-hal/4a-hal-utilities/4a-hal-utilities-data.h
index 053be6f..b255bd8 100644
--- a/4a-hal/4a-hal-utilities/4a-hal-utilities-data.h
+++ b/4a-hal/4a-hal-utilities/4a-hal-utilities-data.h
@@ -35,16 +35,19 @@ enum HalStatus {
 	HAL_STATUS_READY=2,
 };
 
+// Structure to store stream data
 struct CtlHalStreamData {
 	char *name;
 	char *streamCardId;
 };
 
+// Structure to store stream data table
 struct CtlHalStreamsDataT {
 	struct CtlHalStreamData *data;
 	unsigned int count;
 };
 
+// Structure to store specific controller hal  data
 struct CtlHalSpecificData {
 	char *mixerApiName;
 	char *mixerVerbName;
diff --git a/4a-hal/4a-hal-utilities/4a-hal-utilities-verbs-loader.c b/4a-hal/4a-hal-utilities/4a-hal-utilities-verbs-loader.c
index 6212c05..6bc1523 100644
--- a/4a-hal/4a-hal-utilities/4a-hal-utilities-verbs-loader.c
+++ b/4a-hal/4a-hal-utilities/4a-hal-utilities-verbs-loader.c
@@ -25,7 +25,7 @@
 
 /*******************************************************************************
  *		Dynamic API common functions				       *
- *		TODO JAI : Use API-V3 instead of API-PRE-V3		       *
+ *		TBD JAI : Use API-V3 instead of API-PRE-V3		       *
  ******************************************************************************/
 
 int HalUtlLoadVerbs(AFB_ApiT apiHandle, struct HalUtlApiVerb *verbs)