/[dejagnu]/dejagnu/doc/ref.sgml
ViewVC logotype

Diff of /dejagnu/doc/ref.sgml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.3 by rsavoye, Thu Feb 22 05:47:34 2001 UTC revision 1.4 by rsavoye, Fri May 4 15:42:43 2001 UTC
# Line 4252  Line 4252 
4252        <listitem><para>lib/util-defs.exp</para></listitem>        <listitem><para>lib/util-defs.exp</para></listitem>
4253        <listitem><para>lib/utils.exp</para></listitem>        <listitem><para>lib/utils.exp</para></listitem>
4254        <listitem><para>lib/xsh.exp</para></listitem>        <listitem><para>lib/xsh.exp</para></listitem>
4255          <listitem><para>lib/dejagnu.exp</para></listitem>
4256      </itemizedlist>      </itemizedlist>
4257    
4258    </sect1>    </sect1>
4259    
4260  </chapter>  </chapter>
4261    
4262    <chapter id=unittesting>
4263      <title>Unit Testing</title>
4264    
4265      <sect1 id=unittestapi xreflabel="Unit Testing API">
4266        <title>Unit Testing API</title>
4267    
4268        <para>For unit testing, you can use the dejagnu.h header file. </para>
4269        
4270        <sect2 id=cunit xreflabel="C Unit Testing API">
4271        <title>C Unit Testing API</title>
4272        
4273        <para>For C code, there is a C API.</para>
4274        
4275        <sect3 id=passfunc xreflabel="pass function">
4276        <title>Pass Method</title>
4277              
4278              <para>This prints a message for a successful test
4279              completion.
4280              <parameter>msg</parameter>. This is a C char * string that
4281              is the message to be dislayed.</para>
4282    
4283              <funcsynopsis role="C">
4284              <funcdef><function>pass</function></funcdef>
4285              <paramdef><parameter>msg</parameter></paramdef>
4286              </funcsynopsis>
4287        </sect3>
4288        </sect2>
4289    
4290        <sect2 id=cppunit xreflabel="C++ Unit Testing API">
4291               <title>C++ Unit Testing API</title>
4292    
4293               <sect3 id=passmeth xreflabel="pass method">
4294               <title>Pass Method</title>
4295    
4296              <para>This prints a message for a successful test
4297              completion.
4298              <parameter>msg</parameter>. This is a C char * string that
4299              is the message to be dislayed.</para>
4300    
4301            <funcsynopsis role="C++">
4302                <funcdef><function>TestState::pass</function></funcdef>
4303                <paramdef><parameter>msg</parameter></paramdef>
4304                    </funcsynopsis>
4305            </sect3>
4306    
4307            <sect3 id=failmeth xreflabel="fail method">
4308              <title>Fail Method</title>
4309    
4310              <para>This prints a message for an unsuccessful test
4311              completion.
4312              <parameter>msg</parameter>. This is a C char * string that
4313              is the message to be dislayed.</para>
4314    
4315            <funcsynopsis role="C++">
4316                <funcdef><function>TestState::fail</function></funcdef>
4317                <paramdef><parameter>msg</parameter></paramdef>
4318                    </funcsynopsis>
4319            </sect3>
4320    
4321            <sect3 id=untestedmeth xreflabel="untested method">
4322              <title>Untested Method</title>
4323    
4324              <para>This prints a message for an test case that isn't run
4325              for some technical reason.
4326              <parameter>msg</parameter>. This is a C char * string that
4327              is the message to be dislayed.</para>
4328    
4329            <funcsynopsis role="C++">
4330                <funcdef><function>TestState::untested</function></funcdef>
4331                <paramdef><parameter>msg</parameter></paramdef>
4332                    </funcsynopsis>
4333            </sect3>
4334    
4335            <sect3 id=unresolvedmeth xreflabel="unresolved method">
4336              <title>Unresolved Method</title>
4337    
4338              <para>This prints a message for an test case that is run,
4339              but there is no clear result. These output states require a
4340              human to look over the results to determine what happened.
4341              <parameter>msg</parameter>. This is a C char * string that
4342              is the message to be dislayed.</para>
4343    
4344            <funcsynopsis role="C++">
4345                <funcdef><function>TestState::unresolved</function></funcdef>
4346                <paramdef><parameter>msg</parameter></paramdef>
4347                    </funcsynopsis>
4348            </sect3>
4349    
4350            <sect3 id=totalsmeth xreflabel="totals method">
4351              <title>Totals Method</title>
4352    
4353              <para>This prints out the total numbers of all the test
4354              state outputs.</para>
4355    
4356            <funcsynopsis role="C++">
4357                <funcdef><function>TestState::totals</function></funcdef>
4358                <paramdef><parameter></parameter></paramdef>
4359            </funcsynopsis>
4360            </sect3>
4361    
4362         </sect2>
4363    
4364       </sect1>
4365    
4366    </chapter>
4367    
4368  <!-- Keep this comment at the end of the file  <!-- Keep this comment at the end of the file
4369  Local variables:  Local variables:
4370  mode: sgml  mode: sgml

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.4

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26