Fix random doxygen warnings and typos
authorAndrey Alekseenko <al42and@gmail.com>
Fri, 16 Oct 2020 14:16:04 +0000 (16:16 +0200)
committerAndrey Alekseenko <al42and@gmail.com>
Mon, 19 Oct 2020 12:12:23 +0000 (12:12 +0000)
commitc3734e4391a08c06986ff14de5e218a712434971
treec8227f0685c40c3569ce7fd0d2c23d5540489eb2
parent09d833d4b5c93db8be3a14110632081f76c0549f
Fix random doxygen warnings and typos

Silence annoying
"/builds/gromacs/gromacs/src/gromacs/math/vectypes.h:87: error:
gmx::BasicVector: is in library file(s), but appears in public
documentation" from source-check pipeline (appears to be false-positive
due to a forward-declaration in a random file). I was not able to come
up with a quick fix for the underlying problem in check-source, and,
from my understanding, there are plans for refactoring it soon anyway;
so I went with a suppression here.

Fix a bunch of random typos throughout the code.

Fix some unbalanced Doxygen's \{ and \}. And one widowed @}.

Fix some \copydocs (not all).

Remove a nasty non-breakable-space that was messing up block
indentation in Sphinx docs.
28 files changed:
docs/doxygen/suppressions.txt
docs/reference-manual/algorithms/free-energy-calculations.rst
src/gromacs/analysisdata/modules/average.h
src/gromacs/applied_forces/densityfitting/densityfittingforceprovider.cpp
src/gromacs/ewald/pme_gather.cu
src/gromacs/ewald/pme_gpu_internal.cpp
src/gromacs/fileio/warninp.h
src/gromacs/gpu_utils/devicebuffer.cuh
src/gromacs/gpu_utils/devicebuffer_ocl.h
src/gromacs/listed_forces/bonded.cpp
src/gromacs/math/densityfittingforce.cpp
src/gromacs/math/paddedvector.h
src/gromacs/math/vec.h
src/gromacs/mdlib/leapfrog_gpu.cu
src/gromacs/mdlib/update_constrain_gpu_impl.cu
src/gromacs/nbnxm/nbnxm_geometry.h
src/gromacs/nbnxm/nbnxm_gpu.h
src/gromacs/nbnxm/nbnxm_gpu_data_mgmt.cpp
src/gromacs/nbnxm/opencl/nbnxm_ocl_types.h
src/gromacs/restraint/restraintmdmodule.h
src/gromacs/simd/impl_reference/impl_reference_simd_double.h
src/gromacs/simd/impl_reference/impl_reference_simd_float.h
src/gromacs/simd/impl_reference/impl_reference_util_double.h
src/gromacs/simd/impl_reference/impl_reference_util_float.h
src/gromacs/simd/simd.h
src/gromacs/simd/simd_math.h
src/gromacs/simd/tests/simd_math.cpp
src/gromacs/utility/arrayref.h