Skip to content

Commit

Permalink
Begin: Update signature
Browse files Browse the repository at this point in the history
  • Loading branch information
markelog committed Apr 18, 2014
1 parent 4731f14 commit 0f1d5ed
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions entries/QUnit.begin.xml
Expand Up @@ -3,11 +3,30 @@
<entry type="method" name="QUnit.begin">
<title>QUnit.begin()</title>
<signature>
<argument name="callback" type="Function">
<desc>Callback to execute</desc>
<argument name="callback">
<desc>Callback to execute. Provides a single argument with the following property:</desc>
<type name="Function">
<argument name="details" type="Object"/>
</type>
<property name="totalTests" type="Number">
<desc>The number of total tests in the test suite</desc>
</property>
</argument>
</signature>
<desc>Register a callback to fire whenever the test suite begins.</desc>
<longdesc><code>QUnit.begin()</code> is called once before running any tests.</longdesc>
<longdesc>
<p>
<code>QUnit.begin()</code> is called once before running any tests.
</p>
</longdesc>

<example>
<desc>Get total amount of tests.</desc>
<code><![CDATA[
QUnit.done(function( details ) {
console.log( "Test amount:", details.totalTests );
});
]]></code>
</example>
<category slug="callbacks"/>
</entry>

0 comments on commit 0f1d5ed

Please sign in to comment.