Added doc comments for std::debug

snowball-lang · Jan 28, 2024 · 95524f3 · 95524f3
1 parent b275937
commit 95524f3
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/stdlib/debug.sn b/stdlib/debug.sn
@@ -2,6 +2,18 @@ import std::intrinsics;
 
 /**
  * @brief An utility function to raise a debug breakpoint.
+ * @note If a debugger is not attached, this function will cause the program to crash.
+ * 
+ * ```
+ * import std::debug;
+ * 
+ * public func main() i32 {
+ *  debug::trap();
+ *  return 0;
+ * }
+ * ```
+ * 
+ * @see https://learn.microsoft.com/en-us/cpp/intrinsics/debugbreak?view=msvc-170 (It works across all platforms)
  */
 @inline
 public func trap() { intrinsics::debugbreak(); }