Update description of key-value tables routines to reflect fixing

of bug Cactus/1308:

rename
  Util_Table{Set,Get}FnPointer()       -->   Util_Table{Set,Get}FPointer()
  Util_Table{Set,Get}FnPointerArray()  -->   Util_Table{Set,Get}FPointerArray()

and footnote the old names as aliases, deprecated in 4.0beta13


git-svn-id: http://svn.cactuscode.org/flesh/trunk@3322 17b73243-c579-4c4c-a9d2-2d5706c11dac

1 files changed, 32 insertions, 8 deletions

diff --git a/doc/UsersGuide/FunctionReference.tex b/doc/UsersGuide/FunctionReference.tex
index 1f3a7aec..fa41bf65 100644
--- a/doc/UsersGuide/FunctionReference.tex
+++ b/doc/UsersGuide/FunctionReference.tex
@@ -7923,9 +7923,14 @@ int N_elements = Util_TableGetXxx(int handle,
                                   const char *key);
 \end{verbatim}
 where \verb|XXX| is one of
-   \verb|POINTER|, \verb|FPOINTER|\footnote{For historical reasons the
-   corresponding function is called \texttt{Util\_TableGetFnPointer}.
-   This should be changed soon.},
+   \verb|POINTER|, \verb|FPOINTER|%%%
+\footnote{%%%
+	 For backwards compatability the function
+	 {\tt Util\_TableGetFnPointer()} is also provided
+	 as an alias for {\tt Util\_TableGetFPointer()}.
+	 This is deprecated as of Cactus 4.0 beta 13.
+	 }%%%
+,
    \verb|CHAR|,
    \verb|INT|, \verb|INT2|, \verb|INT4|, \verb|INT8|,
    \verb|REAL|, \verb|REAL4|, \verb|REAL8|, \verb|REAL16|,
@@ -8076,9 +8081,14 @@ int N_elements = Util_TableGetXxxArray(int handle,
                                        const char *key);
 \end{verbatim}
 where \verb|XXX| is one of
-   \verb|POINTER|, \verb|FNPOINTER|
-        \footnote{Use \texttt{Util\_TableGetFnPointer}, for historical
-   reasons.},
+   \verb|POINTER|, \verb|FPOINTER|%%%
+\footnote{%%%
+	 For backwards compatability the function
+	 {\tt Util\_TableGetFnPointerArray()} is also provided
+	 as an alias for {\tt Util\_TableGetFPointerArray()}.
+	 This is deprecated as of Cactus 4.0 beta 13.
+	 }%%%
+,
    \verb|CHAR|,
    \verb|INT|, \verb|INT2|, \verb|INT4|, \verb|INT8|,
    \verb|REAL|, \verb|REAL4|, \verb|REAL8|, \verb|REAL16|,
@@ -9923,7 +9933,14 @@ int status = Util_TableSetXxx(int handle,
                               const char *key);
 \end{verbatim}
 where \verb|XXX| is one of
-   \verb|POINTER|, \verb|FPOINTER|,
+   \verb|POINTER|, \verb|FPOINTER|%%%
+\footnote{%%%
+	 For backwards compatability the function
+	 {\tt Util\_TableSetFnPointer()} is also provided
+	 as an alias for {\tt Util\_TableSetFPointer()}.
+	 This is deprecated as of Cactus 4.0 beta 13.
+	 }%%%
+,
    \verb|CHAR|,
    \verb|INT|, \verb|INT2|, \verb|INT4|, \verb|INT8|,
    \verb|REAL|, \verb|REAL4|, \verb|REAL8|, \verb|REAL16|,
@@ -10064,7 +10081,14 @@ int status = Util_TableSetXxxArray(int handle,
                                    const char *key);
 \end{verbatim}
 where \verb|XXX| is one of
-   \verb|POINTER|, \verb|FPOINTER|,
+   \verb|POINTER|, \verb|FPOINTER|%%%
+\footnote{%%%
+	 For backwards compatability the function
+	 {\tt Util\_TableSetFnPointerArray()} is also provided
+	 as an alias for {\tt Util\_TableSetFPointerArray()}.
+	 This is deprecated as of Cactus 4.0 beta 13.
+	 }%%%
+,
    \verb|CHAR|,
    \verb|INT|, \verb|INT2|, \verb|INT4|, \verb|INT8|,
    \verb|REAL|, \verb|REAL4|, \verb|REAL8|, \verb|REAL16|,