[Mockpp-commits] mockpp/mockpp/docs/en appendix.docbook,1.20,1.21 dev_basic.docbook,1.14,1.15
Brought to you by:
ewald-arnold
Menu
▾
▴
[Mockpp-commits] mockpp/mockpp/docs/en appendix.docbook,1.20,1.21 dev_basic.docbook,1.14,1.15
|
From: Ewald A. <ewa...@us...> - 2006-01-06 12:18:23
|
Update of /cvsroot/mockpp/mockpp/mockpp/docs/en In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv13005/mockpp/docs/en Modified Files: appendix.docbook dev_basic.docbook Log Message: update docs Index: dev_basic.docbook =================================================================== RCS file: /cvsroot/mockpp/mockpp/mockpp/docs/en/dev_basic.docbook,v retrieving revision 1.14 retrieving revision 1.15 diff -u -d -r1.14 -r1.15 --- dev_basic.docbook 27 Dec 2005 18:01:44 -0000 1.14 +++ dev_basic.docbook 6 Jan 2006 12:17:34 -0000 1.15 @@ -27,15 +27,15 @@ <varlistentry> <term><methodname>setFailOnVerify()</methodname></term> - <listitem>Usually the actual value is immediately compared + <listitem><para>Usually the actual value is immediately compared when set. Sometimes you want to defer this until all the work is done. After invoking this method you must call <methodname>verify()</methodname> - manually at the end to verify all pending expectations.</listitem> + manually at the end to verify all pending expectations.</para></listitem> </varlistentry> <varlistentry> <term><methodname>setExpectNothing()</methodname></term> - <listitem>If you want to prevent the occurrence of any actual values + <listitem><para>If you want to prevent the occurrence of any actual values you should invoke this method at the beginning. <note><title>Attention</title> @@ -46,7 +46,7 @@ to compare with. </para> </note> - </listitem> + </para></listitem> </varlistentry> </variablelist> Index: appendix.docbook =================================================================== RCS file: /cvsroot/mockpp/mockpp/mockpp/docs/en/appendix.docbook,v retrieving revision 1.20 retrieving revision 1.21 diff -u -d -r1.20 -r1.21 --- appendix.docbook 5 Jan 2006 20:17:11 -0000 1.20 +++ appendix.docbook 6 Jan 2006 12:17:34 -0000 1.21 @@ -41,79 +41,79 @@ <varlistentry> <term>--enable-unicode</term> - <listitem>By default &mockpp; uses standard 8bit wide strings (<token>std::string</token> + <listitem><para>By default &mockpp; uses standard 8bit wide strings (<token>std::string</token> and <token>const char*</token> to be more precise). If you need basic support for <ulink url="http://www.unicode.org">Unicode</ulink> and it's 16bit or 32bit wide characters you must add this parameter when invoking <userinput>configure</userinput>. - </listitem> + </para></listitem> </varlistentry> <varlistentry> <term>--enable-doxygen</term> - <listitem>This option generates and installs the api documentation. + <listitem><para>This option generates and installs the api documentation. <application>doxygen</application> must be installed in this case. - </listitem> + </para></listitem> </varlistentry> <varlistentry> <term>--enable-docbook</term> - <listitem>If you what to generate and install the handbook, you must + <listitem><para>If you what to generate and install the handbook, you must provide this parameter. - <application>docbook</application> must be installed in this case. + <application>docbook</application> must be installed in this case.</para> </listitem> </varlistentry> <varlistentry> <term>--disable-RTTI</term> - <listitem>Some environments don't use runtime type information + <listitem><para>Some environments don't use runtime type information to reduce the size of the footprint of the binaries. In this case - the according debugging information is omitted. + the according debugging information is omitted.</para> </listitem> </varlistentry> <varlistentry> <term>--disable-exceptions</term> - <listitem>Some environments don't use exceptions for similar reasons. + <listitem><para>Some environments don't use exceptions for similar reasons. All features based on try and catch statements don't work in this case - and you must provide your own way to collect the test results. + and you must provide your own way to collect the test results.</para> </listitem> </varlistentry> <varlistentry> <term>--enable-builtin-stl</term> - <listitem>By default &mockpp; is compiled with the C++ Standard Template Libray that + <listitem><para>By default &mockpp; is compiled with the C++ Standard Template Libray that comes with your compiler. Unfortunately the current implementations consume - rather much resources. For that reason a built-in minimalistic STL can be used. + rather much resources. For that reason a built-in minimalistic STL can be used.</para> </listitem> </varlistentry> <varlistentry> <term>--disable-builtin-cxxtest</term> - <listitem>By default &mockpp; uses a built-in version of &cxxtest; as test + <listitem><para>By default &mockpp; uses a built-in version of &cxxtest; as test framework. If you want to use another framework you should disable it to remove all internal dependencies. Please understand that in this case the unit tests - won't run if you don't enable another supported framework instead. + won't run if you don't enable another supported framework instead.</para> </listitem> </varlistentry> <varlistentry> <term>--enable-cppunit</term> - <listitem>This option enables &cppunit; as test framework. + <listitem><para>This option enables &cppunit; as test framework.</para> </listitem> </varlistentry> <varlistentry> <term>--enable-boosttest</term> - <listitem>This option enables Boost.Test as test framework. + <listitem><para>This option enables Boost.Test as test framework.</para> </listitem> </varlistentry> <varlistentry> <term>--boost-dir</term> - <listitem>Normaly configure searches <filename>/usr/include</filename> and + <listitem><para>Normaly configure searches <filename>/usr/include</filename> and <filename>/usr/local/include</filename>. In case there are multiple versions the first directory is taken. If you have a non-standard include directory or - need as special version you will want to use this option. + need as special version you will want to use this option.</para> </listitem> </varlistentry> @@ -231,9 +231,10 @@ <varlistentry> <term><literal>MOCKPP_USE_MINI_STL</literal></term> <listitem><para>Use the built-in alternative STL implementation instead of the - STL that come with the C++ compiler to try to save memory resources. - In this case <literal>CXXTEST_USE_MINI_STL</literal> should also be defined - if you use &cxxtest;.</para> + STL that comes with the C++ compiler to try to save memory resources. + If you use &cxxtest; <literal>CXXTEST_USE_MINI_STL</literal> should also be + defined.</para> + <para>If you want to use another STL you have to extend the according section in <filename>mockpp.h</filename>. Search for <literal>MOCKPP_USE_MINI_STL</literal> and add an appropriate section similar to the one for |
