[Olena-patches] olena: olena-2.0-579-g3e418dc doc/mln/io/io.dox: List the required dependencies for each I/O type.

--- milena/ChangeLog | 5 +++ milena/doc/mln/io/io.dox | 81 ++++++++++++++++++++++++++++++++++----------- 2 files changed, 66 insertions(+), 20 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 364f90b..796405c 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,8 @@ +2013-04-29 Guillaume Lazzara <z(a)lrde.epita.fr> + + * doc/mln/io/io.dox: List the required dependencies for each I/O + type. + 2013-04-26 Guillaume Lazzara <z(a)lrde.epita.fr> * mln/core/internal/image_base.hh: Add more documentation for diff --git a/milena/doc/mln/io/io.dox b/milena/doc/mln/io/io.dox index 97c199e..720eac7 100644 --- a/milena/doc/mln/io/io.dox +++ b/milena/doc/mln/io/io.dox @@ -12,10 +12,15 @@ */ /*! \defgroup iodicom DICOM - * - * \brief DICOM I/O routines. - * - * \ingroup iogroup + + \brief DICOM I/O routines. + + These routines require the following packages: + + \li libgdcm2.0 + \li libgdcm2-dev + + \ingroup iogroup */ /*! \defgroup iodump Dump @@ -26,10 +31,15 @@ */ /*! \defgroup iofits FITS - * - * \brief FITS I/O routines. - * - * \ingroup iogroup + + \brief FITS I/O routines. + + These routines require the following packages: + + \li libcfitsio3 + \li libcfitsio3-dev + + \ingroup iogroup */ /*! \defgroup iofld FLD @@ -40,10 +50,29 @@ */ /*! \defgroup iomagick ImageMagick - * - * \brief ImageMagick I/O routines. - * - * \ingroup iogroup + + \brief ImageMagick I/O routines. + + These routines require ImageMagick or GraphicsMagick to be installed. + + GraphicsMagick requires the following packages: + + \li libgraphismagick++-3 + \li graphicsmagick + \li graphicsmagick-imagemagick-compat + \li libgraphicsmagick++3 + \li libgraphicsmagick3 + \li libgraphicsmagick++1-dev + \li libgraphicsmagick1-dev + \li graphicsmagick-libmagick-dev-compat + + ImageMagick requires the following packages: + + \li libmagick++5 + \li libmagick++-dev + \li imagemagick + + \ingroup iogroup */ /*! \defgroup iooff OFF @@ -96,10 +125,15 @@ */ /*! \defgroup iotiff TIFF - * - * \brief TIFF I/O routines. - * - * \ingroup iogroup + + \brief TIFF I/O routines. + + These routines require the following packages: + + \li libtiff5 + \li libtiff5-dev + + \ingroup iogroup */ /*! \defgroup iotxt TXT @@ -110,8 +144,15 @@ */ /*! \defgroup iopdf PDF - * - * \brief PDF I/O routines. - * - * \ingroup iogroup + + \brief PDF I/O routines. + + These routines require the following packages: + + \li libpoppler5 + \li libpoppler-dev + \li libpoppler-cpp-dev + \li libpoppler-qt-dev + + \ingroup iogroup */ -- 1.7.2.5