ICODE-ADC/lammps
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update docs for Error::ARGZERO constant

Browse Source
This commit is contained in:
Axel Kohlmeyer
2025-01-31 21:53:29 -05:00
parent fdc3823969
commit 21f77a9275
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/src/Developer_notes.rst
View File

@ -270,7 +270,10 @@ There are multiple "signatures" that can be called:
- ``Error::all(FLERR, idx, "Error message")``: this is for argument - ``Error::all(FLERR, idx, "Error message")``: this is for argument
parsing where "idx" is the index (starting at 0) of the argument for a parsing where "idx" is the index (starting at 0) of the argument for a
LAMMPS command that is causing the failure (use -1 for the command LAMMPS command that is causing the failure (use -1 for the command
itself). The output may also include the last input line *before* and itself). For index 0, you need to use the constant ``Error::ARGZERO``
to work around the inability of some compilers to disambiguate between
a NULL pointer and an integer constant 0, even with an added type cast.
The output may also include the last input line *before* and
*after*, if they differ due to substituting variables. A textual *after*, if they differ due to substituting variables. A textual
indicator is pointing to the specific word that failed. Using the indicator is pointing to the specific word that failed. Using the
constant ``Error::NOPOINTER`` in place of the *idx* argument will constant ``Error::NOPOINTER`` in place of the *idx* argument will