From d321225e54a1417afb8303a3570de7ef227e91f9 Mon Sep 17 00:00:00 2001 From: Jens Thiele Date: Wed, 13 Dec 2006 15:06:52 +0000 Subject: [PATCH] added index.doc --- doc/Doxyfile.in | 4 ++-- doc/Makefile.am | 4 +++- doc/index.doc | 32 ++++++++++++++++++++++++++++++++ 3 files changed, 37 insertions(+), 3 deletions(-) create mode 100644 doc/index.doc diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 25c9c70..182c285 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -459,7 +459,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = ../src ../codegen +INPUT = index.doc ../src ../codegen # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp @@ -502,7 +502,7 @@ EXCLUDE_PATTERNS = # todo: we can't depend on example package here -EXAMPLE_PATH = ../../libt2n-examples/libt2n-example1/ ../../libt2n-examples/libt2n-example1-client/ ../codegen/ +EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp diff --git a/doc/Makefile.am b/doc/Makefile.am index c8180ce..dd647bc 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -8,5 +8,7 @@ endif all: $(MANUALS) -html/index.html: $(top_srcdir)/src/*.cpp $(top_srcdir)/src/*.hxx $(top_srcdir)/codegen/*.hxx $(top_srcdir)/codegen/*.cpp +html/index.html: $(top_srcdir)/src/*.cpp $(top_srcdir)/src/*.hxx $(top_srcdir)/codegen/*.hxx $(top_srcdir)/codegen/*.cpp $(srcdir)/index.doc $(DOXYGEN) + +EXTRA_DIST = index.doc diff --git a/doc/index.doc b/doc/index.doc new file mode 100644 index 0000000..67d6189 --- /dev/null +++ b/doc/index.doc @@ -0,0 +1,32 @@ +// mainpage should not be here + +/*! \mainpage libt2n - (talk to neighbor) + \section intro_sec Introduction + libt2n (talk to neighbor) 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. + \par + 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 and generates 6 output files: 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 only. + \par + To simplify the build process a Makefile snippet is provided that allows to create a server program and a client library (including a corresponding .pc file) using the autotools easily. + \section install_sec Installation + + \subsection requirements Requirements + - boost (serialization ) + - gccxml + - libxmlpp + + \subsection recommended Recommended + - pkg-config + - autotools (automake, autoconf, libtool) + + \subsection Compilation + \verbatim + ./configure && make install + \endverbatim + + \subsection Usage + \sa file:../../../libt2n-examples/doc/html/index.html + +*/ -- 1.7.1