[pacman-dev] [PATCH] Some doxygen comments.

[Andrew Fyfe]

Dan McGee wrote:
> On 7/12/07, Andrew Fyfe <andrew at neptune-one.net> wrote:
>> Signed-off-by: Andrew Fyfe <andrew at neptune-one.net>
>> ---
>>  lib/libalpm/deps.c   |    2 +-
>>  lib/libalpm/trans.c  |    5 +++++
>>  src/pacman/deptest.c |    4 +++-
>>  3 files changed, 9 insertions(+), 2 deletions(-)
>>
>> diff --git a/lib/libalpm/deps.c b/lib/libalpm/deps.c
>> index 591e5a8..3560fdd 100644
>> --- a/lib/libalpm/deps.c
>> +++ b/lib/libalpm/deps.c
>> @@ -222,7 +222,7 @@ alpm_list_t *_alpm_sortbydeps(alpm_list_t *targets, pmtranstype_t mode)
>>   * @param db pointer to the local package database
>>   * @param op transaction type
>>   * @param packages an alpm_list_t* of packages to be checked
>> - * @return an alpm_list_t* of missing_t pointers.
>> + * @return an alpm_list_t* of pmpkg_t* of missing_t pointers.
>>   */
>>  alpm_list_t *_alpm_checkdeps(pmdb_t *db, pmtranstype_t op,
>>                               alpm_list_t *packages)
>> diff --git a/lib/libalpm/trans.c b/lib/libalpm/trans.c
>> index 2078a5d..75f2a1d 100644
>> --- a/lib/libalpm/trans.c
>> +++ b/lib/libalpm/trans.c
>> @@ -298,6 +298,11 @@ int _alpm_trans_sysupgrade(pmtrans_t *trans)
>>         return(_alpm_sync_sysupgrade(trans, handle->db_local, handle->dbs_sync));
>>  }
>>
>> +/** Add a target to the transaction.
>> + * @param trans the current transaction
>> + * @param target the name of the target to add
>> + * @return 0 on success, -1 on error (pm_errno is set accordingly)
>> + */
>>  int _alpm_trans_addtarget(pmtrans_t *trans, char *target)
>>  {
>>         ALPM_LOG_FUNC;
>> diff --git a/src/pacman/deptest.c b/src/pacman/deptest.c
>> index 0f149b2..3b6b7ac 100644
>> --- a/src/pacman/deptest.c
>> +++ b/src/pacman/deptest.c
>> @@ -35,7 +35,9 @@
>>
>>  extern config_t *config;
>>
>> -/* TODO: This should use _alpm_checkdeps() */
>> +/**
>> + * @todo This should use _alpm_checkdeps()
>> + */
>>  int pacman_deptest(alpm_list_t *targets)
>>  {
>>         int retval = 0;
> 
> The first part is fine but I'm going to disagree with the second
> change. "grep -RF TODO *" is helpful for me, and we don't tend to use
> Doxygen on the frontend anyway. If you resubmit without that second
> part, I'll take it.
I've been using doxygen to create caller graphs...
http://neptune-one.homeip.net/~andrew/pacman/doxygen/d3/dd7/lib_2libalpm_2add_8c_a3a4467cb64c0ec2c8f069a518822e5e_icgraph.png
:D

> 
> -Dan
> 
> _______________________________________________
> pacman-dev mailing list
> pacman-dev at archlinux.org
> http://archlinux.org/mailman/listinfo/pacman-dev