doxygen cleanup.

CVS patchset: 5379
CVS date: 2002/04/08 18:56:01

5 files changed, 27 insertions, 0 deletions

diff --git a/rpmdb/falloc.h b/rpmdb/falloc.h
index 23225c053..55c55c7a0 100644
--- a/rpmdb/falloc.h
+++ b/rpmdb/falloc.h
@@ -44,6 +44,7 @@ extern "C" {
 
 /** \ingroup db1
  * @param fd		file handle
+ * @param size
  * @return		0 on failure
  */
 unsigned int fadAlloc(FD_t fd, unsigned int size)
@@ -52,6 +53,7 @@ unsigned int fadAlloc(FD_t fd, unsigned int size)
 
 /** \ingroup db1
  * @param fd		file handle
+ * @param offset
  */
 void fadFree(FD_t fd, unsigned int offset)
 	/*@globals fileSystem @*/
@@ -66,6 +68,7 @@ int fadFirstOffset(FD_t fd)
 
 /** \ingroup db1
  * @param fd		file handle
+ * @param lastoff
  * @return		next offset, 0 to terminate
  */
 int fadNextOffset(FD_t fd, unsigned int lastoff)
diff --git a/rpmdb/hdrinline.h b/rpmdb/hdrinline.h
index 671bb2b1f..ebfb5164e 100644
--- a/rpmdb/hdrinline.h
+++ b/rpmdb/hdrinline.h
@@ -42,6 +42,9 @@ Header headerNew(void)
  * Dereference a header instance.
  * @todo Remove debugging entry from the ABI.
  * @param h		header
+ * @param msg
+ * @param fn
+ * @param ln
  * @return		NULL always
  */
 /*@unused@*/ static inline
@@ -59,6 +62,9 @@ Header headerNew(void)
  * Reference a header instance.
  * @todo Remove debugging entry from the ABI.
  * @param h		header
+ * @param msg
+ * @param fn
+ * @param ln
  * @return		new header reference
  */
 /*@unused@*/ static inline
@@ -73,6 +79,9 @@ Header XheaderLink(Header h, /*@null@*/ const char * msg,
  * Dereference a header instance.
  * @todo Remove debugging entry from the ABI.
  * @param h		header
+ * @param msg
+ * @param fn
+ * @param ln
  * @return		new header reference
  */
 /*@unused@*/ static inline
diff --git a/rpmdb/header_internal.h b/rpmdb/header_internal.h
index edb63b9d2..88fb9a15f 100644
--- a/rpmdb/header_internal.h
+++ b/rpmdb/header_internal.h
@@ -171,6 +171,7 @@ int headerGetRawEntry(Header h, int_32 tag,
 /** \ingroup header
  * Dump a header in human readable format (for debugging).
  * @param h		header
+ * @param f		file handle
  * @param flags		0 or HEADER_DUMP_INLINE
  * @param tags		array of tag name/value pairs
  */
diff --git a/rpmdb/legacy.h b/rpmdb/legacy.h
index 8648b9831..d0c6ac9cc 100644
--- a/rpmdb/legacy.h
+++ b/rpmdb/legacy.h
@@ -77,6 +77,8 @@ void expandFilelist(Header h)
 
 /**
  * @param h		header
+ * @retval fileListPtr	list of files
+ * @retval fileCountPtr	number of files
  */
 void buildOrigFileList(Header h, /*@out@*/ const char *** fileListPtr, 
 			/*@out@*/ int * fileCountPtr)
@@ -93,6 +95,7 @@ void providePackageNVR(Header h)
 /**
  * Do all necessary retorfits for a package header.
  * @param h		header
+ * @param lead
  */
 void legacyRetrofit(Header h, const struct rpmlead * lead)
 	/*@modifies h@*/;
diff --git a/rpmdb/rpmdb.h b/rpmdb/rpmdb.h
index 894afad36..f1e5f610a 100644
--- a/rpmdb/rpmdb.h
+++ b/rpmdb/rpmdb.h
@@ -351,6 +351,8 @@ extern "C" {
 /** \ingroup db3
  * Return new configured index database handle instance.
  * @param rpmdb		rpm database
+ * @param rpmtag
+ * @return		index database handle
  */
 /*@unused@*/ /*@only@*/ /*@null@*/
 dbiIndex db3New(rpmdb rpmdb, int rpmtag)
@@ -391,8 +393,11 @@ extern const char *const prDbiOpenFlags(int dbflags,
 	/*@modifies db @*/;
 
 /** \ingroup dbi
+ * Open a database cursor.
  * @param dbi		index database handle
+ * @retval dbcp		returned database cursor
  * @param flags		DBI_WRITECURSOR, DBI_ITERATOR or 0
+ * @return		0 on success
  */
 int dbiCopen(dbiIndex dbi, /*@out@*/ DBC ** dbcp, unsigned int flags)
 	/*@globals fileSystem@*/
@@ -402,8 +407,11 @@ int dbiCopen(dbiIndex dbi, /*@out@*/ DBC ** dbcp, unsigned int flags)
 #define	DBI_ITERATOR		(1 << 1)
 
 /** \ingroup dbi
+ * Close a database cursor.
  * @param dbi		index database handle
+ * @param dbcursor	database cursor
  * @param flags		(unused)
+ * @return		0 on success
  */
 int dbiCclose(dbiIndex dbi, /*@only@*/ DBC * dbcursor, unsigned int flags)
 	/*@globals fileSystem@*/
@@ -412,6 +420,7 @@ int dbiCclose(dbiIndex dbi, /*@only@*/ DBC * dbcursor, unsigned int flags)
 /** \ingroup dbi
  * Delete (key,data) pair(s) from index database.
  * @param dbi		index database handle
+ * @param dbcursor	database cursor
  * @param keyp		key data
  * @param keylen	key data length
  * @param flags		(unused)
@@ -425,6 +434,7 @@ int dbiDel(dbiIndex dbi, DBC * dbcursor, const void * keyp, size_t keylen,
 /** \ingroup dbi
  * Retrieve (key,data) pair from index database.
  * @param dbi		index database handle
+ * @param dbcursor	database cursor
  * @param keypp		address of key data
  * @param keylenp	address of key data length
  * @param datapp	address of data pointer
@@ -444,6 +454,7 @@ int dbiGet(dbiIndex dbi, DBC * dbcursor, void ** keypp,
 /** \ingroup dbi
  * Store (key,data) pair in index database.
  * @param dbi		index database handle
+ * @param dbcursor	database cursor
  * @param keyp		key data
  * @param keylen	key data length
  * @param datap		data pointer