drivers: dmic: doc: Cleanup Doxygen documentation

Fixed several comments that were not proper Doxygen ones, causing
documentation for this file to be incomplete.

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