synchronize comments and update formatting

This commit is contained in:
Axel Kohlmeyer
2022-11-01 06:29:58 -04:00
parent e5a808fb8d
commit f9a004c752
3 changed files with 33 additions and 23 deletions

View File

@ -36,9 +36,9 @@
#include <stdint.h> /* for int64_t */
#endif
/* The following must be kept in sync with the equivalent constants in
* python/lammps/constants.py, fortran/lammps.f90, tools/swig/lammps.i,
* and examples/COUPLE/plugin/liblammpsplugin.h */
/* The following enums must be kept in sync with the equivalent enums
* or constants in python/lammps/constants.py, fortran/lammps.f90,
* tools/swig/lammps.i, and examples/COUPLE/plugin/liblammpsplugin.h */
/* Data type constants for extracting data from atoms, computes and fixes */

View File

@ -40,8 +40,9 @@
/** Data type constants for extracting data from atoms, computes and fixes
*
* Must be kept in sync with the equivalent constants in python/lammps/constants.py,
* fortran/lammps.f90, tools/swig/lammps.i, examples/COUPLE/plugin/liblammpsplugin.h */
* Must be kept in sync with the equivalent constants in ``python/lammps/constants.py``,
* ``fortran/lammps.f90``, ``tools/swig/lammps.i``, and
*``examples/COUPLE/plugin/liblammpsplugin.h`` */
enum _LMP_DATATYPE_CONST {
LAMMPS_INT = 0, /*!< 32-bit integer (array) */
@ -55,8 +56,9 @@ enum _LMP_DATATYPE_CONST {
/** Style constants for extracting data from computes and fixes.
*
* Must be kept in sync with the equivalent constants in python/lammps/constants.py,
* fortran/lammps.f90, tools/swig/lammps.i, and examples/COUPLE/plugin/liblammpsplugin.h */
* Must be kept in sync with the equivalent constants in ``python/lammps/constants.py``,
* ``fortran/lammps.f90``, ``tools/swig/lammps.i``, and
* ``examples/COUPLE/plugin/liblammpsplugin.h`` */
enum _LMP_STYLE_CONST {
LMP_STYLE_GLOBAL = 0, /*!< return global data */
@ -66,8 +68,9 @@ enum _LMP_STYLE_CONST {
/** Type and size constants for extracting data from computes and fixes.
*
* Must be kept in sync with the equivalent constants in python/lammps/constants.py,
* fortran/lammps.f90, tools/swig/lammps.i, and examples/COUPLE/plugin/liblammpsplugin.h */
* Must be kept in sync with the equivalent constants in ``python/lammps/constants.py``,
* ``fortran/lammps.f90``, ``tools/swig/lammps.i``, and
* ``examples/COUPLE/plugin/liblammpsplugin.h`` */
enum _LMP_TYPE_CONST {
LMP_TYPE_SCALAR = 0, /*!< return scalar */
@ -80,8 +83,9 @@ enum _LMP_TYPE_CONST {
/** Error codes to select the suitable function in the Error class
*
* Must be kept in sync with the equivalent constants in python/lammps/constants.py,
* fortran/lammps.f90, tools/swig/lammps.i, and examples/COUPLE/plugin/liblammpsplugin.h */
* Must be kept in sync with the equivalent constants in ``python/lammps/constants.py``,
* ``fortran/lammps.f90``, ``tools/swig/lammps.i``, and
* ``examples/COUPLE/plugin/liblammpsplugin.h`` */
enum _LMP_ERROR_CONST {
LMP_ERROR_WARNING = 0, /*!< call Error::warning() */
@ -93,8 +97,9 @@ enum _LMP_ERROR_CONST {
/** Variable style constants for extracting data from variables.
*
* Must be kept in sync with the equivalent constants in python/lammps/constants.py,
* fortran/lammps.f90, tools/swig/lammps.i, and examples/COUPLE/plugin/liblammpsplugin.h */
* Must be kept in sync with the equivalent constants in ``python/lammps/constants.py``,
* ``fortran/lammps.f90``, ``tools/swig/lammps.i``, and
* ``examples/COUPLE/plugin/liblammpsplugin.h`` */
enum _LMP_VAR_CONST {
LMP_VAR_EQUAL = 0, /*!< compatible with equal-style variables */

View File

@ -24,8 +24,9 @@
/** Data type constants for extracting data from atoms, computes and fixes
*
* Must be kept in sync with the equivalent constants in src/library.h,
* python/lammps/constants.py, and fortran/lammps.f90 */
* Must be kept in sync with the equivalent constants in ``src/library.h``,
* ``python/lammps/constants.py``, ``examples/COUPLE/plugin/liblammpsplugin.h``,
* and ``fortran/lammps.f90`` */
enum _LMP_DATATYPE_CONST {
LAMMPS_INT = 0, /*!< 32-bit integer (array) */
@ -39,8 +40,9 @@ enum _LMP_DATATYPE_CONST {
/** Style constants for extracting data from computes and fixes.
*
* Must be kept in sync with the equivalent constants in src/library.h,
* python/lammps/constants.py, and fortran/lammps.f90 */
* Must be kept in sync with the equivalent constants in ``src/library.h``,
* ``python/lammps/constants.py``, ``examples/COUPLE/plugin/liblammpsplugin.h``,
* and ``fortran/lammps.f90`` */
enum _LMP_STYLE_CONST {
LMP_STYLE_GLOBAL = 0, /*!< return global data */
@ -50,8 +52,9 @@ enum _LMP_STYLE_CONST {
/** Type and size constants for extracting data from computes and fixes.
*
* Must be kept in sync with the equivalent constants in src/library.h,
* python/lammps/constants.py, and fortran/lammps.f90 */
* Must be kept in sync with the equivalent constants in ``src/library.h``,
* ``python/lammps/constants.py``, ``examples/COUPLE/plugin/liblammpsplugin.h``,
* and ``fortran/lammps.f90`` */
enum _LMP_TYPE_CONST {
LMP_TYPE_SCALAR = 0, /*!< return scalar */
@ -64,8 +67,9 @@ enum _LMP_TYPE_CONST {
/** Error codes to select the suitable function in the Error class
*
* Must be kept in sync with the equivalent constants in src/library.h,
* python/lammps/constants.py, and fortran/lammps.f90 */
* Must be kept in sync with the equivalent constants in ``src/library.h``,
* ``python/lammps/constants.py``, ``examples/COUPLE/plugin/liblammpsplugin.h``,
* and ``fortran/lammps.f90`` */
enum _LMP_ERROR_CONST {
LMP_ERROR_WARNING = 0, /*!< call Error::warning() */
@ -77,8 +81,9 @@ enum _LMP_ERROR_CONST {
/** Variable style constants for extracting data from variables.
*
* Must be kept in sync with the equivalent constants in src/library.h,
* python/lammps/constants.py, and fortran/lammps.f90 */
* Must be kept in sync with the equivalent constants in ``src/library.h``,
* ``python/lammps/constants.py``, ``examples/COUPLE/plugin/liblammpsplugin.h``,
* and ``fortran/lammps.f90`` */
enum _LMP_VAR_CONST {
LMP_VAR_EQUAL = 0, /*!< compatible with equal-style variables */