summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorschnetter <schnetter@17b73243-c579-4c4c-a9d2-2d5706c11dac>2006-11-28 09:27:06 +0000
committerschnetter <schnetter@17b73243-c579-4c4c-a9d2-2d5706c11dac>2006-11-28 09:27:06 +0000
commitb02fcef07fe90a7d1964fb1afc7fc832a7307db6 (patch)
tree7084611f0d78bb51eaf82f3112be066649eea1ed /doc
parent8caf4638af85ba77f00941b0be6b1085967da12d (diff)
Update description of aliased functions
git-svn-id: http://svn.cactuscode.org/flesh/trunk@4389 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc')
-rw-r--r--doc/UsersGuide/Appendices.tex27
1 files changed, 15 insertions, 12 deletions
diff --git a/doc/UsersGuide/Appendices.tex b/doc/UsersGuide/Appendices.tex
index 82a8b86b..4dd1a9a8 100644
--- a/doc/UsersGuide/Appendices.tex
+++ b/doc/UsersGuide/Appendices.tex
@@ -459,18 +459,21 @@ the prototype must be declared with the form:
\begin{alltt}
<\var{return_type}> FUNCTION <\var{alias}>(<\var{arg1_type}> <\var{intent1}> [ARRAY] <\var{arg1}>, ...)
\end{alltt}
-The \texttt{<\var{return\_type}>} must be either \verb|void|, \verb|CCTK_INT|,
-\verb|CCTK_REAL|, or \verb|CCTK_COMPLEX|.
-The keyword \verb|SUBROUTINE| is equivalent to
-\verb|void FUNCTION|. The name of the aliased function \texttt{<\var{alias}>}
-must contain at least one uppercase and one lowercase letter and
-follow the C standard for function names. The type of each argument,
-\texttt{<\var{arg*\_type}>} must be a \verb|CCTK| type in
-\verb|INT,REAL,COMPLEX,STRING,POINTER|. The intent of each argument,
-\texttt{<\var{intent*}>} must be either \verb|IN|, \verb|OUT|, or
-\verb|INOUT|. An argument should only be modified if it is declared
-to have intent \verb|OUT| or \verb|INOUT|. If the argument is an array
-then the prefix \verb|ARRAY| should also be given.
+The \texttt{<\var{return\_type}>} must be either \verb|void|,
+\verb|CCTK_INT|, \verb|CCTK_REAL|, \verb|CCTK_COMPLEX|,
+\verb|CCTK_POINTER|, or \verb|CCTK_POINTER_TO_CONST|. The keyword
+\verb|SUBROUTINE| is equivalent to \verb|void FUNCTION|. The name of
+the aliased function \texttt{<\var{alias}>} must contain at least one
+uppercase and one lowercase letter and follow the C standard for
+function names. The type of each argument,
+\texttt{<\var{arg*\_type}>}, must be either \verb|CCTK_INT|,
+\verb|CCTK_REAL|, \verb|CCTK_COMPLEX|, \verb|CCTK_POINTER|,
+\verb|CCTK_POINTER_TO_CONST|, or \verb|STRING|. All string arguments
+must be the last arguments in the list. The intent of each argument,
+\texttt{<\var{intent*}>}, must be either \verb|IN|, \verb|OUT|, or
+\verb|INOUT|. An argument may only be modified if it is declared to
+have intent \verb|OUT| or \verb|INOUT|. If the argument is an array
+then the prefix \verb|ARRAY| must also be given.
If the argument \texttt{<\var{arg*}>} is a function pointer then the argument
itself (which will preceded by the return type) should be