From e2a0e90a69365a90de02992b2f1aa57f1eb6c3ce Mon Sep 17 00:00:00 2001 From: rhaas Date: Thu, 6 Sep 2012 13:39:18 +0000 Subject: correct and expand documentation of CCTK_TraverseString by listing the possible values for selection and correcting the return type of the callback function to void rather than int. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4866 17b73243-c579-4c4c-a9d2-2d5706c11dac --- doc/ReferenceManual.pdf | Bin 923496 -> 923684 bytes doc/ReferenceManual/CCTKReference.tex | 6 ++++-- 2 files changed, 4 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/ReferenceManual.pdf b/doc/ReferenceManual.pdf index a69ac81e..1e00596b 100644 Binary files a/doc/ReferenceManual.pdf and b/doc/ReferenceManual.pdf differ diff --git a/doc/ReferenceManual/CCTKReference.tex b/doc/ReferenceManual/CCTKReference.tex index 83d79489..eff95d22 100644 --- a/doc/ReferenceManual/CCTKReference.tex +++ b/doc/ReferenceManual/CCTKReference.tex @@ -12365,7 +12365,7 @@ int err = CCTK_TraverseString(traverse_string, callback, callback_arg, \begin{Parameter} {const char * traverse\_string} List of variable and/or group names \end{Parameter} - \begin{Parameter} {int (*callback) (int idx, const char *optstring, void *callback\_arg)} + \begin{Parameter} {void (*callback) (int idx, const char *optstring, void *callback\_arg)} Routine to call for every variable and/or group found. \code{idx} is the Cactus variable index, \code{optstring} is the optional `\verb|{}|' enclosed option string after the variable name, and \code{callback\_arg} is @@ -12375,7 +12375,9 @@ int err = CCTK_TraverseString(traverse_string, callback, callback_arg, An arbitrary argument which gets passed to the callback routine \end{Parameter} \begin{Parameter} {int selection} - Decides whether group and/or variable names are accepted in the string + Decides whether group and/or variable names are accepted in the string. + Possible values are: \code{CCTK\_VAR}, \code{CCTK\_GROUP} or + \code{CCTK\_GROUP\_OR\_VAR}. \end{Parameter} \end{ParameterSection} -- cgit v1.2.3