[Olena-patches] olena-2.0-93-g88e0b86 Improve main documentation.

* doc/Makefile.am: Update dependencies. * doc/about.dox, * doc/doxygen.css, * doc/license.dox, * doc/license_commercial.dox, * doc/licensing.dox, * doc/mainpage.dox: Improve titles and presentation. * doc/supported_platforms.dox: New. --- ChangeLog | 15 ++++++++++++ doc/Makefile.am | 4 +- doc/about.dox | 2 +- doc/doxygen.css | 9 ++++++- doc/license_commercial.dox | 7 ----- doc/{license.dox => licensing.dox} | 5 +++- doc/mainpage.dox | 33 ++++++++++++++++---------- doc/supported_platforms.dox | 45 ++++++++++++++++++++++++++++++++++++ 8 files changed, 95 insertions(+), 25 deletions(-) delete mode 100644 doc/license_commercial.dox rename doc/{license.dox => licensing.dox} (67%) create mode 100644 doc/supported_platforms.dox diff --git a/ChangeLog b/ChangeLog index 5297ebb..0c82c0b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,20 @@ 2012-02-27 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + Improve main documentation. + + * doc/Makefile.am: Update dependencies. + + * doc/about.dox, + * doc/doxygen.css, + * doc/license.dox, + * doc/license_commercial.dox, + * doc/licensing.dox, + * doc/mainpage.dox: Improve titles and presentation. + + * doc/supported_platforms.dox: New. + +2012-02-27 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + Fix documentation. * doc/Doxyfile.in, diff --git a/doc/Makefile.am b/doc/Makefile.am index 2feb4e0..f5ff45d 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -74,9 +74,9 @@ REFMAN_deps = $(srcdir)/footer.html \ $(srcdir)/doc.bib \ $(srcdir)/contributors.dox \ $(srcdir)/bibliography.dox \ - $(srcdir)/license.dox \ - $(srcdir)/license_commercial.dox \ + $(srcdir)/licensing.dox \ $(srcdir)/online_resources.dox \ + $(srcdir)/supported_platforms.dox \ $(srcdir)/get_sources.dox \ $(srcdir)/subdoc_footer.html \ contributors.html \ diff --git a/doc/about.dox b/doc/about.dox index d2e10bb..5cadd8b 100644 --- a/doc/about.dox +++ b/doc/about.dox @@ -1,4 +1,4 @@ -/*! \page about What is Olena ? +/*! \page about About Olena Olena is a Free Software platform dedicated to efficient and generic image processing. diff --git a/doc/doxygen.css b/doc/doxygen.css index 104c7dd..bed4d81 100644 --- a/doc/doxygen.css +++ b/doc/doxygen.css @@ -848,9 +848,16 @@ dl.bug table.itable th { font-size: 17px; + } table.itable li { font-size: 16px; -} \ No newline at end of file +} + +table.itable td +{ + font-size: 17px; + vertical-align: top; +} diff --git a/doc/license_commercial.dox b/doc/license_commercial.dox deleted file mode 100644 index 05603fa..0000000 --- a/doc/license_commercial.dox +++ /dev/null @@ -1,7 +0,0 @@ -/*! \page commercial Commercial Use - - Even though Olena is released under GPL v2, using Olena in a close - source commercial products may be possible. - - If you are interested, please contact us at olena(a)lrde.epita.fr -*/ \ No newline at end of file diff --git a/doc/license.dox b/doc/licensing.dox similarity index 67% rename from doc/license.dox rename to doc/licensing.dox index 55bb41d..dcef31c 100644 --- a/doc/license.dox +++ b/doc/licensing.dox @@ -1,9 +1,12 @@ -/*! \page gplv2 GNU General Public License (GPL) +/*! \page licensing Licensing + Olena and its modules are Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE). <br>Olena and its modules are released under GNU GPL v2. +In some cases, it is possible to use Olena in non-GPL softwares. If +you intend to do it, please contact us at olena(a)lrde.epita.fr \section gplv2sec "The GNU General Public License (Version 2)" diff --git a/doc/mainpage.dox b/doc/mainpage.dox index 17b72cc..0f682c7 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -8,13 +8,15 @@ <tr> <th>General Presentation</th> <th>Modules</th> - <th>Applications</th> + <th>Contributing</th> </tr> <tr> <td> \li \ref about \li <a class="el" href="http://www.lrde.epita.fr/cgi-bin/twiki/view/Olena/Publications">Bibliography</a> \li \ref contributors + \li \ref supportedplatforms + \li \ref licensing </td> <td> \li \ref moduleslist @@ -23,29 +25,34 @@ \li Swilena </td> <td> - \li <a class="el" href="http://www.lrde.epita.fr/cgi-bin/twiki/view/Olena/Demos">Online Demos</a> - \li Papers Related Programs - \li Olena Powered Programs + \li Report Bugs and Make Suggestions + \li \ref getsources + \li \ref onlineres </td> </tr> <tr> - <th>Contributing</th> - <th>Licensing</th> - <th>&nbsp;</th> + <th>Fundamentals</th> + <th>Core Features</th> + <th>Applications</th> </tr> <tr> <td> - \li Report Bugs and Make Suggestions - \li \ref getsources - \li \ref onlineres + \li SCOOP 2 + \li Genericity and Performance in Olena </td> <td> - \li \ref gplv2 "GNU GPL" - \li \ref commercial "Commercial Use" + \li Image Manipulation + \li Image Morphers + \li Mathematical Morphology + \li Document Image Analysis + </td> + <td> + \li <a class="el" href="http://www.lrde.epita.fr/cgi-bin/twiki/view/Olena/Demos">Online Demos</a> + \li Papers Related Programs + \li Olena Powered Programs </td> - <td>&nbsp;</td> </tr> </table> diff --git a/doc/supported_platforms.dox b/doc/supported_platforms.dox new file mode 100644 index 0000000..84e81e3 --- /dev/null +++ b/doc/supported_platforms.dox @@ -0,0 +1,45 @@ +/*! \page supportedplatforms Supported Platforms + +\section linux Linux + +Olena has been tested on the following ditributions: + \li Debian 5.0 et 6.0, + \li Mandriva 2010.x, + \li Ubuntu 11.x, + +and with the GNU compiler g++ 4.x. + +It should work on many other distributions. Feel free to test and tell +us how it works at <a +href=mailto:olena@lrde.epita.fr>olena@lrde.epita.fr</a>. Thanks! + + +\section win Windows + +Olena has been compiled and tested successfully using <a +href="http://www.cygwin.com">Cygwin</a>. The GNU compiler g++ and all +the required dependencies must be installed. + +User-made programs can also be compiled with <a +href="http://www.mingw.org">MinGW</a>. However, Olena package shall +not compile because of missing dependencies. + +Currently, Microsoft Visual Studio is not supported. + + +\section mac Mac + +Olena has been tested successfully on a x86_64 architecture with: + \li Mac OS X 10.5, "Snow Leopard", + \li Mac OS X 10.6, "Lion". +Compilation has been made using Apple's version of gcc. + +Olena can also be compiled using compilers and dependencies provided +by <a href="http://www.macports.org">MacPorts</a>. + +\warning in some cases, due to a bug in Apple's gcc, it is necessary +to compile with the flag '-fno-strict-aliasing'. Otherwise, invalid +code may be produced by the compiler and strange segmentation fault +may occur. + +*/ \ No newline at end of file -- 1.7.2.5