Mega-commit to document the API with doxygen.

Some changes were made to the API when making the documentation:

- A few exported functions are now hidden, because they were only used
  internally in the library.
- A few exported symbols were renamed to document them better than
  previously.
- Cosmetic changes all along the way, as well as some fixes here and there.

--HG--
extra : convert_revision : xtraeme%40gmail.com-20100121021019-onbsivlrhdb7t3ou
This commit is contained in:
Juan RP
2010-01-21 03:10:19 +01:00
parent 61d2ea8896
commit c0b280c118
40 changed files with 1977 additions and 761 deletions

View File

@@ -42,6 +42,13 @@
#include <xbps_api.h>
#include "fetch.h"
/**
* @file lib/download.c
* @brief Download routines
* @defgroup download Internal download functions
*
* These functions allow you to download files.
*/
struct xferstat {
struct timeval start;
struct timeval last;
@@ -164,7 +171,7 @@ stat_end(struct xferstat *xsp)
fprintf(stderr, "\033[K\n");
}
const char SYMEXPORT *
const char *
xbps_fetch_error_string(void)
{
return fetchLastErrString;
@@ -183,11 +190,7 @@ print_time(time_t *t)
}
#endif
/*
* Returns -1 on error, 0 if not download (because local/remote
* size and/or mtime match) and 1 if downloaded successfully.
*/
int SYMEXPORT
int
xbps_fetch_file(const char *uri, const char *outputdir, bool refetch,
const char *flags)
{