bluetooth: doc: Fix gap.h Doxygen documentation

Make #defines properly Doxygen-documented, add some named groups, and add a
few missing comments to some #defines.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>