summaryrefslogtreecommitdiff
path: root/doc/UsersGuide/ThornWriters.tex
diff options
context:
space:
mode:
authorrideout <rideout@17b73243-c579-4c4c-a9d2-2d5706c11dac>2003-03-21 11:00:58 +0000
committerrideout <rideout@17b73243-c579-4c4c-a9d2-2d5706c11dac>2003-03-21 11:00:58 +0000
commit3926fa8ee226d39a2987572f00df9491f82ce1db (patch)
treee2c33629f9b84105c83225ef2f92217e723a9051 /doc/UsersGuide/ThornWriters.tex
parent249800607f9e38a9321ff56eff2391a507bbb0fd (diff)
Changed 'Lentry' list to 'description' list, and removed []s, in
description of flesh IO routines. This looks a little different from the neighboring Lentry fields, and puts too large a space between the function name and its description, but it allows one to put line breaks into the function description, so that they don't run off the page... Put line break into argument list of OutputVarAsByMethod(). Fixes Documentation/1368. git-svn-id: http://svn.cactuscode.org/flesh/trunk@3183 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc/UsersGuide/ThornWriters.tex')
-rw-r--r--doc/UsersGuide/ThornWriters.tex18
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/UsersGuide/ThornWriters.tex b/doc/UsersGuide/ThornWriters.tex
index 2b64dca3..3bb336bd 100644
--- a/doc/UsersGuide/ThornWriters.tex
+++ b/doc/UsersGuide/ThornWriters.tex
@@ -2167,9 +2167,9 @@ different routines as IO methods (see chapter \ref{chap:io_methods}).
Application thorns can interact with the different IO methods through
the following function calls:
-\begin{Lentry}
+\begin{description}
-\item[{\tt CCTK\_OutputGH (const cGH *GH)}]
+\item {\tt CCTK\_OutputGH (const cGH *GH)}
This call loops over all registered IO methods, calling the routine
that each method has registered for {\t OutputGH}. The expected
@@ -2179,14 +2179,14 @@ routines (that is, not all methods will supply routines to output all
different types of variables) and if the method decides it is an
appropriate time to output.
-\item[{\tt CCTK\_OutputVar (const cGH *GH, const char *varname)}]
+\item {\tt CCTK\_OutputVar (const cGH *GH, const char *varname)}
Output a variable {\t varname} looping over all registered IO methods.
The output should take place if at all possible. If output goes into
a file and the appropriate file exists the data is appended, otherwise
a new file is created.
-\item[{\tt CCTK\_OutputVarAs (const cGH *GH, const char *varname, const char *alias)}]
+\item {\tt CCTK\_OutputVarAs (const cGH *GH, const char *varname, const char *alias)}
Output a variable {\t varname} looping over all registered IO methods.
The output should take place if at all possible. If output goes into
@@ -2194,17 +2194,17 @@ a file and the appropriate file exists the data is appended, otherwise
a new file is created. Uses {\t alias} as the name of the variable
for the purpose of constructing a filename.
-\item[{\tt CCTK\_OutputVarByMethod (const cGH *GH, const char *varname, const char *methodname)}]
+\item {\tt CCTK\_OutputVarByMethod (const cGH *GH, const char *varname, const char *methodname)}
Output a variable {\t varname} using the IO method {\t methodname} if
it is registered. The output should take place if at all possible. If
output goes into a file and the appropriate file exists the data is
appended, otherwise a new file is created.
-\item[{\tt CCTK\_OutputVarAsByMethod (const cGH *GH,
+\item {\tt CCTK\_OutputVarAsByMethod (const cGH *GH,
const char *varname,
- const char *methodname,
- const char *alias)}]
+ const char *methodname,\\
+ const char *alias)}
Output a variable {\t varname} using the IO method {\t methodname} if
it is registered. The output should take place if at all possible.
@@ -2212,7 +2212,7 @@ If output goes into a file and the appropriate file exists the data is
appended, otherwise a new file is created. Uses {\t alias} as the
name of the variable for the purpose of constructing a filename.
-\end{Lentry}
+\end{description}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%