summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPanu Matilainen <pmatilai@redhat.com>2007-11-23 14:19:15 +0200
committerPanu Matilainen <pmatilai@redhat.com>2007-11-23 14:19:15 +0200
commit31cbde7d3cf9156aefb65bc642eb2fa195606f09 (patch)
tree01f2405a5d46e4a7e1733b20c0430d9a28073a8e
parentb2a9283a18519397bee5ce7ac51680169ef46da0 (diff)
downloadrpm-31cbde7d3cf9156aefb65bc642eb2fa195606f09.tar.gz
rpm-31cbde7d3cf9156aefb65bc642eb2fa195606f09.tar.bz2
rpm-31cbde7d3cf9156aefb65bc642eb2fa195606f09.zip
Add doxygen grouping to rpmgi methods
-rw-r--r--lib/rpmgi.h21
1 files changed, 11 insertions, 10 deletions
diff --git a/lib/rpmgi.h b/lib/rpmgi.h
index 87e11d698..969558eba 100644
--- a/lib/rpmgi.h
+++ b/lib/rpmgi.h
@@ -18,7 +18,7 @@ extern "C" {
*/
extern int _rpmgi_debug;
-/**
+/** \ingroup rpmgi
*/
typedef enum rpmgiFlags_e {
RPMGI_NONE = 0,
@@ -31,7 +31,7 @@ typedef enum rpmgiFlags_e {
extern rpmgiFlags giFlags;
-/**
+/** \ingroup rpmgi
* Unreference a generalized iterator instance.
* @param gi generalized iterator
* @param msg
@@ -45,7 +45,7 @@ rpmgi XrpmgiUnlink (rpmgi gi,
const char * msg, const char * fn, unsigned ln);
#define rpmgiUnlink(_gi, _msg) XrpmgiUnlink(_gi, _msg, __FILE__, __LINE__)
-/**
+/** \ingroup rpmgi
* Reference a generalized iterator instance.
* @param gi generalized iterator
* @param msg
@@ -58,13 +58,14 @@ rpmgi XrpmgiLink (rpmgi gi, const char * msg,
const char * fn, unsigned ln);
#define rpmgiLink(_gi, _msg) XrpmgiLink(_gi, _msg, __FILE__, __LINE__)
-/** Destroy a generalized iterator.
+/** \ingroup rpmgi
+ * Destroy a generalized iterator.
* @param gi generalized iterator
* @return NULL always
*/
rpmgi rpmgiFree(rpmgi gi);
-/**
+/** \ingroup rpmgi
* Return a generalized iterator.
* @param ts transaction set
* @param tag rpm tag
@@ -75,35 +76,35 @@ rpmgi rpmgiFree(rpmgi gi);
rpmgi rpmgiNew(rpmts ts, int tag, const void * keyp,
size_t keylen);
-/**
+/** \ingroup rpmgi
* Perform next iteration step.
* @param gi generalized iterator
* @returns RPMRC_OK on success, RPMRC_NOTFOUND on EOI
*/
rpmRC rpmgiNext(rpmgi gi);
-/**
+/** \ingroup rpmgi
* Return current header path.
* @param gi generalized iterator
* @returns header path
*/
const char * rpmgiHdrPath(rpmgi gi);
-/**
+/** \ingroup rpmgi
* Return current iteration header.
* @param gi generalized iterator
* @returns header
*/
Header rpmgiHeader(rpmgi gi);
-/**
+/** \ingroup rpmgi
* Return current iteration transaction set.
* @param gi generalized iterator
* @returns transaction set
*/
rpmts rpmgiTs(rpmgi gi);
-/**
+/** \ingroup rpmgi
* Load iterator args.
* @param gi generalized iterator
* @param argv arg list