diff options
| -rw-r--r-- | doc/afb-bindings-writing.html | 12 | ||||
| -rw-r--r-- | doc/afb-bindings-writing.md | 12 | ||||
| -rw-r--r-- | include/afb/afb-binding.h | 2 | ||||
| -rw-r--r-- | include/afb/afb-event-itf.h | 6 | ||||
| -rw-r--r-- | include/afb/afb-req-itf.h | 8 |
5 files changed, 20 insertions, 20 deletions
diff --git a/doc/afb-bindings-writing.html b/doc/afb-bindings-writing.html index 20113a70..b32912b6 100644 --- a/doc/afb-bindings-writing.html +++ b/doc/afb-bindings-writing.html @@ -318,7 +318,7 @@ code > span.er { color: #ff0000; font-weight: bold; } <span class="co"> * Its send the object 'obj' (can be NULL) with an</span> <span class="co"> * informationnal comment 'info (can also be NULL).</span> <span class="co"> *</span> -<span class="co"> * For conveniency, the function calls 'json_object_put' for 'obj'.</span> +<span class="co"> * For convenience, the function calls 'json_object_put' for 'obj'.</span> <span class="co"> * Thus, in the case where 'obj' should remain available after</span> <span class="co"> * the function returns, the function 'json_object_get' shall be used.</span> <span class="co"> */</span> @@ -328,7 +328,7 @@ code > span.er { color: #ff0000; font-weight: bold; } <span class="co"> * Same as 'afb_req_success' but the 'info' is a formatting</span> <span class="co"> * string followed by arguments.</span> <span class="co"> *</span> -<span class="co"> * For conveniency, the function calls 'json_object_put' for 'obj'.</span> +<span class="co"> * For convenience, the function calls 'json_object_put' for 'obj'.</span> <span class="co"> * Thus, in the case where 'obj' should remain available after</span> <span class="co"> * the function returns, the function 'json_object_get' shall be used.</span> <span class="co"> */</span> @@ -343,7 +343,7 @@ code > span.er { color: #ff0000; font-weight: bold; } <span class="co"> * to call afb_req_success(NULL, info). Thus even if possible it</span> <span class="co"> * is strongly recommended to NEVER use "success" for status.</span> <span class="co"> *</span> -<span class="co"> * For conveniency, the function calls 'json_object_put' for 'obj'.</span> +<span class="co"> * For convenience, the function calls 'json_object_put' for 'obj'.</span> <span class="co"> * Thus, in the case where 'obj' should remain available after</span> <span class="co"> * the function returns, the function 'json_object_get' shall be used.</span> <span class="co"> */</span> @@ -353,13 +353,13 @@ code > span.er { color: #ff0000; font-weight: bold; } <span class="co"> * Same as 'afb_req_fail' but the 'info' is a formatting</span> <span class="co"> * string followed by arguments.</span> <span class="co"> *</span> -<span class="co"> * For conveniency, the function calls 'json_object_put' for 'obj'.</span> +<span class="co"> * For convenience, the function calls 'json_object_put' for 'obj'.</span> <span class="co"> * Thus, in the case where 'obj' should remain available after</span> <span class="co"> * the function returns, the function 'json_object_get' shall be used.</span> <span class="co"> */</span> <span class="dt">void</span> afb_req_fail_f(<span class="kw">struct</span> afb_req req, <span class="dt">const</span> <span class="dt">char</span> *status, <span class="dt">const</span> <span class="dt">char</span> *info, ...);</code></pre> <blockquote> -<p>For conveniency, these functions automatically call <strong>json_object_put</strong> to release <strong>obj</strong>. Because <strong>obj</strong> usage count is null after being passed to a reply function, it SHOULD not be used anymore. If exceptionally <strong>obj</strong> needs to remain usable after reply function then using <strong>json_object_get</strong> on <strong>obj</strong> to increase usage count and cancels the effect the <strong>json_object_put</strong> is possible.</p> +<p>For convenience, these functions automatically call <strong>json_object_put</strong> to release <strong>obj</strong>. Because <strong>obj</strong> usage count is null after being passed to a reply function, it SHOULD not be used anymore. If exceptionally <strong>obj</strong> needs to remain usable after reply function then using <strong>json_object_get</strong> on <strong>obj</strong> to increase usage count and cancels the effect the <strong>json_object_put</strong> is possible.</p> </blockquote> <h2 id="getting-argument-of-invocation">Getting argument of invocation</h2> <p>Many methods expect arguments. Afb-daemon's bindings retrieve arguments by name and not by position.</p> @@ -781,7 +781,7 @@ code > span.er { color: #ff0000; font-weight: bold; } <span class="co"> * 'object' can be NULL.</span> <span class="co"> * 'daemon' MUST be the daemon given in interface when activating the binding.</span> <span class="co"> *</span> -<span class="co"> * For conveniency, the function calls 'json_object_put' for 'object'.</span> +<span class="co"> * For convenience, the function calls 'json_object_put' for 'object'.</span> <span class="co"> * Thus, in the case where 'object' should remain available after</span> <span class="co"> * the function returns, the function 'json_object_get' shall be used.</span> <span class="co"> */</span> diff --git a/doc/afb-bindings-writing.md b/doc/afb-bindings-writing.md index 369c6d72..6327734e 100644 --- a/doc/afb-bindings-writing.md +++ b/doc/afb-bindings-writing.md @@ -471,7 +471,7 @@ It exists two functions for "success" replies: **afb_req_success** and **afb_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. */ @@ -481,7 +481,7 @@ void afb_req_success(struct afb_req req, struct json_object *obj, const char *in * 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. */ @@ -500,7 +500,7 @@ It exists two functions for "failure" replies: **afb_req_fail** and **afb_req_fa * to call afb_req_success(NULL, info). Thus even if possible it * is strongly recommended 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. */ @@ -510,14 +510,14 @@ void afb_req_fail(struct afb_req req, const char *status, const char *info); * 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. */ void afb_req_fail_f(struct afb_req req, const char *status, const char *info, ...); ``` -> For conveniency, these functions automatically call **json_object_put** to release **obj**. +> For convenience, these functions automatically call **json_object_put** to release **obj**. > Because **obj** usage count is null after being passed to a reply function, it SHOULD not be used anymore. > If exceptionally **obj** needs to remain usable after reply function then using **json_object_get** on **obj** > to increase usage count and cancels the effect the **json_object_put** is possible. @@ -977,7 +977,7 @@ Function **afb_daemon_broadcast_event** is defined here after: * 'object' can be NULL. * 'daemon' MUST be the daemon given in interface when activating the binding. * - * For conveniency, the function calls 'json_object_put' for 'object'. + * For convenience, the function calls 'json_object_put' for 'object'. * Thus, in the case where 'object' should remain available after * the function returns, the function 'json_object_get' shall be used. */ diff --git a/include/afb/afb-binding.h b/include/afb/afb-binding.h index ac63d36b..1705271d 100644 --- a/include/afb/afb-binding.h +++ b/include/afb/afb-binding.h @@ -205,7 +205,7 @@ static inline struct sd_bus *afb_daemon_get_system_bus(struct afb_daemon daemon) * 'object' can be NULL. * 'daemon' MUST be the daemon given in interface when activating the binding. * - * For conveniency, the function calls 'json_object_put' for 'object'. + * For convenience, the function calls 'json_object_put' for 'object'. * Thus, in the case where 'object' should remain available after * the function returns, the function 'json_object_get' shall be used. * diff --git a/include/afb/afb-event-itf.h b/include/afb/afb-event-itf.h index b89b9415..4c9ad473 100644 --- a/include/afb/afb-event-itf.h +++ b/include/afb/afb-event-itf.h @@ -46,7 +46,7 @@ struct afb_event { * Broadcasts widely the 'event' with the data 'object'. * 'object' can be NULL. * - * For conveniency, the function calls 'json_object_put' for 'object'. + * For convenience, the function calls 'json_object_put' for 'object'. * Thus, in the case where 'object' should remain available after * the function returns, the function 'json_object_get' shall be used. * @@ -58,10 +58,10 @@ static inline int afb_event_broadcast(struct afb_event event, struct json_object } /* - * Pushes the 'event' with the data 'object' to its obeservers. + * Pushes the 'event' with the data 'object' to its observers. * 'object' can be NULL. * - * For conveniency, the function calls 'json_object_put' for 'object'. + * For convenience, the function calls 'json_object_put' for 'object'. * Thus, in the case where 'object' should remain available after * the function returns, the function 'json_object_get' shall be used. * diff --git a/include/afb/afb-req-itf.h b/include/afb/afb-req-itf.h index af452faf..740b3ac0 100644 --- a/include/afb/afb-req-itf.h +++ b/include/afb/afb-req-itf.h @@ -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. */ |