Jholsenback: 1 revision: Reference Migration Initial Load

2012-03-15T19:05:21Z

1 revision: Reference Migration Initial Load

Jholsenback: 1 revision: Initial Load (TF)

2012-03-11T22:31:17Z

1 revision: Initial Load (TF)

New page

[[Category:Include Files]]
This file contains a set of macros designed to make debugging easier. It also functions like the old debug.inc, with the exception that you have to call the <code>Debug_Inc_Stack()</code> macro to get the include stack output.

<code>Debug_Inc_Stack()</code>: Activates include file tracking, each included file will send a debug message when it is included.
Parameters:
<ul>
<li>None.</li>
</ul>

<code>Set_Debug(Bool)</code>: Activate or deactivate the debugging macros.
Parameters:
<ul>
<li><code>Bool</code> = A boolean (true/false) value.</li>
</ul>

<code>Debug_Message(Str)</code>: If debugging, sends the message to the debug stream.
Parameters:
<ul>
<li><code>Str</code> = The desired message.</li>
</ul>
{{#indexentry:debug, debug.inc}}
{{#indexentry:warning, debug.inc}}
{{#indexentry:error, debug.inc}}

<code>Debug(Condition, Message)</code>: Sends a message to the <code>#debug</code> stream depending on a given condition.
Parameters:
<ul>
<li><code>Condition</code> = Any boolean expression.</li>
<li><code>Message</code> = The message to be sent if Condition evaluates as true.</li>
</ul>

<code>Warning(Condition, Message)</code>: Sends a message to the <code>#warning</code> stream depending on a given condition.
Parameters:
<ul>
<li><code>Condition</code> = Any boolean expression.</li>
<li><code>Message</code> = The message to be sent if Condition evaluates as true.</li>
</ul>

<code>Error(Condition, Message)</code>: Sends a message to the <code>#error</code> stream depending on a given condition.
Parameters:
<ul>
<li><code>Condition</code> = Any boolean expression.</li>
<li><code>Message</code> = The message to be sent if Condition evaluates as true.</li>
</ul>

← Older revision	Revision as of 19:05, 15 March 2012
(No difference)

Reference:Debug.inc - Revision history

Jholsenback: 1 revision: Reference Migration Initial Load

Jholsenback: 1 revision: Initial Load (TF)