doc/footer.html @@ -418,7 +418,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = @CMAKE_SOURCE_DIR@/typelib +INPUT = @CMAKE_SOURCE_DIR@/README.txt @CMAKE_SOURCE_DIR@/typelib # 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 @@ -597,7 +597,7 @@ HTML_HEADER = # each generated HTML page. If it is left blank doxygen will generate a # standard footer. -HTML_FOOTER = +HTML_FOOTER = @CMAKE_SOURCE_DIR@/doc/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading # style sheet that is used by each HTML page. It can be used to Doxyfile.in @@ -1,3 +1,5 @@ +/*! \mainpage Typelib: a C++ type and value introspection library + Typelib is a C++ library which allows for introspection on data types and data values. Its value model is based on the C type model. The library allows to load definition from various type description files (including plain C), build @@ -7,40 +9,60 @@ A binding to the Ruby language is provided, which allows to very easily interfac a dynamic library from within Ruby code. This Ruby binding is based on the dyncall library, whose full source code is provided in this release. -Typelib has been written by - Sylvain Joyeux <sylvain.joyeux@m4x.org> +Typelib has been written by Sylvain Joyeux <sylvain.joyeux@m4x.org> + +Copyright 2004-2008 LAAS/CNRS <openrobots@laas.fr> and DGA <arnaud.paronian@dga.gouv.fr> + +This software is provided under the CeCILL B License, which gives comparable +terms of use than the BSD license. See LICENSE.txt or LICENSE.fr.txt provided +with the source code for the full license texts. + +These pages document only the C++ part of the library. The Ruby bindings documentation +are available <a href="ruby/index.html">here</a>. + +\section Installation + +\subsection source Getting the source code +Releases are available on SourceForge: <a +href="http://sourceforge.net/projects/typelib/">http://sourceforge.net/projects/typelib/</a>. +You can access this project page from anywhere in the documentation by clicking +on the SourceForge.net logo at the bottom of documentation pages. + +The development repository is managed by git and is (for now) publicly available in GitHub: -Copyright 2004-2008 - LAAS/CNRS <openrobots@laas.fr> - DGA <arnaud.paronian@dga.gouv.fr> +<pre> + git clone git://github.com/doudou/typelib.git +</pre> -This software is provided under the CeCILL B License, which gives comparable terms -of use than the BSD license. See LICENSE.txt or LICENSE.fr.txt for the full license -texts. +(see <a href="http://github.com/doudou/">this page</a> for more information) -== Installation -=== C++ library +\subsection cpp Building and installing the C++ library The C++ library depends on the following: - * the boost library, including boost/filesystem - * utilmm which can be downloaded using Darcs with - darcs get http://www.laas.fr/~sjoyeux/darcs/utilmm - (check the INSTALL file) - * the antlr parser generator - * cmake and pkg-config - * doxygen for the documentation (optional) - * libxml2 + - the boost library, including boost/filesystem + - utilmm (utilmm.sf.net) + - the antlr parser generator + - cmake and pkg-config + - doxygen for the documentation (optional) + - libxml2 When all these dependencies are installed, run +<pre> mkdir build cd build cmake .. make make doc # to build the documentation, only if doxygen is available +</pre> and as root, +<pre> make install +</pre> -=== Ruby bindings +Alternatively, you can add the \c -DCMAKE_INSTALL_PREFIX=path/to/the/installation/target option to cmake +to install the files in a custom directory + +\subsection ruby Building and installing Ruby bindings The installation of the Ruby bindings require the following: * the ruby interpreter version 1.8 and the associated development files. @@ -63,26 +85,4 @@ At runtime, the bindings require the following: You can also find the sources at git clone http://www.laas.fr/~sjoyeux/git/utilrb.git read the INSTALL.txt file - -=== Quick Debian installation guide - -Run as root - apt-get install build-essential cmake pkg-config libboost-dev libboost-filesystem-dev ruby1.8-dev libtest-unit-ruby rubygems cantlr libantlr-dev doxygen rdoc1.8 libxml2-dev - gem install utilrb - -Run as a normal user - <go into a source directory> - darcs get http://www.laas.fr/~sjoyeux/darcs/utilmm - <install the utilmm library by following instructions in - utilmm/INSTALL> - - <go into Typelib source directory> - mkdir build - cd build - cmake .. - make - make doc - -Run as root - make install - +*/ README.txt @@ -22,7 +22,7 @@ ADD_CUSTOM_COMMAND(OUTPUT ${DYNCALL_LIBRARIES} ADD_CUSTOM_TARGET(dyncall DEPENDS ${DYNCALL_LIBRARIES}) if(RDOC_EXECUTABLE) - ADD_CUSTOM_TARGET(doc rdoc ${CMAKE_CURRENT_SOURCE_DIR}) + ADD_CUSTOM_TARGET(doc rdoc ${CMAKE_CURRENT_SOURCE_DIR} -o ${CMAKE_BINARY_DIR}/doc/html/ruby/) endif(RDOC_EXECUTABLE) ADD_RUBY_EXTENSION(typelib_ruby bindings/ruby/CMakeLists.txt d6799f324d3740eeb3d4114bba1761af5b65ecec Sylvain Joyeux sylvain.joyeux@m4x.org http://github.com/doudou/typelib/commit/ff262479daf8df55cf32c84f5e579a2682af405c ff262479daf8df55cf32c84f5e579a2682af405c 2008-02-19T02:09:40-08:00 2008-02-19T02:09:14-08:00 [doc] misc fixes to documentation generation - use README.txt as the front page of the Doxygen documentation - generate the Ruby bindings documentation in doc/html/ruby and link them from README.txt. That way, they can be accessed directly from the C++ documentation - add the sourceforge logo at the bottom of Doxygen-generated pages 3f664b02388c8fa9d5566c7673229262f43d409d Sylvain Joyeux sylvain.joyeux@m4x.org