aboutsummaryrefslogtreecommitdiffstats
path: root/include/Runtime.h
diff options
context:
space:
mode:
authorMarcos Magueta <maguetamarcos@gmail.com>2026-05-08 22:57:05 -0300
committerMarcos Magueta <maguetamarcos@gmail.com>2026-05-08 22:57:05 -0300
commit0657d6815943b5350bf4a596cd826f7a9de14a90 (patch)
tree53d4fbd03731e483f1bd83a58beab64a330c7f1d /include/Runtime.h
parentbe67e04f498f02c601788f2e23913827d2aa3c21 (diff)
downloadRNT-0657d6815943b5350bf4a596cd826f7a9de14a90.tar.gz
RNT-0657d6815943b5350bf4a596cd826f7a9de14a90.zip
port docs to doxygen
Diffstat (limited to '')
-rw-r--r--include/Runtime.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/include/Runtime.h b/include/Runtime.h
index 60a0b90..aeac136 100644
--- a/include/Runtime.h
+++ b/include/Runtime.h
@@ -2,12 +2,24 @@
#include "Api.h"
+/**
+ * @file Runtime.h
+ * @brief Declares the top-level Relational NT runtime facade.
+ */
+
namespace nt
{
+ /** @brief Top-level runtime object used by applications and the console entry point. */
class NT_API NT
{
public:
+ /**
+ * @brief Reports whether the runtime is active.
+ * @return True when the runtime is running.
+ */
bool IsRunning() const;
+
+ /** @brief Simulates an external entry call into the runtime. */
void SimulateEntryCall();
};
}