(DOC): Added some doc comments to the util class
This commit is contained in:
parent
39186fad50
commit
d0daf4f598
20
lib/util.h
20
lib/util.h
@ -3,8 +3,28 @@
|
||||
|
||||
#include <string>
|
||||
|
||||
/**
|
||||
* @brief Remove all white space after the content.
|
||||
*
|
||||
* @author Hayden Hargreaves (hhargreaves2006@gmail.com)
|
||||
*/
|
||||
void removeTrailingWhitespace(std::string &input);
|
||||
|
||||
/**
|
||||
* @brief Remove all white space before the content.
|
||||
*
|
||||
* @author Hayden Hargreaves (hhargreaves2006@gmail.com)
|
||||
*/
|
||||
void removeLeadingWhitespace(std::string &input);
|
||||
|
||||
/**
|
||||
* @brief Remove all white space before and after the content.
|
||||
*
|
||||
* This uses the removeTrailingWhitespace and the removeLeadingWhitespace
|
||||
* methods together on the same string.
|
||||
*
|
||||
* @author Hayden Hargreaves (hhargreaves2006@gmail.com)
|
||||
*/
|
||||
void removeWhitespace(std::string &input);
|
||||
|
||||
#endif
|
||||
|
||||
@ -36,3 +36,10 @@ this is a break, because it ends with two spaces -> <p> However <br> this is a b
|
||||
Double returns also
|
||||
|
||||
yields new paragraphs -> <p> Double returns also</p> <p> yields new paragraphs </p>
|
||||
|
||||
|
||||
*italic* -> <em>italic</em>
|
||||
**bold** -> <strong>bold</strong>
|
||||
***italic bold*** -> <strong><em>italic bold</em></strong>
|
||||
|
||||
hello **world** -> [TextClass: hello, BoldClass: world]
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user