From d0daf4f598cf719167d86aca51c644da6b62db93 Mon Sep 17 00:00:00 2001
From: Hayden Hargreaves <hhargreaves2006@gmail.com>
Date: Tue, 14 Oct 2025 15:01:49 -0700
Subject: [PATCH] (DOC): Added some doc comments to the util class

---
 lib/util.h | 20 ++++++++++++++++++++
 syntax.md  |  7 +++++++
 2 files changed, 27 insertions(+)

diff --git a/lib/util.h b/lib/util.h
index 6a3c9ca..f773d94 100644
--- a/lib/util.h
+++ b/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
diff --git a/syntax.md b/syntax.md
index a44c791..d965dfd 100644
--- a/syntax.md
+++ b/syntax.md
@@ -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]