improve ::halt documentation using yard syntax