diff options
Diffstat (limited to 'src/libexif/exif-loader.h')
| -rw-r--r-- | src/libexif/exif-loader.h | 56 |
1 files changed, 42 insertions, 14 deletions
diff --git a/src/libexif/exif-loader.h b/src/libexif/exif-loader.h index cf900c8..697e019 100644 --- a/src/libexif/exif-loader.h +++ b/src/libexif/exif-loader.h @@ -1,6 +1,8 @@ -/* exif-loader.h - * - * Copyright © 2003 Lutz Müller <lutz@users.sourceforge.net> +/*! \file exif-loader.h + * \brief Defines the ExifLoader type + */ +/* + * Copyright (c) 2003 Lutz Mueller <lutz@users.sourceforge.net> * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public @@ -22,7 +24,6 @@ #define __EXIF_LOADER_H__ #include <libexif/exif-data.h> -#include <libexif/exif-loader.h> #include <libexif/exif-log.h> #include <libexif/exif-mem.h> @@ -32,21 +33,48 @@ extern "C" { typedef struct _ExifLoader ExifLoader; +/*! Allocate a new ExifLoader + * \returns the allocated ExifLoader + */ ExifLoader *exif_loader_new (void); -ExifLoader *exif_loader_new_mem (ExifMem *); -void exif_loader_ref (ExifLoader *); -void exif_loader_unref (ExifLoader *); +/*! Allocate a new ExifLoader using an ExifMem + * \param[in] mem the ExifMem + * \returns the allocated ExifLoader + */ +ExifLoader *exif_loader_new_mem (ExifMem *mem); +/*! Increase the refcount of the ExifLoader + * \param[in] loader the ExifLoader to increase the refcount of. + */ +void exif_loader_ref (ExifLoader *loader); +/*! Decrease the refcount of the ExifLoader + * \param[in] loader the ExifLoader to decrease the refcount of. + * If the refcount reaches 0, the ExifLoader is freeed. + */ +void exif_loader_unref (ExifLoader *loader); -void exif_loader_write_file (ExifLoader *, const char *fname); +/*! Write a file to the ExifLoader + * \param[in] loader the loader + * \param[in] fname the path to the file to read + */ +void exif_loader_write_file (ExifLoader *loader, const char *fname); -/* - * Returns 1 while EXIF data is read (or while there is still - * hope that there will be EXIF data later on), 0 otherwise. +/*! Write a buffer to the ExifLoader + * \param[in] loader the loader to write too + * \param[in] buf the buffer to read from + * \param[in] sz the size of the buffer + * \returns 1 while EXIF data is read (or while there is still hope that there will be EXIF data later on), 0 otherwise. */ -unsigned char exif_loader_write (ExifLoader *, unsigned char *, unsigned int); +unsigned char exif_loader_write (ExifLoader *loader, unsigned char *buf, unsigned int sz); -void exif_loader_reset (ExifLoader *); -ExifData *exif_loader_get_data (ExifLoader *); +/*! Reset the ExifLoader + * \param[in] loader the loader + */ +void exif_loader_reset (ExifLoader *loader); +/*! Get an ExifData out of an ExifLoader + * \param[in] loader the loader + * \returns and allocated ExifData + */ +ExifData *exif_loader_get_data (ExifLoader *loader); void exif_loader_log (ExifLoader *, ExifLog *); |