Regularize nbnxm module doxygen
commita453e5fa4c268d714ef5d31d5bb2c19423f3a102
authorMark Abraham <mark.j.abraham@gmail.com>
Wed, 15 Jan 2020 17:30:23 +0000 (15 18:30 +0100)
committerMark Abraham <mark.j.abraham@gmail.com>
Fri, 17 Jan 2020 13:12:44 +0000 (17 14:12 +0100)
tree2b8a7b6eaef68ecddaa3a7c1d7db34bb676ffd6d
parent9ce8e5c8c9848b0ff4ca0ce05ef96896fa40b3eb
Regularize nbnxm module doxygen

This module will be easier to work with if all the files are
documented and all the comments precede the things that they comment.

Had to add several \internal flags to various files to ensure
things that should be internal are that way.

Change-Id: Ia08a936c23276cbea97c2e8ff47db403d3fd9185
20 files changed:
src/gromacs/nbnxm/atomdata.h
src/gromacs/nbnxm/boundingboxes.h
src/gromacs/nbnxm/constants.h
src/gromacs/nbnxm/cuda/nbnxm_cuda_types.h
src/gromacs/nbnxm/gpu_types_common.h
src/gromacs/nbnxm/grid.h
src/gromacs/nbnxm/kernels_reference/kernel_gpu_ref.h
src/gromacs/nbnxm/kernels_reference/kernel_ref.h
src/gromacs/nbnxm/nbnxm_geometry.h
src/gromacs/nbnxm/nbnxm_simd.h
src/gromacs/nbnxm/opencl/nbnxm_ocl_consts.h
src/gromacs/nbnxm/opencl/nbnxm_ocl_kernel_utils.clh
src/gromacs/nbnxm/opencl/nbnxm_ocl_types.h
src/gromacs/nbnxm/pairlist.h
src/gromacs/nbnxm/pairlist_simd_2xmm.h
src/gromacs/nbnxm/pairlist_simd_4xm.h
src/gromacs/nbnxm/pairlistparams.h
src/gromacs/nbnxm/pairlistsets.h
src/gromacs/nbnxm/pairlistwork.h
src/gromacs/nbnxm/pairsearch.h