* doc/mln/io/io.dox: Add PDF group. * mln/io/pdf/get_header.hh, * mln/io/pdf/load.hh: Add to PDF group. --- milena/ChangeLog | 9 +++++++++ milena/doc/mln/io/io.dox | 7 +++++++ milena/mln/io/pdf/get_header.hh | 10 ++++++++-- milena/mln/io/pdf/load.hh | 12 ++++++++++++ 4 files changed, 36 insertions(+), 2 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index d3014e9..fa1c5b8 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,14 @@ 2013-04-11 Guillaume Lazzara <z@lrde.epita.fr> + Add a PDF I/O group in documentation. + + * doc/mln/io/io.dox: Add PDF group. + + * mln/io/pdf/get_header.hh, + * mln/io/pdf/load.hh: Add to PDF group. + +2013-04-11 Guillaume Lazzara <z@lrde.epita.fr> + Add references to code examples * doc/DoxygenLayout.xml: Change example section name. diff --git a/milena/doc/mln/io/io.dox b/milena/doc/mln/io/io.dox index cc2ae0d..97c199e 100644 --- a/milena/doc/mln/io/io.dox +++ b/milena/doc/mln/io/io.dox @@ -108,3 +108,10 @@ * * \ingroup iogroup */ + +/*! \defgroup iopdf PDF + * + * \brief PDF I/O routines. + * + * \ingroup iogroup + */ diff --git a/milena/mln/io/pdf/get_header.hh b/milena/mln/io/pdf/get_header.hh index 946dbfd..9a2e164 100644 --- a/milena/mln/io/pdf/get_header.hh +++ b/milena/mln/io/pdf/get_header.hh @@ -51,7 +51,10 @@ namespace mln namespace pdf { - /// Store pdf file header. + /*! + \brief Store pdf file header. + \ingroup iopdf + */ struct pdf_header { pdf_header(const poppler::document *doc); @@ -66,7 +69,10 @@ namespace mln }; - /// Retrieve header in a pdf file. + /*! + \brief Retrieve header in a pdf file. + \ingroup iopdf + */ pdf_header get_header(const std::string& filename); diff --git a/milena/mln/io/pdf/load.hh b/milena/mln/io/pdf/load.hh index 59b0736..84e0926 100644 --- a/milena/mln/io/pdf/load.hh +++ b/milena/mln/io/pdf/load.hh @@ -52,6 +52,8 @@ namespace mln \param[in] dpi Document resolution. Page numbering starts from 0. + + \ingroup iopdf */ template <typename I> void load(util::array<I>& arr, const std::string& filename, @@ -69,6 +71,8 @@ namespace mln \param[in] dpi Document resolution. Page numbering starts from 0. + + \ingroup iopdf */ template <typename I> void load(util::array<I>& arr, const std::string& filename, @@ -86,6 +90,8 @@ namespace mln \param[in] dpi Document resolution. Page numbering starts from 0. + + \ingroup iopdf */ template <typename I> void load(util::array<I>& arr, const std::string& filename, @@ -102,6 +108,8 @@ namespace mln \param[in] dpi Document resolution. Page numbering starts from 0. + + \ingroup iopdf */ template <typename I> void load(Image<I>& ima, const std::string& filename, @@ -117,6 +125,8 @@ namespace mln DPI resolution is set to 300. Page numbering starts from 0. + + \ingroup iopdf */ template <typename I> void load(util::array<I>& arr, const std::string& filename); @@ -132,6 +142,8 @@ namespace mln DPI resolution is set to 300. Page numbering starts from 0. + + \ingroup iopdf */ template <typename I> void load(util::array<I>& arr, const std::string& filename, -- 1.7.2.5