Don't mention Err_error in docs

Project: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/commit/127a7e61
Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/127a7e61
Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/127a7e61

Branch: refs/heads/master
Commit: 127a7e61aac27629d271c4a9b3e80c99376956ad
Parents: a6ba92a
Author: Nick Wellnhofer <[email protected]>
Authored: Tue Dec 23 21:41:50 2014 +0100
Committer: Nick Wellnhofer <[email protected]>
Committed: Wed Dec 24 16:02:04 2014 +0100

----------------------------------------------------------------------
 runtime/perl/xs/XSBind.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/127a7e61/runtime/perl/xs/XSBind.h
----------------------------------------------------------------------
diff --git a/runtime/perl/xs/XSBind.h b/runtime/perl/xs/XSBind.h
index 5259f80..5e6c096 100644
--- a/runtime/perl/xs/XSBind.h
+++ b/runtime/perl/xs/XSBind.h
@@ -182,8 +182,8 @@ cfish_XSBind_enable_overload(void *pobj);
  *     keylen -- The length of the parameter name in bytes.
  *     required -- A boolean indicating whether the parameter is required.
  *
- * If a required parameter is not present, allot_params() will set Err_error
- * and return false.
+ * If a required parameter is not present, allot_params() will set the global
+ * error object and return false.
  *
  * Use the following macro if a Clownfish object is desired:
  *
@@ -200,14 +200,14 @@ cfish_XSBind_enable_overload(void *pobj);
  *
  * All possible valid param names must be passed via the ALLOT_ macros; if a
  * user-supplied param cannot be matched up with an ALLOT_ macro,
- * allot_params() will set Err_error and return false.
+ * allot_params() will set the global error object and return false.
  *
  * @param stack The Perl stack.
  * @param start Where on the Perl stack to start looking for params.  For
  * methods, this would typically be 1; for functions, most likely 0.
  * @param num_stack_elems The number of arguments passed to the Perl function
  * (generally, the XS variable "items").
- * @return true on success, false on failure (sets Err_error).
+ * @return true on success, false on failure (sets the global error object).
  */
 CFISH_VISIBLE bool
 cfish_XSBind_allot_params(SV** stack, int32_t start,

Reply via email to