diff options
| author |   José Bollo <jose.bollo@iot.bzh> | 2018-06-19 20:16:28 +0200 |
|---|---|---|
| committer | José Bollo <jose.bollo@iot.bzh> | 2018-06-22 09:48:48 +0200 |
| commit | 525e9eaa644ca92fad23adfbb7c3119ae8b57a30 (patch) | |
| tree | 41de59627ccc937450daf4da6488efd4f4b2f3c2 /include/afb/afb-req-x2-itf.h | |
| parent | 9e15212d26916f59fae2be6d9e618ae9b75a4f40 (diff) | |
Improve documentation of api v3
The documentation is improved to reflect the new version.
Tune the options
Change-Id: I894c3db3bc0c10e89db66a9a51a9ad049bb8c0c4
Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'include/afb/afb-req-x2-itf.h')
| -rw-r--r-- | include/afb/afb-req-x2-itf.h | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/include/afb/afb-req-x2-itf.h b/include/afb/afb-req-x2-itf.h index 9de7a214..c76329d0 100644 --- a/include/afb/afb-req-x2-itf.h +++ b/include/afb/afb-req-x2-itf.h @@ -29,6 +29,9 @@ struct afb_event_x2; struct afb_api_x3; struct afb_stored_req; +/** @addtogroup AFB_REQ + * @{ */ + /** * structure for the request */ @@ -62,15 +65,16 @@ struct afb_req_x2 }; /** - * subcall modes + * subcall flags * * When making subcalls, it is now possible to explicitely set the subcall - * mode to a combination of the following mode using binary OR. + * mode to a combination of the following flags using binary OR. * - * In particular, the following combination of modes are to be known: + * In particular, the following combination of flags are to be known: * * - for **subcall** having a similar behaviour to the subcalls of bindings * version 1 and 2: afb_req_x2_subcall_pass_events|afb_req_x2_subcall_on_behalf + * * - for **subcall** having the behaviour of the **call**: * afb_req_x2_subcall_catch_events|afb_req_x2_subcall_api_session * @@ -304,3 +308,5 @@ struct afb_req_x2_itf char **info); }; + +/** @} */ |