From 52594bbf24f2ee016139e6ac5b748ad32c29a42e Mon Sep 17 00:00:00 2001 From: Romain Forlot Date: Fri, 18 May 2018 00:48:24 +0200 Subject: First doxygen! Change-Id: Ia0473294d305a49d34c60cfb076bf339c4242f76 Signed-off-by: Romain Forlot --- ctl-lib/ctl-config.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/ctl-lib/ctl-config.h b/ctl-lib/ctl-config.h index b8eca1b..e967270 100644 --- a/ctl-lib/ctl-config.h +++ b/ctl-lib/ctl-config.h @@ -94,6 +94,18 @@ int ActionLabelToIndex(CtlActionT* actions, const char* actionLabel); // ctl-config.c int CtlConfigMagicNew(); json_object* CtlConfigScan(const char *dirList, const char *prefix) ; + +/** + * @brief Return a string representing the path + filename for a given response + * object from a CtlConfigScan calls. This will only take the first result, this is + * made to avoid loading several time the same file found at differents places. + * + * The returned string has to be freed. + * + * @param apiHandle AppFW Api handle + * @param responseJ Response from a CtlConfigScan function call. + * @return char* absolute path to a file + */ char* ConfigSearch(AFB_ApiT apiHandle, json_object *responseJ); char* CtlConfigSearch(AFB_ApiT apiHandle, const char *dirList, const char *prefix) ; int CtlConfigExec(AFB_ApiT apiHandle, CtlConfigT *ctlConfig) ; -- cgit 1.2.3-korg