[pacman-dev] [PATCH 2/4] Added a few helpful comments

[Dan McGee]

Hmm- I think we have different versions of helpful. If a function gets
half documented and only one parameter gets called out, it isn't so
useful to me or others as now we have to wonder just how stale that
documentation is. It also isn't even proper Doxygen syntax (you need
to use /**, not /*).

I will apply something like this, but please use a full template and
fill it all out:

/** Summary goes here.
 * Followed by more description.
 * @param url
 * @param localpath
 * @param force
 * @param allow_resume
 * @param errors_ok
 * @return
 */

On Sun, Jun 12, 2011 at 5:20 AM, Kerrick Staley <mail at kerrickstaley.com> wrote:
> Signed-off-by: Kerrick Staley <mail at kerrickstaley.com>
> ---
>  lib/libalpm/be_sync.c |    2 +-
>  lib/libalpm/dload.c   |    3 +++
>  2 files changed, 4 insertions(+), 1 deletions(-)
>
> diff --git a/lib/libalpm/be_sync.c b/lib/libalpm/be_sync.c
> index 9d85a45..758e5f9 100644
> --- a/lib/libalpm/be_sync.c
> +++ b/lib/libalpm/be_sync.c
> @@ -1,5 +1,5 @@
>  /*
> - *  be_sync.c
> + *  be_sync.c : backend for sync databases
>  *
>  *  Copyright (c) 2006-2011 Pacman Development Team <pacman-dev at archlinux.org>
>  *  Copyright (c) 2002-2006 by Judd Vinet <jvinet at zeroflux.org>
> diff --git a/lib/libalpm/dload.c b/lib/libalpm/dload.c
> index 1825eed..6d9b007 100644
> --- a/lib/libalpm/dload.c
> +++ b/lib/libalpm/dload.c
> @@ -310,6 +310,9 @@ cleanup:
>  }
>  #endif
>
> +/* download file; do not destroy existing destination file upon download failure
> + * @param force force the file to be downloaded again, even if destination file is up-to-date
> + */
>  int _alpm_download(const char *url, const char *localpath,
>                int force, int allow_resume, int errors_ok)
>  {
> --
> 1.7.5.2
>
>
>