started docu

[libt2n] / codegen / main.cpp

diff --git a/codegen/main.cpp b/codegen/main.cpp
index f228ece..45aa9d7 100644 (file)
--- a/codegen/main.cpp
+++ b/codegen/main.cpp
@@ -17,6 +17,59 @@
     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
+/*! \mainpage libt2n - (talk2neighbor)
+ \section intro_sec Introduction
+ libt2n (talk2neighbor) is a C++ library for inter-process communication (IPC, s.a. http://en.wikipedia.org/wiki/Inter-process_communication)
+ with an additional code generator to make remote procedure calls simple. XXX: improve this paragraph: The input for the code generator is standard C++ code (in fact we use gccxml to parse the C++ code and the code generator takes the XML as input) and you mark the procedures you want to expose to other processes.
+ It then generates the stubs needed.
+ The exported procedures can be grouped. For each group the code generator is called which generates 6 outputfiles: group_common.hxx, group_common.cpp, group_client.hxx, group_client.cpp, group_server.hxx, group_server.cpp. The _common files are used by client and server whereas the _client files are used by the client and the _server files by the server. 
+
+ \section install_sec Installation
+
+ \subsection requirements Requirements
+ - boost <http://www.boost.org/> (serialization <http://www.boost.org/libs/serialization/doc/>)
+ - gccxml <http://www.gccxml.org>
+ - libxmlpp <http://libxmlplusplus.sourceforge.net/>
+
+ \section usage Usage example
+
+ In this example we create two packages:
+ - server program and library to connect to the server. The server exports a simple procedure using one group: "t2nexample"
+ - client program using the library
+
+ \subsection server Example server program and client library
+
+ \par The procedure to export (input for the code generator - libt2n-codegen): t2nexample.cpp:
+ \verbinclude libt2n-example1/t2nexample.cpp
+
+ \par Required includes must be put into a seperate group header file: t2nexample.hxx:
+ \verbinclude libt2n-example1/t2nexample.hxx
+
+ \par The server program:
+ \verbinclude libt2n-example1/server.cpp
+
+ \par Using autoconf and automake to build a example server program and a client library.
+ In the configure.in(.ac) we put a check for libt2n:
+ \verbinclude libt2n-example1/configure.in
+ Writing the Makefile.am isn't difficult either:
+ \verbinclude libt2n-example1/Makefile.am
+
+ \subsection client Client using the library
+ Using the library is as simple as using any other library using pkg-config (the pkg-config .pc file is created automatically by the included Makefile snippet)
+ \par We only have to check that the library is installed
+ \verbinclude libt2n-example1-client/configure.in
+ \par Nothing special
+ \verbinclude libt2n-example1-client/Makefile.am
+ \par The client program
+ \verbinclude libt2n-example1-client/client.cpp
+ 
+*/
+
+/*!
+ \example t2nexample.cpp
+ example input for libt2n-codegen
+*/
+
 #include <libxml++/libxml++.h>
 #include <cassert>
 #include <iostream>