From c5ff5479a5d86e03875ace2062cf52a00977bf4e Mon Sep 17 00:00:00 2001
From: Chris Cromer <chris@cromer.cl>
Date: Fri, 9 Dec 2022 23:26:37 -0300
Subject: [PATCH] document the obelisk namespace

---
 src/obelisk.cpp |  4 ++--
 src/obelisk.h   | 15 ++++++++++++++-
 2 files changed, 16 insertions(+), 3 deletions(-)

diff --git a/src/obelisk.cpp b/src/obelisk.cpp
index 8339996..de73f5b 100644
--- a/src/obelisk.cpp
+++ b/src/obelisk.cpp
@@ -8,7 +8,7 @@
 #include <limits>
 #include <memory>
 
-static int mainLoop()
+static int obelisk::mainLoop()
 {
     auto parser = std::unique_ptr<obelisk::Parser> {new obelisk::Parser()};
     std::unique_ptr<obelisk::KnowledgeBase> kb;
@@ -109,5 +109,5 @@ int main(int argc, char** argv)
         return EXIT_FAILURE;
     }*/
 
-    return mainLoop();
+    return obelisk::mainLoop();
 }
diff --git a/src/obelisk.h b/src/obelisk.h
index 47cbdd0..6c73752 100644
--- a/src/obelisk.h
+++ b/src/obelisk.h
@@ -1 +1,14 @@
-static int mainLoop();
+/**
+ * @brief The obelisk namespace contains everything needed to compile obelisk code.
+ *
+ */
+namespace obelisk
+{
+    /**
+     * @brief This is the main loop for obelisk.
+     * This loop handles lexing and parsing of obelisk source code.
+     *
+     * @return int Returns EXIT_SUCCESS or EXIT_FAILURE.
+     */
+    static int mainLoop();
+} // namespace obelisk