Document escape_html_*()

1 files changed, 15 insertions, 0 deletions

diff --git a/src/gemini2html.c b/src/gemini2html.c
index ed2eaed..5e439db 100644
--- a/src/gemini2html.c
+++ b/src/gemini2html.c
@@ -20,8 +20,15 @@
 #include <stdio.h>
 #include <stdlib.h>
 #include <stdbool.h>
+
 #include "gemini2html.h"
 
+/* Escapes text so it can be safely inserted within HTML tags.
+ * Examples:
+ *   "5 < 6"    => "5 &lt; 6"
+ *   "6 > 5"    => "6 &gt; 5"
+ *   "me & you" => "me &amp; you"
+ */
 char* escape_html_tag(const char* unescaped, const size_t size) {
     char* escaped = malloc(4 * size + 1);
     size_t escaped_pos = 0;
@@ -46,6 +53,14 @@ char* escape_html_tag(const char* unescaped, const size_t size) {
     return escaped;
 }
 
+/* Escapes text so it can be safely inserted within HTML tags.
+ * Examples:
+ *   "5 < 6"        => "5 &lt; 6"
+ *   "6 > 5"        => "6 &gt; 5"
+ *   "me & you"     => "me &amp; you"
+ *   "i'm so high"  => "I&apos;m so high"
+ *   ""hello world" => "&quot;hello world&quot;"
+ */
 char* escape_html_attribute(const char* unescaped, const size_t size) {
     char* escaped = malloc(4 * size + 1);
     size_t escaped_pos = 0;