From 9cfb0f81b5bafe7bba07443bbc5f7a40bc3cd533 Mon Sep 17 00:00:00 2001
From: wael <adminmail@firemail.cc>
Date: Mon, 13 Sep 2021 22:53:00 +0300
Subject: [PATCH] Added documentation for the function timing struct.

---
 docs/generate_docs.sh         |  2 +-
 docs/utils/time_function.h.ms | 23 +++++++++++++++++++++++
 2 files changed, 24 insertions(+), 1 deletion(-)
 create mode 100644 docs/utils/time_function.h.ms

diff --git a/docs/generate_docs.sh b/docs/generate_docs.sh
index c0d54d9..008072e 100755
--- a/docs/generate_docs.sh
+++ b/docs/generate_docs.sh
@@ -5,7 +5,7 @@
 # Prompt user at the start for what type they want.
 
 # Specify the file paths, in the order where they should be built.
-filepaths=('nodes/single_node.h.ms' 'nodes/double_node.h.ms' 'nodes/tree_node.h.ms' 'strings/strzcpy.ms' 'stack/stack.h.ms' 'linked_lists/double_linked_list.h.ms' 'linked_lists/single_linked_list.h.ms')
+filepaths=('nodes/single_node.h.ms' 'nodes/double_node.h.ms' 'nodes/tree_node.h.ms' 'strings/strzcpy.ms' 'stack/stack.h.ms' 'linked_lists/double_linked_list.h.ms' 'linked_lists/single_linked_list.h.ms' 'utils/time_function.h.ms')
 
 # Prompt the user for the option they want (pdf/html/utf8).
 echo "Please choose an output option: pdf, html or utf8."
diff --git a/docs/utils/time_function.h.ms b/docs/utils/time_function.h.ms
new file mode 100644
index 0000000..948d12c
--- /dev/null
+++ b/docs/utils/time_function.h.ms
@@ -0,0 +1,23 @@
+.DA
+
+.TL
+time_function.h
+
+.AU
+Wael Karram
+
+.AB no
+Documentation for time_function.h
+.AE
+
+.ND
+
+.PP
+This header defines a function_run_time struct, with the prepoccessor variable TIME_FUNCTION_H used as an include guard.
+.br
+Defines a single struct
+.UL function_run_time \0which
+has the fields
+.I "char *name" \0and 
+.I "double time" , 
+the former of which is used to store the function's name, and the latter is used to store the runtime measurement.