More corrections to the function aliasing documentation.

git-svn-id: http://svn.cactuscode.org/arrangements/CactusNumerical/MoL/trunk@8 578cdeb0-5ea1-4b81-8215-5a3b8777ee0b

1 files changed, 67 insertions, 25 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 8744143..1c2898a 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -718,7 +718,7 @@ we call
 \begin{verbatim}
  call CCTK_VarIndex(lapseindex,"ADMBase::alp")
  call CCTK_VarIndex(lapserhsindex,"adm_bssn::adm_bs_salp")
- call MoLChangeToEvolved(ierr, lapseindex, lapserhsindex)
+ ierr = ierr + MoLChangeToEvolved(lapseindex, lapserhsindex)
 \end{verbatim}
 
 \noindent It is not required to tell MoL what the lapse is changing
@@ -949,12 +949,16 @@ out. Using function aliasing is the recommended method.
 
   \begin{SynopsisSection}
     \begin{Synopsis}{C}
-      CCTK\_INT ierr = MoLRegisterEvolved(CCTK\_INT EvolvedIndex, CCTK\_INT
-      RHSIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLRegisterEvolved(CCTK_INT EvolvedIndex, 
+                                   CCTK_INT RHSIndex)
+\end{verbatim}
     \end{Synopsis}
     \begin{Synopsis}{Fortran}
-      CCTK\_INT ierr = MoLRegisterEvolved(CCTK\_INT EvolvedIndex, CCTK\_INT
-      RHSIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLRegisterEvolved(CCTK_INT EvolvedIndex,
+                                   CCTK_INT RHSIndex)
+\end{verbatim}
     \end{Synopsis}
   \end{SynopsisSection}
 
@@ -1023,10 +1027,14 @@ ierr = MoLRegisterEvolved(EvolvedIndex, RHSIndex)
 
   \begin{SynopsisSection}
     \begin{Synopsis}{C}
-      CCTK\_INT ierr = MoLRegisterConstrained(CCTK\_INT ConstrainedIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLRegisterConstrained(CCTK_INT ConstrainedIndex)
+\end{verbatim}
     \end{Synopsis}
     \begin{Synopsis}{Fortran}
-      CCTK\_INT ierr = MoLRegisterConstrained(CCTK\_INT ConstrainedIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLRegisterConstrained(CCTK_INT ConstrainedIndex)
+\end{verbatim}
     \end{Synopsis}
   \end{SynopsisSection}
 
@@ -1090,10 +1098,14 @@ ierr = MoLRegisterConstrained(ConstrainedIndex)
 
   \begin{SynopsisSection}
     \begin{Synopsis}{C}
-      CCTK\_INT ierr = MoLRegisterSaveAndRestore(CCTK\_INT SandRIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLRegisterSaveAndRestore(CCTK_INT SandRIndex)
+\end{verbatim}
     \end{Synopsis}
     \begin{Synopsis}{Fortran}
-      CCTK\_INT ierr = MoLRegisterSaveAndRestore(CCTK\_INT SandRIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLRegisterSaveAndRestore(CCTK_INT SandRIndex)
+\end{verbatim}
     \end{Synopsis}
   \end{SynopsisSection}
 
@@ -1158,12 +1170,16 @@ ierr = MoLRegisterSaveAndRestore(SandRIndex)
 
   \begin{SynopsisSection}
     \begin{Synopsis}{C}
-      CCTK\_INT ierr = MoLRegisterEvolvedGroup(CCTK\_INT EvolvedIndex, CCTK\_INT
-      RHSIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLRegisterEvolvedGroup(CCTK_INT EvolvedIndex, 
+                                        CCTK_INT RHSIndex)
+\end{verbatim}
     \end{Synopsis}
     \begin{Synopsis}{Fortran}
-      CCTK\_INT ierr = MoLRegisterEvolvedGroup(CCTK\_INT EvolvedIndex, CCTK\_INT
-      RHSIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLRegisterEvolvedGroup(CCTK_INT EvolvedIndex, 
+                                        CCTK_INT RHSIndex)
+\end{verbatim}
     \end{Synopsis}
   \end{SynopsisSection}
 
@@ -1229,10 +1245,14 @@ ierr = MoLRegisterEvolvedGroup(EvolvedIndex, RHSIndex)
 
   \begin{SynopsisSection}
     \begin{Synopsis}{C}
-      CCTK\_INT ierr = MoLRegisterConstrainedGroup(CCTK\_INT ConstrainedIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLRegisterConstrainedGroup(CCTK_INT ConstrainedIndex)
+\end{verbatim}
     \end{Synopsis}
     \begin{Synopsis}{Fortran}
-      CCTK\_INT ierr = MoLRegisterConstrainedGroup(CCTK\_INT ConstrainedIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLRegisterConstrainedGroup(CCTK_INT ConstrainedIndex)
+\end{verbatim}
     \end{Synopsis}
   \end{SynopsisSection}
 
@@ -1296,10 +1316,14 @@ ierr = MoLRegisterConstrainedGroup(ConstrainedIndex)
 
   \begin{SynopsisSection}
     \begin{Synopsis}{C}
-      CCTK\_INT ierr = MoLRegisterSaveAndRestoreGroup(CCTK\_INT SandRIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLRegisterSaveAndRestoreGroup(CCTK_INT SandRIndex)
+\end{verbatim}
     \end{Synopsis}
     \begin{Synopsis}{Fortran}
-      CCTK\_INT ierr = MoLRegisterSaveAndRestoreGroup(CCTK\_INT SandRIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLRegisterSaveAndRestoreGroup(CCTK_INT SandRIndex)
+\end{verbatim}
     \end{Synopsis}
   \end{SynopsisSection}
 
@@ -1361,10 +1385,16 @@ ierr = MoLRegisterSaveAndRestoreGroup(SandRIndex)
 
   \begin{SynopsisSection}
     \begin{Synopsis}{C}
-      CCTK\_INT ierr = MoLChangeToEvolved(CCTK\_INT EvolvedIndex, CCTK\_INT RHSIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLChangeToEvolved(CCTK_INT EvolvedIndex, 
+                                   CCTK_INT RHSIndex)
+\end{verbatim}
     \end{Synopsis}
     \begin{Synopsis}{Fortran}
-      CCTK\_INT ierr = MoLChangeToEvolved(CCTK\_INT EvolvedIndex, CCTK\_INT RHSIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLChangeToEvolved(CCTK_INT EvolvedIndex, 
+                                   CCTK_INT RHSIndex)
+\end{verbatim}
     \end{Synopsis}
   \end{SynopsisSection}
 
@@ -1437,10 +1467,14 @@ ierr = MoLChangeToEvolved(EvolvedIndex, RHSIndex)
 
   \begin{SynopsisSection}
     \begin{Synopsis}{C}
-      CCTK\_INT ierr = MoLChangeToConstrained(CCTK\_INT EvolvedIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLChangeToConstrained(CCTK_INT EvolvedIndex)
+\end{verbatim}
     \end{Synopsis}
     \begin{Synopsis}{Fortran}
-      CCTK\_INT ierr = MoLChangeToConstrained(CCTK\_INT EvolvedIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLChangeToConstrained(CCTK_INT EvolvedIndex)
+\end{verbatim}
     \end{Synopsis}
   \end{SynopsisSection}
 
@@ -1508,10 +1542,14 @@ ierr = MoLChangeToConstrained(EvolvedIndex)
 
   \begin{SynopsisSection}
     \begin{Synopsis}{C}
-      CCTK\_INT ierr = MoLChangeToSaveAndRestore(CCTK\_INT SandRIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLChangeToSaveAndRestore(CCTK_INT SandRIndex)      
+\end{verbatim}
     \end{Synopsis}
     \begin{Synopsis}{Fortran}
-      CCTK\_INT ierr = MoLChangeToSaveAndRestore(CCTK\_INT SandRIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLChangeToSaveAndRestore(CCTK_INT SandRIndex)    
+\end{verbatim}
     \end{Synopsis}
   \end{SynopsisSection}
 
@@ -1579,10 +1617,14 @@ ierr = MoLChangeToSaveAndRestore(SandRIndex)
 
   \begin{SynopsisSection}
     \begin{Synopsis}{C}
-      CCTK\_INT ierr = MoLChangeToNone(CCTK\_INT RemoveIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLChangeToNone(CCTK_INT RemoveIndex)
+\end{verbatim}
     \end{Synopsis}
     \begin{Synopsis}{Fortran}
-      CCTK\_INT ierr = MoLChangeToNone(CCTK\_INT RemoveIndex)
+\begin{verbatim}
+CCTK_INT ierr = MoLChangeToNone(CCTK_INT RemoveIndex)
+\end{verbatim}
     \end{Synopsis}
   \end{SynopsisSection}