diff options
| author | allen <allen@17b73243-c579-4c4c-a9d2-2d5706c11dac> | 2002-12-30 20:29:15 +0000 |
|---|---|---|
| committer | allen <allen@17b73243-c579-4c4c-a9d2-2d5706c11dac> | 2002-12-30 20:29:15 +0000 |
| commit | cf8989ac9bdf6268373fb7e756801a95e2786ebe (patch) | |
| tree | 94ae92a75bef694737639178082c658a83c46a97 /doc | |
| parent | 59e9b3bd817ef4db5908d462a9712d81a3ab0dce (diff) | |
Fixes to parameter specification
From Cactus/1337
git-svn-id: http://svn.cactuscode.org/flesh/trunk@3064 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/UsersGuide/Appendices.tex | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/doc/UsersGuide/Appendices.tex b/doc/UsersGuide/Appendices.tex index e125d0dc..b233e1ee 100644 --- a/doc/UsersGuide/Appendices.tex +++ b/doc/UsersGuide/Appendices.tex @@ -292,7 +292,7 @@ on this line.) {\t \begin{verbatim} -[EXTENDS|USES] <parameter_type> <parameter name>[[<integer]>]] "<parameter description>" +[EXTENDS|USES] <parameter_type> <parameter name>[[<integer>]] "<parameter description>" [AS <alias>] [STEERABLE=<NEVER|ALWAYS|RECOVER>] [ACCUMULATOR=<expression>] [ACCUMULATOR-BASE=<parameter-name>] { @@ -300,9 +300,10 @@ on this line.) } <default value> \end{verbatim} } -(The options {\t AS}, {\t STEERABLE}, etc. following {\t <parameter\_description>} -must all appear on one line.) Note that the beginning brace (\{) must -sit on a line by itself; the ending brace (\} must be preceded by a +Where the options {\t AS}, {\t STEERABLE}, etc. following {\t <parameter\_description>} +must all appear on one line. + Note that the beginning brace ({\t\{}) must +sit on a line by itself; the ending brace ({\t\}}) must be preceded by a carriage return. \begin{itemize} \item{} Allowed {\t parameter\_type}s are @@ -350,7 +351,10 @@ another thorn. This allows it to declare additional acceptable values. thorn, without declaring additional values, use {\t USES} instead. \item{} {\tt [integer]}, if present, specifies that this is an {\bf - array} parameter. The parameter is then a one-dimensional + array} parameter. (Note that the notation used above for the + parameter specification breaks down here, there must be + square brackets around the given integer). + The parameter is then a one-dimensional array of values of the specified type. \item{} {\t alias} allows a parameter to appear as a different name in this thorn than its original name in another thorn. The name |