fix unexpected ending spaces
[src/app-framework-binder.git] / include / afb / afb-req-itf.h
index 3efb089..bc4b618 100644 (file)
@@ -46,7 +46,7 @@ struct afb_arg {
  * It records the functions to be called for the request.
  * Don't use this structure directly.
  * Use the helper functions documented below.
- */ 
+ */
 struct afb_req_itf {
        /* CAUTION: respect the order, add at the end */
 
@@ -75,7 +75,7 @@ struct afb_req_itf {
 };
 
 /*
- * Describes the request by plugins from afb-daemon
+ * Describes the request by bindings from afb-daemon
  */
 struct afb_req {
        const struct afb_req_itf *itf;  /* the interface to use */
@@ -138,7 +138,7 @@ static inline struct json_object *afb_req_json(struct afb_req req)
  * Its send the object 'obj' (can be NULL) with an
  * informationnal comment 'info (can also be NULL).
  *
- * For conveniency, the function calls 'json_object_put' for 'obj'.
+ * For convenience, the function calls 'json_object_put' for 'obj'.
  * Thus, in the case where 'obj' should remain available after
  * the function returns, the function 'json_object_get' shall be used.
  */
@@ -151,7 +151,7 @@ static inline void afb_req_success(struct afb_req req, struct json_object *obj,
  * Same as 'afb_req_success' but the 'info' is a formatting
  * string followed by arguments.
  *
- * For conveniency, the function calls 'json_object_put' for 'obj'.
+ * For convenience, the function calls 'json_object_put' for 'obj'.
  * Thus, in the case where 'obj' should remain available after
  * the function returns, the function 'json_object_get' shall be used.
  */
@@ -176,7 +176,7 @@ static inline void afb_req_success_f(struct afb_req req, struct json_object *obj
  * to call afb_req_success(NULL, info). Thus even if possible it
  * is strongly recommanded to NEVER use "success" for status.
  *
- * For conveniency, the function calls 'json_object_put' for 'obj'.
+ * For convenience, the function calls 'json_object_put' for 'obj'.
  * Thus, in the case where 'obj' should remain available after
  * the function returns, the function 'json_object_get' shall be used.
  */
@@ -189,7 +189,7 @@ static inline void afb_req_fail(struct afb_req req, const char *status, const ch
  * Same as 'afb_req_fail' but the 'info' is a formatting
  * string followed by arguments.
  *
- * For conveniency, the function calls 'json_object_put' for 'obj'.
+ * For convenience, the function calls 'json_object_put' for 'obj'.
  * Thus, in the case where 'obj' should remain available after
  * the function returns, the function 'json_object_get' shall be used.
  */
@@ -206,8 +206,8 @@ static inline void afb_req_fail_f(struct afb_req req, const char *status, const
 }
 
 /*
- * Gets the pointer stored by the plugin for the session of 'req'.
- * When the plugin has not yet recorded a pointer, NULL is returned.
+ * Gets the pointer stored by the binding for the session of 'req'.
+ * When the binding has not yet recorded a pointer, NULL is returned.
  */
 static inline void *afb_req_context_get(struct afb_req req)
 {
@@ -215,9 +215,9 @@ static inline void *afb_req_context_get(struct afb_req req)
 }
 
 /*
- * Stores for the plugin the pointer 'context' to the session of 'req'.
+ * Stores for the binding the pointer 'context' to the session of 'req'.
  * The function 'free_context' will be called when the session is closed
- * or if plugin stores an other pointer.
+ * or if binding stores an other pointer.
  */
 static inline void afb_req_context_set(struct afb_req req, void *context, void (*free_context)(void*))
 {
@@ -225,7 +225,7 @@ static inline void afb_req_context_set(struct afb_req req, void *context, void (
 }
 
 /*
- * Gets the pointer stored by the plugin for the session of 'req'.
+ * Gets the pointer stored by the binding for the session of 'req'.
  * If the stored pointer is NULL, indicating that no pointer was
  * already stored, afb_req_context creates a new context by calling
  * the function 'create_context' and stores it with the freeing function
@@ -242,7 +242,7 @@ static inline void *afb_req_context(struct afb_req req, void *(*create_context)(
 }
 
 /*
- * Frees the pointer stored by the plugin for the session of 'req'
+ * Frees the pointer stored by the binding for the session of 'req'
  * and sets it to NULL.
  *
  * Shortcut for: afb_req_context_set(req, NULL, NULL)