[pacman-dev] [PATCH] alpm.h: add/improve function documentation

[Sebastian Nowicki]

On Sun, Apr 17, 2011 at 3:48 PM, Rémy Oudompheng
<remyoudompheng at gmail.com>wrote:

> Signed-off-by: Rémy Oudompheng <remy at archlinux.org>
> ---
>  lib/libalpm/add.c  |    5 +----
>  lib/libalpm/alpm.h |   30 +++++++++++++++++++++++++-----
>  lib/libalpm/sync.c |    4 +---
>  3 files changed, 27 insertions(+), 12 deletions(-)
>
> diff --git a/lib/libalpm/add.c b/lib/libalpm/add.c
> index 0a5cb53..6b2bd7a 100644
> --- a/lib/libalpm/add.c
> +++ b/lib/libalpm/add.c
> @@ -49,10 +49,7 @@
>  #include "remove.h"
>  #include "handle.h"
>
> -/** Add a package to the transaction.
> - * @param pkg the package to add
> - * @return 0 on success, -1 on error (pm_errno is set accordingly)
> - */
> +/** Add a package to the transaction. */
>
>  ...
>
> -/** Search for packages to upgrade and add them to the transaction.
> - * @return 0 on success, -1 on error (pm_errno is set accordingly)
> - */
> +/** Search for packages to upgrade and add them to the transaction. */
>  int SYMEXPORT alpm_sync_sysupgrade(int enable_downgrade)
>  {
>        alpm_list_t *i, *j, *k;
> --
> 1.7.4.4
>

Does the documentation mention anywhere that pm_errno will be set when
errors occur (I don't think this is even 100% accurate)? If not, do we
really want to remove that little bit of info from the documentation? Also I
find it odd that you're changing the documentation of these two functions,
but add equivalent documentation to alpm_remove_pkg().