shell: doc: misc Doxygen fixes

Fixed several incorrect uses of Doxygen, in particular improper use of
/*!< ... */ syntax which is meant to document the *previous* element.

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