diff options
author | Marcus Meissner <marcus@jet.franken.de> | 2007-05-21 06:51:46 +0000 |
---|---|---|
committer | Marcus Meissner <marcus@jet.franken.de> | 2007-05-21 06:51:46 +0000 |
commit | 9e24fd2812e11a09f3cdaa20d35af44c3717a6cc (patch) | |
tree | 87cdb62c90dea0ee8337e88bfe525f4d2e372278 /gphoto2 | |
parent | 22f1fae3f5ddf2693c38ae1739be2db1cbfaaff8 (diff) | |
download | libgphoto2-9e24fd2812e11a09f3cdaa20d35af44c3717a6cc.tar.gz |
some doxygen markup added
git-svn-id: https://svn.code.sf.net/p/gphoto/code/trunk/libgphoto2@10276 67ed7778-7388-44ab-90cf-0a291f65f57c
Diffstat (limited to 'gphoto2')
-rw-r--r-- | gphoto2/gphoto2-file.h | 6 | ||||
-rw-r--r-- | gphoto2/gphoto2-filesys.h | 12 |
2 files changed, 13 insertions, 5 deletions
diff --git a/gphoto2/gphoto2-file.h b/gphoto2/gphoto2-file.h index e4b964296..7a65fc125 100644 --- a/gphoto2/gphoto2-file.h +++ b/gphoto2/gphoto2-file.h @@ -83,9 +83,11 @@ typedef enum { GP_FILE_ACCESSTYPE_FD /**< File is associated with a UNIX filedescriptor. */ } CameraFileAccessType; -/*! \class CameraFile +/*! \struct CameraFile + * \brief File structure. * - * The internals of the #CameraFile struct are private. + * The internals of the CameraFile struct are private, please use + * the accessor functions. */ typedef struct _CameraFile CameraFile; diff --git a/gphoto2/gphoto2-filesys.h b/gphoto2/gphoto2-filesys.h index ac33d2d6f..08bd2e5cf 100644 --- a/gphoto2/gphoto2-filesys.h +++ b/gphoto2/gphoto2-filesys.h @@ -121,9 +121,9 @@ typedef struct _CameraFileInfoPreview { } CameraFileInfoPreview; /** - * \brief File information of a preview file. + * \brief File information of an audio file. * - * Contains information of a preview file with fields being + * Contains information of an audio file with fields being * set depending on the bitmask in the fields member. */ typedef struct _CameraFileInfoAudio { @@ -225,7 +225,13 @@ typedef struct _CameraStorageInformation { unsigned long freeimages; /**< \brief Free space in images (guessed by camera). */ } CameraStorageInformation; -/* You don't really want to know what's inside, do you? */ +/** + * \brief Filesystem structure, only exposed to camera drivers. + * + * Internal structure, contents not exposed to frontends. Camera + * drivers get these passed to filesystem related functions and + * are supposed to use it only via the accessor functions. + */ typedef struct _CameraFilesystem CameraFilesystem; int gp_filesystem_new (CameraFilesystem **fs); |