Doxygen annotations.

CVS patchset: 4130
CVS date: 2000/08/27 19:18:25

5 files changed, 39 insertions, 15 deletions

diff --git a/lib/cpio.c b/lib/cpio.c
index b5c616317..06ca42327 100644
--- a/lib/cpio.c
+++ b/lib/cpio.c
@@ -1,7 +1,8 @@
-/** \file lib/cpio.c
+/** \ingroup payload rpmio
+ * \file lib/cpio.c
  *  Handle cpio payloads within rpm packages.
  *
- * @warning FIXME: We don't translate between cpio and system mode bits! These
+ * \warning FIXME: We don't translate between cpio and system mode bits! These
  * should both be the same, but really odd things are going to happen if
  * that's not true!
  */
@@ -16,7 +17,7 @@
 #define CPIO_CRC_MAGIC	"070702"
 #define TRAILER		"TRAILER!!!"
 
-/**
+/** \ingroup payload
  * Keeps track of set of all hard linked files in archive.
  */
 struct hardLink {
@@ -33,7 +34,7 @@ struct hardLink {
 
 enum hardLinkType { HARDLINK_INSTALL=1, HARDLINK_BUILD };
 
-/**
+/** \ingroup payload
  * Cpio archive header information.
  */
 struct cpioCrcPhysicalHeader {
@@ -55,7 +56,7 @@ struct cpioCrcPhysicalHeader {
 
 #define	PHYS_HDR_SIZE	110		/* don't depend on sizeof(struct) */
 
-/**
+/** \ingroup payload
  * File name and stat information.
  */
 struct cpioHeader {
diff --git a/lib/cpio.h b/lib/cpio.h
index a10448a53..887a22525 100644
--- a/lib/cpio.h
+++ b/lib/cpio.h
@@ -1,7 +1,8 @@
 #ifndef H_CPIO
 #define H_CPIO
 
-/** \file lib/cpio.h
+/** \ingroup payload
+ * \file lib/cpio.h
  *  Structures used to handle cpio payloads within rpm packages.
  *
  *  Warning: Don't think that rpm's cpio implementation behaves just like
@@ -17,7 +18,7 @@
 
 #include <rpmio_internal.h>
 
-/**
+/** \ingroup payload
  * Note:  CPIO_CHECK_ERRNO bit is set only if errno is valid. These have to
  * be positive numbers or this setting the high bit stuff is a bad idea.
  */
@@ -53,7 +54,7 @@
 #define CPIO_FOLLOW_SYMLINKS	(1 << 4)  /* only for building */
 #define CPIO_MULTILIB		(1 << 31) /* internal, only for building */
 
-/**
+/** \ingroup payload
  * Defines a single file to be included in a cpio payload.
  */
 struct cpioFileMapping {
@@ -65,7 +66,7 @@ struct cpioFileMapping {
     int mapFlags;
 };
 
-/**
+/** \ingroup payload
  * The first argument passed in a cpio progress callback.
  *
  * Note: When building the cpio payload, only "file" is filled in.
@@ -81,11 +82,11 @@ struct cpioCallbackInfo {
 extern "C" {
 #endif
 
-/**
+/** \ingroup payload
  */
 typedef void (*cpioCallback) (struct cpioCallbackInfo * filespec, void * data);
 
-/**
+/** \ingroup payload
  * The RPM internal equivalent of the command line "cpio -i".
  * If no mappings are passed, this installs everything! If one is passed
  * it should be sorted according to cpioFileMapCmp() and only files included
@@ -108,7 +109,7 @@ int cpioInstallArchive(FD_t cfd, const struct cpioFileMapping * mappings,
 		       /*@out@*/const char ** failedFile)
 	/*@modifies fileSystem, cfd, *failedFile @*/;
 
-/**
+/** \ingroup payload
  * The RPM internal equivalent of the command line "cpio -o".
  *
  * @param cfd		file handle
@@ -124,7 +125,7 @@ int cpioBuildArchive(FD_t cfd, const struct cpioFileMapping * mappings,
 		     unsigned int * archiveSize, /*@out@*/const char ** failedFile)
 	/*@modifies fileSystem, cfd, *archiveSize, *failedFile @*/;
 
-/**
+/** \ingroup payload
  * Compare two cpio file map entries (qsort/bsearch).
  * This is designed to be qsort/bsearch compatible.
  * @param a		1st map
@@ -133,7 +134,7 @@ int cpioBuildArchive(FD_t cfd, const struct cpioFileMapping * mappings,
  */
 int cpioFileMapCmp(const void * a, const void * b)	/*@*/;
 
-/**
+/** \ingroup payload
  * Return fornmatted error message on payload handling failure.
  */
 /*@observer@*/ const char *cpioStrerror(int rc)		/*@*/;
diff --git a/lib/db1.c b/lib/db1.c
index 7de04d0db..8344773b7 100644
--- a/lib/db1.c
+++ b/lib/db1.c
@@ -1,5 +1,9 @@
 #include "system.h"
 
+/** \ingroup db1
+ * \file lib/db1.c
+ */
+
 static int _debug = 1;	/* XXX if < 0 debugging, > 0 unusual error returns */
 
 #include <db1/db.h>
@@ -37,6 +41,8 @@ static inline DBTYPE db3_to_dbtype(int dbitype)
     /*@notreached@*/ return DB_HASH;
 }
 
+/** \ingroup db1
+ */
 char * db1basename (int rpmtag) {
     char * base = NULL;
     switch (rpmtag) {
@@ -487,6 +493,8 @@ exit:
     return rc;
 }
 
+/** \ingroup db1
+ */
 struct _dbiVec db1vec = {
     DB_VERSION_MAJOR, DB_VERSION_MINOR, DB_VERSION_PATCH,
     db1open, db1close, db1sync, db1copen, db1cclose, db1cdel, db1cget, db1cput,
diff --git a/lib/db2.c b/lib/db2.c
index de6218c63..8359dd257 100644
--- a/lib/db2.c
+++ b/lib/db2.c
@@ -1,5 +1,9 @@
 #include "system.h"
 
+/** \ingroup db2
+ * \file lib/db2.c
+ */
+
 static int _debug = 1;	/* XXX if < 0 debugging, > 0 unusual error returns */
 
 #include <db2/db.h>
diff --git a/lib/db3.c b/lib/db3.c
index 50259dedd..78c51ac8c 100644
--- a/lib/db3.c
+++ b/lib/db3.c
@@ -1,5 +1,9 @@
 #include "system.h"
 
+/** \ingroup db3
+ * \file lib/db3.c
+ */
+
 static int _debug = 1;	/* XXX if < 0 debugging, > 0 unusual error returns */
 
 #ifdef	__LCLINT__
@@ -25,7 +29,9 @@ typedef	int int32_t;
 
 struct _dbiIndex db3dbi;
 
-/* Analogue to struct poptOption */
+/** \ingroup db3
+ *  Analogue to struct poptOption
+ */
 struct dbOption {
     const char * longName;	/* may be NULL */
     int argInfo;
@@ -36,6 +42,8 @@ struct dbOption {
 #define	_POPT_SET_BIT	(POPT_ARG_VAL|POPT_ARGFLAG_OR)
 
 /*@-immediatetrans@*/
+/** \ingroup db3
+ */
 struct dbOption rdbOptions[] = {
  /* XXX DB_CXX_NO_EXCEPTIONS */
  { "xa_create",	_POPT_SET_BIT,		&db3dbi.dbi_cflags, DB_XA_CREATE },
@@ -1168,6 +1176,8 @@ static int db3open(/*@keep@*/ rpmdb rpmdb, int rpmtag, dbiIndex * dbip)
     return rc;
 }
 
+/** \ingroup db3
+ */
 struct _dbiVec db3vec = {
     DB_VERSION_MAJOR, DB_VERSION_MINOR, DB_VERSION_PATCH,
     db3open, db3close, db3sync, db3copen, db3cclose, db3cdel, db3cget, db3cput,