From 525e9eaa644ca92fad23adfbb7c3119ae8b57a30 Mon Sep 17 00:00:00 2001
From: José Bollo <jose.bollo@iot.bzh>
Date: Tue, 19 Jun 2018 20:16:28 +0200
Subject: Improve documentation of api v3
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

The documentation is improved to reflect the new version.

Tune the options

Change-Id: I894c3db3bc0c10e89db66a9a51a9ad049bb8c0c4
Signed-off-by: José Bollo <jose.bollo@iot.bzh>
---
 include/afb/afb-req-x2.h | 51 ++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 49 insertions(+), 2 deletions(-)

(limited to 'include/afb/afb-req-x2.h')

diff --git a/include/afb/afb-req-x2.h b/include/afb/afb-req-x2.h
index 70ffab80..bd4bc767 100644
--- a/include/afb/afb-req-x2.h
+++ b/include/afb/afb-req-x2.h
@@ -20,6 +20,9 @@
 #include "afb-req-x2-itf.h"
 #include "afb-api-x3.h"
 
+/** @defgroup AFB_REQ
+ *  @{ */
+
 /**
  * Checks whether the request 'req' is valid or not.
  *
@@ -559,6 +562,46 @@ int afb_req_x2_subcall_sync_legacy(
 	return req->itf->legacy_subcallsync(req, api, verb, args, result);
 }
 
+/**
+ * Send associated to 'req' a message described by 'fmt' and its 'args'
+ * to the journal for the verbosity 'level'.
+ *
+ * 'file', 'line' and 'func' are indicators of position of the code in source files
+ * (see macros __FILE__, __LINE__ and __func__).
+ *
+ * 'level' is defined by syslog standard:
+ *      EMERGENCY         0        System is unusable
+ *      ALERT             1        Action must be taken immediately
+ *      CRITICAL          2        Critical conditions
+ *      ERROR             3        Error conditions
+ *      WARNING           4        Warning conditions
+ *      NOTICE            5        Normal but significant condition
+ *      INFO              6        Informational
+ *      DEBUG             7        Debug-level messages
+ *
+ * @param req the request
+ * @param level the level of the message
+ * @param file the source filename that emits the message or NULL
+ * @param line the line number in the source filename that emits the message
+ * @param func the name of the function that emits the message or NULL
+ * @param fmt the message format as for printf
+ * @param args the arguments to the format 'fmt'
+ *
+ * @see printf
+ * @see afb_req_x2_verbose
+ */
+static inline
+void afb_req_x2_vverbose(
+			struct afb_req_x2 *req,
+			int level, const char *file,
+			int line,
+			const char * func,
+			const char *fmt,
+			va_list args)
+{
+	req->itf->vverbose(req, level, file, line, func, fmt, args);
+}
+
 /**
  * Send associated to 'req' a message described by 'fmt' and following parameters
  * to the journal for the verbosity 'level'.
@@ -582,9 +625,10 @@ int afb_req_x2_subcall_sync_legacy(
  * @param line the line number in the source filename that emits the message
  * @param func the name of the function that emits the message or NULL
  * @param fmt the message format as for printf
- * @param ... the arguments of the printf
+ * @param ... the arguments of the format 'fmt'
  *
  * @see printf
+ * @see afb_req_x2_vverbose
  */
 __attribute__((format(printf, 6, 7)))
 static inline
@@ -598,7 +642,7 @@ void afb_req_x2_verbose(
 {
 	va_list args;
 	va_start(args, fmt);
-	req->itf->vverbose(req, level, file, line, func, fmt, args);
+	afb_req_x2_verbose(req, level, file, line, func, fmt, args);
 	va_end(args);
 }
 
@@ -756,3 +800,6 @@ int afb_req_x2_subcall_sync(
 {
 	return req->itf->subcallsync(req, api, verb, args, flags, object, error, info);
 }
+
+
+/** @} */
-- 
cgit 1.2.3-korg