diff options
| author | jthorn <jthorn@17b73243-c579-4c4c-a9d2-2d5706c11dac> | 2004-12-10 17:09:15 +0000 |
|---|---|---|
| committer | jthorn <jthorn@17b73243-c579-4c4c-a9d2-2d5706c11dac> | 2004-12-10 17:09:15 +0000 |
| commit | 8e8c9a04b5d148572cfde05039c2569436047266 (patch) | |
| tree | 82da3a5e6d0a64b45a4f14ba0dd9df1324129ceb /doc | |
| parent | 8d17544f7a0cfbbd31051c91c46643a7e9cc947b (diff) | |
add footnote describing hopefully-soon-to-be-internal function
CCTK_Warn()
in case people with existing code want to see what it is
git-svn-id: http://svn.cactuscode.org/flesh/trunk@3932 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ReferenceManual/CCTKReference.tex | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/ReferenceManual/CCTKReference.tex b/doc/ReferenceManual/CCTKReference.tex index 1625ed0f..5ebd0543 100644 --- a/doc/ReferenceManual/CCTKReference.tex +++ b/doc/ReferenceManual/CCTKReference.tex @@ -9531,8 +9531,15 @@ to \code{stderr}. \code{CCTK\_WARN(level, message)} expands to a call to an internal function which is equivalent to \verb|CCTK_VWarn()|, but without the -variable-number-of-arguments feature (so it can be used from Fortran). -The macro automatically includes details about the origin of the warning +variable-number-of-arguments feature (so it can be used from Fortran).%%% +\footnote{%%% + Some code calls this internal function directly. + For reference, the function is:\\ + \texttt{\hbox{}void CCTK\_Warn(int level,}\\ + \texttt{\hbox{}~~~~~~~~~~~~~~~int line\_number, const char* file\_name, const char* thorn\_name,}\\ + \texttt{\hbox{}~~~~~~~~~~~~~~~const char* message)} + }%%% +{} The macro automatically includes details about the origin of the warning (the thorn name, the source code file name and the line number where the macro occurs). |