00001 /* Bugzilla C# Proxy Library 00002 Copyright (C) 2006, Dansk BiblioteksCenter A/S 00003 Mads Bondo Dydensborg, <mbd@dbc.dk> 00004 00005 This library is free software; you can redistribute it and/or 00006 modify it under the terms of the GNU Lesser General Public 00007 License as published by the Free Software Foundation; either 00008 version 2.1 of the License, or (at your option) any later version. 00009 00010 This library is distributed in the hope that it will be useful, 00011 but WITHOUT ANY WARRANTY; without even the implied warranty of 00012 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00013 Lesser General Public License for more details. 00014 00015 You should have received a copy of the GNU Lesser General Public 00016 License along with this library; if not, write to the Free Software 00017 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 00018 */ 00019 00020 /*! \file 00021 \brief This file only contains doxygen comments/documentation. */ 00022 00023 /*! \namespace Bugzproxy 00024 \brief The namespace of all the code in this assembly. 00025 00026 The namespace contains the interfaces and classes that makes up the assembly. 00027 */ 00028 00029 /*! \namespace Bugzproxy::ProxyStructs 00030 00031 \brief Structs passed to the proxy stub created by the xml-rpc.net 00032 framework. 00033 00034 The structs in this namespace are used internally. 00035 */ 00036 00037 /*! \mainpage C# Bugzilla WebService Access Assembly 00038 \section mp_intro_sec Introduction 00039 00040 This is the documentation for %BugzillaProxy, the C# %Bugzilla 00041 WebService Access Assembly. For more information about what it is, 00042 and why to use it, consult http://oss.dbc.dk/bugzproxy . 00043 00044 \section mp_getting_started Getting Started 00045 00046 Either check out the Bugzproxy.Server class, or the example 00047 page. 00048 00049 All examples are compilable (they are part of the source 00050 distribution) and take a common set of options. Use the "--help" 00051 option to each to get the options. By default all programs use the 00052 Bugzilla "landfill" server, but you can change this using the 00053 options. 00054 00055 All example programs also accept a "--trace" option, that will dump 00056 the communication with the server to std.out. Please note, that some 00057 issues, such as supplying a non-existant server, will not be 00058 indicated in the trace, but by exceptions. 00059 00060 \section mp_error Error Handling 00061 00062 In general, all methods throw exceptions on errors. 00063 00064 */ 00065 00066 /*! \example Test.cs 00067 00068 * This is a rather simple program, that simply tests that all 00069 * functions can actually be called, but does not actually check that 00070 * the results are meaningful (xml-rpc.net does check that the 00071 * responses can be cast to the strucs that are expected though). As 00072 * such is it not a great example of anything in particular, but you 00073 * may wish to consult it to get a feel for the API. It is mostly used 00074 * by the developers to check that nothing is really broken, when 00075 * changing the library code. 00076 * 00077 */