aboutsummaryrefslogtreecommitdiff
path: root/src/source.h
diff options
context:
space:
mode:
authorHarry Jeffery <harry@exec64.co.uk>2019-08-21 20:16:43 +0100
committerHarry Jeffery <harry@exec64.co.uk>2019-08-21 20:16:43 +0100
commitd2f5deb27816889cdc9b25e868557f0bcd23e163 (patch)
treeb5709f59f5b5d0fe7c2735f01e79ffe5d6df2844 /src/source.h
parentcf7f3127cbde7354f1b592af0d23de4d7cd1123f (diff)
downloadimv-d2f5deb27816889cdc9b25e868557f0bcd23e163.tar.gz
Improve header commenting
Diffstat (limited to 'src/source.h')
-rw-r--r--src/source.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/source.h b/src/source.h
index eed95c4..d55e560 100644
--- a/src/source.h
+++ b/src/source.h
@@ -22,7 +22,10 @@ struct imv_source_message {
const char *error;
};
-/* Generic source of one or more images. Essentially a single image file */
+/* While imv_image represents a single frame of an image, be it a bitmap or
+ * vector image, imv_source represents an open handle to an image file, which
+ * can emit one or more imv_images.
+ */
struct imv_source {
/* usually the path of the image this is the source of */
char *name;