Improved documentation in string_format.h

Added some doxygen code comments (including code examples) to improve the documentation for string formatting. Already tested the doxygen output locally.