Document xbps_humanize_number() in the API.

--HG--
branch : progress_callback
This commit is contained in:
Juan RP 2011-01-22 14:37:07 +01:00
parent 0cc4ba224e
commit 7d3e17b86b

View File

@ -294,7 +294,6 @@ const char *xbps_fetch_error_string(void);
/*@}*/ /*@}*/
int xbps_humanize_number(char *, int64_t);
/** /**
* @ingroup pkg_orphans * @ingroup pkg_orphans
@ -1210,6 +1209,18 @@ void xbps_set_cachedir(const char *cachedir);
*/ */
const char *xbps_get_cachedir(void); const char *xbps_get_cachedir(void);
/**
* Converts the 64 bits signed number specified in \a bytes to
* a human parsable string buffer pointed to \a buf.
*
* @param[out] buf Buffer to store the resulting string. At least
* it should have space for 6 chars.
* @param[in] bytes 64 bits signed number to convert.
*
* @return A negative number is returned on error, 0 otherwise.
*/
int xbps_humanize_number(char *buf, int64_t bytes);
/** /**
* Sets the flag specified in \a flags for internal use. * Sets the flag specified in \a flags for internal use.
* *