document the obelisk namespace

This commit is contained in:
Chris Cromer 2022-12-09 23:26:37 -03:00
parent 9e6772cb59
commit c5ff5479a5
Signed by: cromer
GPG Key ID: FA91071797BEEEC2
2 changed files with 16 additions and 3 deletions

View File

@ -8,7 +8,7 @@
#include <limits> #include <limits>
#include <memory> #include <memory>
static int mainLoop() static int obelisk::mainLoop()
{ {
auto parser = std::unique_ptr<obelisk::Parser> {new obelisk::Parser()}; auto parser = std::unique_ptr<obelisk::Parser> {new obelisk::Parser()};
std::unique_ptr<obelisk::KnowledgeBase> kb; std::unique_ptr<obelisk::KnowledgeBase> kb;
@ -109,5 +109,5 @@ int main(int argc, char** argv)
return EXIT_FAILURE; return EXIT_FAILURE;
}*/ }*/
return mainLoop(); return obelisk::mainLoop();
} }

View File

@ -1 +1,14 @@
/**
* @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(); static int mainLoop();
} // namespace obelisk