Commit 26b7669e authored by Guillaume Lazzara's avatar Guillaume Lazzara
Browse files

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.
parent af998487
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
......@@ -108,3 +108,10 @@
*
* \ingroup iogroup
*/
/*! \defgroup iopdf PDF
*
* \brief PDF I/O routines.
*
* \ingroup iogroup
*/
......@@ -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);
......
......@@ -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,
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment