Add infrastructure changes to build the API documentation.

doxygen and graphviz are required. It's disabled by default, use
the BUILD_API_DOCS make(1) argument to enable it.

--HG--
extra : convert_revision : xtraeme%40gmail.com-20100123013719-pkk3a3823cx09v8l

lib/configure.c

@@ -33,16 +33,16 @@
  * @brief Package configuration routines
  * @defgroup configure Package configuration functions
  *
- * Configure a package or all packages. Only packages in <b>unpacked</b>
+ * Configure a package or all packages. Only packages in XBPS_PKG_STATE_UNPACKED
  * state will be processed (unless overriden). Package configuration steps:
  *  - Its <b>post-install</b> target in the INSTALL script will be executed.
- *  - Its state will be changed to <b>installed</b> if previous step
+ *  - Its state will be changed to XBPS_PKG_STATE_INSTALLED if previous step
  *    ran successful.
  *
  * @note
  * If the \a XBPS_FLAG_FORCE is set through xbps_set_flags(), the package
- * (or packages) will be reconfigured even if its state is <b>installed</b>,
- * as explained in @ref pkgstates.
+ * (or packages) will be reconfigured even if its state is
+ * XBPS_PKG_STATE_INSTALLED.
  */
 #include <xbps_api.h>
 

lib/purge.c

@@ -37,7 +37,7 @@
  * @defgroup purge Package purging functions
  *
  * These functions will purge an specified package or all packages.
- * Only packages in <b>config-files</b> state will be processed
+ * Only packages in XBPS_PKG_STATE_CONFIG_FILES state will be processed
  * (unless overriden). Package purging steps:
  *  - Its <b>post-remove</b> target specified in the REMOVE script
  *    will be executed.

lib/register.c

@@ -37,23 +37,6 @@
  *
  * Register and unregister packages into/from the installed
  * packages database.
- *
- * The following image shows off the full transaction dictionary returned
- * by xbps_repository_get_transaction_dict(). The dictionary passed to
- * xbps_register_pkg() should be one of those package dictionaries
- * stored in the \a packages array stored in the transaction dictionary.
- *
- * @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.
  */
 
 int

lib/regpkgs_dictionary.c

@@ -33,26 +33,27 @@
 
 /**
  * @file lib/regpkgs_dictionary.c
- * @brief Installed packages database init/fini routines
- * @defgroup regpkgdb Installed packages database init/fini functions
+ * @brief Package register database routines
+ * @defgroup regpkgdb Package register database functions
  *
  * These functions will initialize and release (resources of)
- * the installed packages database.
+ * the registered packages database plist file (defined by XBPS_REGPKGDB).
  *
- * The returned dictionary by xbps_regpkgs_dictionary_init() (if initialized
- * successfully) will have the following structure:
+ * The returned dictionary by xbps_regpkgs_dictionary_init() uses
+ * the structure as shown in the next graph:
  *
  * @image html images/xbps_regpkgdb_dictionary.png
  *
  * Legend:
- *  - <b>Salmon bg box</b>: XBPS_REGPKGDB_PLIST file internalized.
- *  - <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.
+ *  - <b>Salmon filled box</b>: \a XBPS_REGPKGDB_PLIST file internalized.
+ *  - <b>White filled box</b>: mandatory objects.
+ *  - <b>Grey filled box</b>: optional objects.
+ *  - <b>Green filled box</b>: possible value set in the object, only one
+ *    of them is 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.
+ * data type is specified on its edge, i.e array, bool, integer, string,
+ * dictionary.
  */
 
 static prop_dictionary_t regpkgs_dict;

lib/remove.c

@@ -39,22 +39,22 @@
  *
  * These functions will remove a package or only a subset of its
  * files. Package removal steps:
- *  - Its <b>pre-remove</b> target specified in the REMOVE script
- *    will be executed.
- *  - Its files, dirs and links will be removed. Modified files (not
- *    matching its sha256 hash) will always be preserved.
- *  - Its <b>post-remove</b> target specified in the REMOVE script
- *    will be executed.
- *  - Its requiredby objects will be removed from the installed packages
- *    database.
- *  - Its state will be changed to <b>config-files</b>.
+ *  -# Its <b>pre-remove</b> target specified in the REMOVE script
+ *     will be executed.
+ *  -# Its files, dirs and links will be removed. Modified files (not
+ *     matching its sha256 hash) will always be preserved.
+ *  -# Its <b>post-remove</b> target specified in the REMOVE script
+ *     will be executed.
+ *  -# Its requiredby objects will be removed from the installed packages
+ *     database.
+ *  -# Its state will be changed to XBPS_PKG_STATE_CONFIG_FILES.
  *
  * @note
- *  - If a package is going to be updated and it's an essential package,
- *    only steps <b>1</b> and <b>4</b> will be executed.
- *  - If a package is going to be updated and it's <b>NOT</b> an essential
- *    package, only steps <b>1</b>, <b>2</b> and <b>4</b> will be executed.
- *  - If a package is going to be removed, all steps will be executed.
+ *  -# If a package is going to be updated and it's an essential package,
+ *     only steps <b>1</b> and <b>4</b> will be executed.
+ *  -# If a package is going to be updated and it's <b>NOT</b> an essential
+ *     package, only steps <b>1</b>, <b>2</b> and <b>4</b> will be executed.
+ *  -# If a package is going to be removed, all steps will be executed.
  *
  * The following image shows the structure of an internalized package's
  * files.plist dictionary: