/pidgin/main: 732c94e8b7ec: Document the error condition.

[Mark Doliner]

Changeset: 732c94e8b7ec31e671d241dc86fbbe4aec2614fb
Author:	 Mark Doliner <mark at kingant.net>
Date:	 2013-01-21 18:11 -0800
Branch:	 release-2.x.y
URL: http://hg.pidgin.im/pidgin/main/rev/732c94e8b7ec

Description:

Document the error condition.

diffstat:

 libpurple/imgstore.h |  3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

diffs (13 lines):

diff --git a/libpurple/imgstore.h b/libpurple/imgstore.h
--- a/libpurple/imgstore.h
+++ b/libpurple/imgstore.h
@@ -91,7 +91,8 @@ purple_imgstore_new_from_file(const char
  *                  NULL, if you don't need to keep track of a filename.
 
  * @return ID for the image.  This is a unique number that can be used
- *         within libpurple to reference the image.
+ *         within libpurple to reference the image.  0 is returned if the
+ *         image was not added (because of empty data or size).
  */
 int purple_imgstore_add_with_id(gpointer data, size_t size, const char *filename);