Improve API documentation round 1.

This commit is contained in:
Juan RP
2012-01-20 12:17:27 +01:00
parent 6057bd83b3
commit d075411049
7 changed files with 216 additions and 216 deletions

View File

@ -35,6 +35,27 @@
#include "xbps_api_impl.h"
/**
* @file lib/transaction_commit.c
* @brief Transaction handling routines
* @defgroup transaction Transaction handling functions
*
* The following image shows off the full transaction dictionary returned
* by xbps_transaction_prepare().
*
* @image html images/xbps_transaction_dictionary.png
*
* Legend:
* - <b>Salmon bg box</b>: The transaction dictionary.
* - <b>White bg box</b>: mandatory objects.
* - <b>Grey bg box</b>: optional objects.
* - <b>Green bg box</b>: possible value set in the object, only one of them
* will be set.
*
* Text inside of white boxes are the key associated with the object, its
* data type is specified on its edge, i.e string, array, integer, dictionary.
*/
static int
check_binpkgs_hash(prop_object_iterator_t iter)
{