[Mockpp-commits] mockpp/mockpp/docs/en appendix.docbook,1.18,1.19 dev_intro.docbook,1.8,1.9 dev_test
Brought to you by:
ewald-arnold
Menu
▾
▴
[Mockpp-commits] mockpp/mockpp/docs/en appendix.docbook,1.18,1.19 dev_intro.docbook,1.8,1.9 dev_test_framework.docbook,1.5,1.6
|
From: Ewald A. <ewa...@us...> - 2006-01-05 19:14:05
|
Update of /cvsroot/mockpp/mockpp/mockpp/docs/en In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv8544/mockpp/docs/en Modified Files: appendix.docbook dev_intro.docbook dev_test_framework.docbook Log Message: update docs Index: appendix.docbook =================================================================== RCS file: /cvsroot/mockpp/mockpp/mockpp/docs/en/appendix.docbook,v retrieving revision 1.18 retrieving revision 1.19 diff -u -d -r1.18 -r1.19 --- appendix.docbook 1 Jan 2006 16:51:46 -0000 1.18 +++ appendix.docbook 5 Jan 2006 19:13:55 -0000 1.19 @@ -80,7 +80,7 @@ </varlistentry> <varlistentry> - <term>--enable-builtin-STL</term> + <term>--enable-builtin-stl</term> <listitem>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. @@ -111,7 +111,7 @@ <varlistentry> <term>--boost-dir</term> <listitem>Normaly configure searches <filename>/usr/include</filename> and - <filename>/usr/local/include</filename>. In case there are multiple version + <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. </listitem> @@ -179,6 +179,61 @@ CBuilder. </para> +<para id="configuration">The following options are used to manually tweak the library: + +<variablelist> + + <varlistentry> + <term><literal>MOCKPP_UNICODE</literal></term> + <listitem>Enable unicode characters (based on <token>wchar_t</token>) instead + of ascii characters.There are some related macros. <literal>MOCKPP_PCHAR</literal> + is used to mark literal character strings either with or without leading "L". + <literal>MOCPP_STRING</literal> is used to create a <token>String</token> variable. + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>MOCKPP_EXPORT</literal></term> + <listitem>Some platforms export only explicitly tagged elements in dynamic + libraries. Other elements can't be linked from other binaries. This macro + hides such an export declaration. + </listitem> + </varlistentry> + + +</variablelist> + +MOCKPP_BOUNDARY_DELTA + +MOCKPP_USE_MINI_STL +CXXTEST_USE_MINI_STL +MOCKPP_STL +MOCKPP_STRING_H +MOCKPP_VECTOR_H +MOCKPP_MAP_H +MOCKPP_SET_H +MOCKPP_FUNCTION_H +MOCKPP_ALGORITHM_H + +MOCKPP_ALTERNATIVE_STL + +MOCKPP_USE_CPPUNIT +MOCKPP_USE_CXXTEST +MOCKPP_USE_BOOSTTEST + +MOCKPP_NO_RTTI + +MOCKPP_NO_EXCEPTIONS +MOCKPP_THROW(x) +MOCKPP_RETHROW +MOCKPP_TRY +MOCKPP_CATCH(x) +MOCKPP_CATCH_ALL + + + +</para> + <note> <title>Once you have ported &mockpp; to a new platform:</title> <para>Please send me your files for inclusion in the next distribution. Index: dev_intro.docbook =================================================================== RCS file: /cvsroot/mockpp/mockpp/mockpp/docs/en/dev_intro.docbook,v retrieving revision 1.8 retrieving revision 1.9 diff -u -d -r1.8 -r1.9 --- dev_intro.docbook 28 Dec 2005 09:23:30 -0000 1.8 +++ dev_intro.docbook 5 Jan 2006 19:13:55 -0000 1.9 @@ -5,12 +5,13 @@ give you a quick overview over the features of &mockpp;. For a complete list of all functions please refer to the api documentation.</para> -<para>There are a few things that are not obvious but might become interesting: +<para>There are a few things that are not obvious but might become important +to get started: <itemizedlist> <listitem><para>&mockpp; uses a data type <token>String</token> which is no data type of it's own but is a typedef to std::string or std::wstring depending on your choice. - It also provides a mminimumfunctionality for unicode if you compile for + It also provides a minimum functionality for unicode if you compile for a unicode environment. See <xref linkend="compilation" /> how to do that.</para> @@ -32,13 +33,19 @@ </listitem> - <listitem>&mockpp; has no testing framework of it's own so it is recommended - to use <ulink url="http://cppunit.sf.net">&cppunit;</ulink> for that purpose. + <listitem>&mockpp; has no testing framework of it's own. But it includes a + slightly modified version of <ulink url="http://cxxtest.sf.net">&cxxtest;</ulink>. + It is also possible to use <ulink url="http://cppunit.sf.net">&cppunit;</ulink> + or <ulink url="http://www.boost.org">&boost.test;</ulink> or others for + that purpose. See the test and example files how to do it. </listitem> </itemizedlist> +<para>See <xref linkend="configuration" /> for more option how to adjust +this library.</para> + </para> </sect1> Index: dev_test_framework.docbook =================================================================== RCS file: /cvsroot/mockpp/mockpp/mockpp/docs/en/dev_test_framework.docbook,v retrieving revision 1.5 retrieving revision 1.6 diff -u -d -r1.5 -r1.6 --- dev_test_framework.docbook 3 Jan 2006 15:12:34 -0000 1.5 +++ dev_test_framework.docbook 5 Jan 2006 19:13:55 -0000 1.6 @@ -99,7 +99,8 @@ <sect2 id="framework-boost"> <title>Boost.Test</title> -<para>Boost.Test does not need test methods which reside in classes. It is also +<para><ulink url="http://www.boost.org">&boost.test;</ulink> does not need test +methods which reside in classes. It is also possible to use free functions. On the other hand there is no mechanism with <function>setup()</function>/<function>teardown()</function> like in &cppunit; or &cxxtest;. Another advantage of &boost.test; is the possibility |
