Skip to content

Commit ee9ec8e

Browse files
author
Subspace subdoc generator
committed
Update docs: ad5b35d91d280efb906e50121d9db562c38426e6
1 parent ba5fd4c commit ee9ec8e

18 files changed

+3423
-3723
lines changed

index.html

Lines changed: 5 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -493,18 +493,6 @@
493493
<li>
494494
<a class="sidebar-item" href="macro.sus_dyn_concept_typed.html">sus_dyn_concept_typed</a>
495495
</li>
496-
<li>
497-
<a class="sidebar-item" href="macro.sus_panic.html">sus_panic</a>
498-
</li>
499-
<li>
500-
<a class="sidebar-item" href="macro.sus_panic_with_message.html">sus_panic_with_message</a>
501-
</li>
502-
<li>
503-
<a class="sidebar-item" href="macro.sus_unreachable.html">sus_unreachable</a>
504-
</li>
505-
<li>
506-
<a class="sidebar-item" href="macro.sus_unreachable_unchecked.html">sus_unreachable_unchecked</a>
507-
</li>
508496
</ul>
509497
</div>
510498
</nav>
@@ -582,8 +570,8 @@ <h1 class="section-header">
582570
</div>
583571
<div class="description short">
584572
<p>Checking for (e.g. <a href="macro.sus_check.html"><code>sus_check</code></a>) and handling
585-
(e.g. <a href="macro.sus_panic.html"><code>sus_panic</code></a>,
586-
<a href="macro.sus_unreachable.html"><code>sus_unreachable</code></a>) unexpected runtime
573+
(e.g. <a href="sus-panic.html"><code>sus::panic</code></a>,
574+
<a href="sus-unreachable.html"><code>sus::unreachable</code></a>) unexpected runtime
587575
conditions.</p>
588576
</div>
589577
</li>
@@ -1068,7 +1056,7 @@ <h1 class="section-header">
10681056
</div>
10691057
<div class="description short">
10701058
<p>Verifies that the input, evaluated to a <code>bool</code>, is true. Otherwise, it will
1071-
<a href="macro.sus_panic.html"><code>panic</code></a>, printing a message and terminating the program.</p>
1059+
<a href="sus-panic.html"><code>panic</code></a>, printing a message and terminating the program.</p>
10721060
</div>
10731061
</li>
10741062
<li class="section-item">
@@ -1079,7 +1067,7 @@ <h1 class="section-header">
10791067
</div>
10801068
<div class="description short">
10811069
<p>Verifies that the input <code>cond</code>, evaluated to a <code>bool</code>, is true. Otherwise,
1082-
it will <a href="macro.sus_panic.html"><code>panic</code></a>, printing a customized message, and
1070+
it will <a href="sus-panic.html"><code>panic</code></a>, printing a customized message, and
10831071
terminating the program.</p>
10841072
</div>
10851073
</li>
@@ -1156,7 +1144,7 @@ <h1 class="section-header">
11561144
</div>
11571145
</div>
11581146
<div class="description short">
1159-
<p>Check a condition in debug builds, causing a <code>sus_panic()</code> if the condition
1147+
<p>Check a condition in debug builds, causing a <code>sus::panic()</code> if the condition
11601148
fails. Nothing is checked in release builds.</p>
11611149
</div>
11621150
</li>
@@ -1182,49 +1170,6 @@ <h1 class="section-header">
11821170
in the body of the <code>DynCTyped</code> class.</p>
11831171
</div>
11841172
</li>
1185-
<li class="section-item">
1186-
<div class="overload-set item-name">
1187-
<div class="overload">
1188-
<div class="macro-signature"> <a class="macro-name" href="macro.sus_panic.html">sus_panic</a></div>
1189-
</div>
1190-
</div>
1191-
<div class="description short">
1192-
<p>Terminate the program.</p>
1193-
</div>
1194-
</li>
1195-
<li class="section-item">
1196-
<div class="overload-set item-name">
1197-
<div class="overload">
1198-
<div class="macro-signature"> <a class="macro-name" href="macro.sus_panic_with_message.html">sus_panic_with_message</a></div>
1199-
</div>
1200-
</div>
1201-
<div class="description short">
1202-
<p>Terminate the program, after printing a message.</p>
1203-
</div>
1204-
</li>
1205-
<li class="section-item">
1206-
<div class="overload-set item-name">
1207-
<div class="overload">
1208-
<div class="macro-signature"> <a class="macro-name" href="macro.sus_unreachable.html">sus_unreachable</a></div>
1209-
</div>
1210-
</div>
1211-
<div class="description short">
1212-
<p>Indicates to the developer that the location should not be reached, and
1213-
terminates the program with a <a href="macro.sus_panic.html"><code>panic</code></a>.</p>
1214-
</div>
1215-
</li>
1216-
<li class="section-item">
1217-
<div class="overload-set item-name">
1218-
<div class="overload">
1219-
<div class="macro-signature"> <a class="macro-name" href="macro.sus_unreachable_unchecked.html">sus_unreachable_unchecked</a></div>
1220-
</div>
1221-
</div>
1222-
<div class="description short">
1223-
<p>Indicates to the compiler that the location will never be reached, allowing
1224-
it to optimize code generation accordingly. If this function is actually
1225-
reached, Undefined Behaviour will occur.</p>
1226-
</div>
1227-
</li>
12281173
</ul>
12291174
</div>
12301175
</div>

macro.sus_check.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -321,11 +321,11 @@ <h1 class="section-header">
321321
</div>
322322
<div class="description long">
323323
<p>Verifies that the input, evaluated to a <code>bool</code>, is true. Otherwise, it will
324-
<a href="macro.sus_panic.html"><code>panic</code></a>, printing a message and terminating the program.</p>
324+
<a href="sus-panic.html"><code>panic</code></a>, printing a message and terminating the program.</p>
325325
<p>See <a href="macro.sus_check_with_message.html"><code>sus_check_with_message</code></a> to add a
326326
message to the display of the panic.</p>
327327
<p>The displayed output can be controlled by overriding the behaviour of
328-
<a href="macro.sus_panic.html"><code>sus_panic</code></a> as described there.</p>
328+
<a href="sus-panic.html"><code>sus::panic</code></a> as described there.</p>
329329

330330
</div>
331331
</div>

macro.sus_check_with_message.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -321,12 +321,12 @@ <h1 class="section-header">
321321
</div>
322322
<div class="description long">
323323
<p>Verifies that the input <code>cond</code>, evaluated to a <code>bool</code>, is true. Otherwise,
324-
it will <a href="macro.sus_panic.html"><code>panic</code></a>, printing a customized message, and
324+
it will <a href="sus-panic.html"><code>panic</code></a>, printing a customized message, and
325325
terminating the program.</p>
326326
<p>Use <a href="macro.sus_check.html"><code>sus_check</code></a> when there's nothing useful to add
327327
in the message.</p>
328328
<p>The displayed output can be controlled by overriding the behaviour of
329-
<a href="macro.sus_panic.html"><code>sus_panic</code></a> as described there. If the
329+
<a href="sus-panic.html"><code>sus::panic</code></a> as described there. If the
330330
<code>SUS_PROVIDE_PRINT_PANIC_MESSAGE_HANDLER</code> macro does not consume the <code>msg</code>,
331331
this macro will avoid instantiating it at all.</p>
332332

macro.sus_debug_check.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
<meta property="og:url" content="https://suslib.cc/macro.sus_debug_check.html"></meta>
1010
<title>sus_debug_check - Subspace</title>
1111
<meta property="og:title" content="sus_debug_check - Subspace"></meta>
12-
<meta name="description" content="Check a condition in debug builds, causing a sus_panic() if the condition fails. Nothing is checked in release builds."></meta>
13-
<meta property="og:description" content="Check a condition in debug builds, causing a sus_panic() if the condition fails. Nothing is checked in release builds."></meta>
12+
<meta name="description" content="Check a condition in debug builds, causing a sus::panic() if the condition fails. Nothing is checked in release builds."></meta>
13+
<meta property="og:description" content="Check a condition in debug builds, causing a sus::panic() if the condition fails. Nothing is checked in release builds."></meta>
1414
<script src="https://unpkg.com/lunr/lunr.js"></script>
1515
<script src="./search_db.js"></script>
1616
<script>
@@ -320,7 +320,7 @@ <h1 class="section-header">
320320
</div>
321321
</div>
322322
<div class="description long">
323-
<p>Check a condition in debug builds, causing a <code>sus_panic()</code> if the condition
323+
<p>Check a condition in debug builds, causing a <code>sus::panic()</code> if the condition
324324
fails. Nothing is checked in release builds.</p>
325325
<p>The condition must not have side effects, and should not call any functions
326326
or methods (including operator methods), as it will often not have any

0 commit comments

Comments
 (0)