doxygen cleanup.

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

14 files changed, 56 insertions, 34 deletions

diff --git a/lib/cpio.c b/lib/cpio.c
index 41488ddbd..c090d3a18 100644
--- a/lib/cpio.c
+++ b/lib/cpio.c
@@ -17,8 +17,8 @@
 
 /**
  * Convert string to unsigned integer (with buffer size check).
- * @param		input string
- * @retval		address of 1st character not processed
+ * @param str		input string
+ * @retval endptr	address of 1st character not processed
  * @param base		numerical conversion base
  * @param num		max no. of bytes to read
  * @return		converted integer
diff --git a/lib/cpio.h b/lib/cpio.h
index 53f773487..b0f2154f2 100644
--- a/lib/cpio.h
+++ b/lib/cpio.h
@@ -112,6 +112,7 @@ int cpioTrailerWrite(FSM_t fsm)
 /**
  * Write cpio header.
  * @retval fsm		file path and stat info
+ * @param st
  * @return		0 on success
  */
 int cpioHeaderWrite(FSM_t fsm, struct stat * st)
@@ -121,6 +122,7 @@ int cpioHeaderWrite(FSM_t fsm, struct stat * st)
 /**
  * Read cpio header.
  * @retval fsm		file path and stat info
+ * @retval st
  * @return		0 on success
  */
 int cpioHeaderRead(FSM_t fsm, struct stat * st)
@@ -129,7 +131,7 @@ int cpioHeaderRead(FSM_t fsm, struct stat * st)
 
 /** \ingroup payload
  * Return formatted error message on payload handling failure.
- * @param		error code
+ * @param rc		error code
  * @return		formatted error string
  */
 /*@observer@*/ const char *const cpioStrerror(int rc)		/*@*/;
diff --git a/lib/depends.c b/lib/depends.c
index eb7a232de..2b7bc893c 100644
--- a/lib/depends.c
+++ b/lib/depends.c
@@ -316,7 +316,7 @@ int rpmtransRemovePackage(rpmTransactionSet ts, Header h, int dboffset)
 /**
  * Check key for an unsatisfied dependency.
  * @todo Eliminate rpmrc provides.
- * @param al		available list
+ * @param ts		transaction set
  * @param key		dependency
  * @return		0 if satisfied, 1 if not satisfied, 2 if error
  */
@@ -832,6 +832,7 @@ static inline /*@observer@*/ const char * const identifyDepend(int_32 f)
  * pure Requires: dependencies) successor node(s).
  * @param q		sucessor (i.e. package required by p)
  * @param p		predecessor (i.e. package that "Requires: q")
+ * @param requires	relation
  * @param zap		max. no. of co-requisites to remove (-1 is all)?
  * @retval nzaps	address of no. of relations removed
  * @return		(possibly NULL) formatted "q <- p" releation (malloc'ed)
@@ -912,7 +913,7 @@ if (_tso_debug) {
  * @param ts		transaction set
  * @param p		predecessor (i.e. package that "Requires: q")
  * @param selected	boolean package selected array
- * @param j		relation index
+ * @param requires	relation
  * @return		0 always
  */
 /*@-mustmod@*/
@@ -1018,8 +1019,8 @@ prtTSI(NULL, teGetTSI(q));
 
 /**
  * Compare ordered list entries by index (qsort/bsearch).
- * @param a		1st ordered list entry
- * @param b		2nd ordered list entry
+ * @param one		1st ordered list entry
+ * @param two		2nd ordered list entry
  * @return		result of comparison
  */
 static int orderListIndexCmp(const void * one, const void * two)	/*@*/
diff --git a/lib/formats.c b/lib/formats.c
index 91fb26de5..c55c1fb99 100644
--- a/lib/formats.c
+++ b/lib/formats.c
@@ -300,11 +300,12 @@ static /*@only@*/ char * depflagsFormat(int_32 type, const void * data,
 }
 
 /**
+ * Retrieve mounted file system paths.
  * @param h		header
  * @retval type		address of tag type
  * @retval data		address of tag value pointer
  * @retval count	address of no. of data items
- * @retval freedata	address of data-was-malloc'ed indicator
+ * @retval freeData	address of data-was-malloc'ed indicator
  * @return		0 on success
  */
 static int fsnamesTag( /*@unused@*/ Header h, /*@out@*/ int_32 * type,
@@ -329,11 +330,12 @@ static int fsnamesTag( /*@unused@*/ Header h, /*@out@*/ int_32 * type,
 }
 
 /**
+ * Retrieve install prefixes.
  * @param h		header
  * @retval type		address of tag type
  * @retval data		address of tag value pointer
  * @retval count	address of no. of data items
- * @retval freedata	address of data-was-malloc'ed indicator
+ * @retval freeData	address of data-was-malloc'ed indicator
  * @return		0 on success
  */
 static int instprefixTag(Header h, /*@null@*/ /*@out@*/ rpmTagType * type,
@@ -362,11 +364,12 @@ static int instprefixTag(Header h, /*@null@*/ /*@out@*/ rpmTagType * type,
 }
 
 /**
+ * Retrieve mounted file system space.
  * @param h		header
  * @retval type		address of tag type
  * @retval data		address of tag value pointer
  * @retval count	address of no. of data items
- * @retval freedata	address of data-was-malloc'ed indicator
+ * @retval freeData	address of data-was-malloc'ed indicator
  * @return		0 on success
  */
 static int fssizesTag(Header h, /*@out@*/ rpmTagType * type,
@@ -416,11 +419,12 @@ static int fssizesTag(Header h, /*@out@*/ rpmTagType * type,
 }
 
 /**
+ * Retrieve trigger info.
  * @param h		header
  * @retval type		address of tag type
  * @retval data		address of tag value pointer
  * @retval count	address of no. of data items
- * @retval freedata	address of data-was-malloc'ed indicator
+ * @retval freeData	address of data-was-malloc'ed indicator
  * @return		0 on success
  */
 static int triggercondsTag(Header h, /*@out@*/ rpmTagType * type,
@@ -488,11 +492,12 @@ static int triggercondsTag(Header h, /*@out@*/ rpmTagType * type,
 }
 
 /**
+ * Retrieve trigger type info.
  * @param h		header
  * @retval type		address of tag type
  * @retval data		address of tag value pointer
  * @retval count	address of no. of data items
- * @retval freedata	address of data-was-malloc'ed indicator
+ * @retval freeData	address of data-was-malloc'ed indicator
  * @return		0 on success
  */
 static int triggertypeTag(Header h, /*@out@*/ rpmTagType * type,
@@ -541,11 +546,12 @@ static int triggertypeTag(Header h, /*@out@*/ rpmTagType * type,
 }
 
 /**
+ * Retrieve file paths.
  * @param h		header
  * @retval type		address of tag type
  * @retval data		address of tag value pointer
  * @retval count	address of no. of data items
- * @retval freedata	address of data-was-malloc'ed indicator
+ * @retval freeData	address of data-was-malloc'ed indicator
  * @return		0 on success
  */
 static int filenamesTag(Header h, /*@out@*/ rpmTagType * type,
@@ -577,12 +583,13 @@ static const char * _macro_i18ndomains =
 		"%{?_i18ndomains:%{_i18ndomains}}";
 
 /**
+ * Retrieve i18n text.
  * @param h		header
  * @param tag		tag
  * @retval type		address of tag type
  * @retval data		address of tag value pointer
  * @retval count	address of no. of data items
- * @retval freedata	address of data-was-malloc'ed indicator
+ * @retval freeData	address of data-was-malloc'ed indicator
  * @return		0 on success
  */
 static int i18nTag(Header h, int_32 tag, /*@out@*/ rpmTagType * type,
@@ -665,11 +672,12 @@ static int i18nTag(Header h, int_32 tag, /*@out@*/ rpmTagType * type,
 }
 
 /**
+ * Retrieve summary text.
  * @param h		header
  * @retval type		address of tag type
  * @retval data		address of tag value pointer
  * @retval count	address of no. of data items
- * @retval freedata	address of data-was-malloc'ed indicator
+ * @retval freeData	address of data-was-malloc'ed indicator
  * @return		0 on success
  */
 static int summaryTag(Header h, /*@out@*/ rpmTagType * type,
@@ -682,11 +690,12 @@ static int summaryTag(Header h, /*@out@*/ rpmTagType * type,
 }
 
 /**
+ * Retrieve description text.
  * @param h		header
  * @retval type		address of tag type
  * @retval data		address of tag value pointer
  * @retval count	address of no. of data items
- * @retval freedata	address of data-was-malloc'ed indicator
+ * @retval freeData	address of data-was-malloc'ed indicator
  * @return		0 on success
  */
 static int descriptionTag(Header h, /*@out@*/ rpmTagType * type,
@@ -699,11 +708,12 @@ static int descriptionTag(Header h, /*@out@*/ rpmTagType * type,
 }
 
 /**
+ * Retrieve group text.
  * @param h		header
  * @retval type		address of tag type
  * @retval data		address of tag value pointer
  * @retval count	address of no. of data items
- * @retval freedata	address of data-was-malloc'ed indicator
+ * @retval freeData	address of data-was-malloc'ed indicator
  * @return		0 on success
  */
 static int groupTag(Header h, /*@out@*/ rpmTagType * type,
diff --git a/lib/fsm.c b/lib/fsm.c
index 2bace93df..d4e567d51 100644
--- a/lib/fsm.c
+++ b/lib/fsm.c
@@ -101,8 +101,8 @@ static /*@null@*/ void * mapFreeIterator(/*@only@*//*@null@*/ void * p)
 
 /** \ingroup payload
  * Create file info iterator.
- * @param a		transaction set
- * @param b		transaction element file info
+ * @param ts		transaction set
+ * @param fi		transaction element file info
  * @return		file info iterator
  */
 static void *
diff --git a/lib/fsm.h b/lib/fsm.h
index 4bc502e9d..977f3f905 100644
--- a/lib/fsm.h
+++ b/lib/fsm.h
@@ -233,6 +233,7 @@ extern "C" {
  * @param goal
  * @param ts		transaction set
  * @param fi		transaction element file info
+ * @param cfd
  * @param archiveSize	pointer to archive size
  * @param failedFile	pointer to first file name that failed.
  * @return		0 on success
diff --git a/lib/misc.h b/lib/misc.h
index b530c4000..de679b8e0 100644
--- a/lib/misc.h
+++ b/lib/misc.h
@@ -47,7 +47,7 @@ void freeSplitString( /*@only@*/ char ** list)
  * Like the libc function, but malloc()'s the space needed.
  * @param name		variable name
  * @param value		variable value
- * @param overwrte	should an existing variable be changed?
+ * @param overwrite	should an existing variable be changed?
  * @return		0 on success
  */
 int dosetenv(const char * name, const char * value, int overwrite)
diff --git a/lib/psm.c b/lib/psm.c
index de42f8e32..1f6e340da 100644
--- a/lib/psm.c
+++ b/lib/psm.c
@@ -150,9 +150,9 @@ static int rpmInstallLoadMacros(TFI_t fi, Header h)
 
 /**
  * Copy file data from h to newH.
+ * @param fi		transaction element file info
  * @param h		header from
  * @param newH		header to
- * @param actions	array of file dispositions
  * @return		0 on success, 1 on failure
  */
 static int mergeFiles(TFI_t fi, Header h, Header newH)
diff --git a/lib/psm.h b/lib/psm.h
index 165d6144f..09685ceea 100644
--- a/lib/psm.h
+++ b/lib/psm.h
@@ -101,7 +101,7 @@ extern "C" {
 
 /**
  * Return formatted string representation of package disposition.
- * @param a		package dispostion
+ * @param fi
  * @return		formatted string
  */
 /*@observer@*/ const char *const fiTypeString(/*@partial@*/TFI_t fi)
diff --git a/lib/rpmcli.h b/lib/rpmcli.h
index 080fac164..71c5a5d8e 100644
--- a/lib/rpmcli.h
+++ b/lib/rpmcli.h
@@ -410,7 +410,7 @@ extern int packagesTotal;
  * @param what		callback identifier
  * @param amount	per-callback progress info
  * @param total		per-callback progress info
- * @param pkgkey	opaque header key (e.g. file name or PyObject)
+ * @param key		opaque header key (e.g. file name or PyObject)
  * @param data		private data (e.g. rpmInstallInterfaceFlags)
  * @return		per-callback data (e.g. an opened FD_t)
  */
@@ -477,9 +477,8 @@ int rpmInstall(rpmTransactionSet ts, struct rpmInstallArguments_s * ia,
 /** \ingroup rpmcli
  * Erase binary rpm package.
  * @param ts		transaction set
+ * @param ia		control args/bits
  * @param argv		array of package file names (NULL terminated)
- * @param transFlags	bits to control rpmRunTransactions()
- * @param interfaceFlags bits to control rpmInstall()
  * @return		0 on success
  */
 int rpmErase(rpmTransactionSet ts, const struct rpmInstallArguments_s * ia,
diff --git a/lib/rpmds.h b/lib/rpmds.h
index c3161ed00..fb31763cd 100644
--- a/lib/rpmds.h
+++ b/lib/rpmds.h
@@ -39,6 +39,7 @@ extern "C" {
 /**
  * Unreference a dependency set instance.
  * @param ds		dependency set
+ * @param msg
  * @return		NULL always
  */
 /*@unused@*/ /*@null@*/
@@ -58,6 +59,7 @@ rpmDepSet XrpmdsUnlink (/*@killref@*/ /*@only@*/ /*@null@*/ rpmDepSet ds,
 /**
  * Reference a dependency set instance.
  * @param ds		dependency set
+ * @param msg
  * @return		new dependency set reference
  */
 /*@unused@*/
@@ -231,7 +233,7 @@ void dsProblem(/*@null@*/ rpmProblemSet tsprobs,
 /**
  * Compare package provides dependencies from header with a single dependency.
  * @param h		header
- * @param ds		dependency set
+ * @param req		dependency set
  */
 int rangeMatchesDepFlags (Header h, const rpmDepSet req)
         /*@modifies h @*/;
diff --git a/lib/rpmlib.h b/lib/rpmlib.h
index a74ba248d..6a91d22f6 100644
--- a/lib/rpmlib.h
+++ b/lib/rpmlib.h
@@ -665,6 +665,7 @@ extern int dbiTagsMax;
 /** \ingroup rpmdb
  * Unreference a database instance.
  * @param db		rpm database
+ * @param msg
  * @return		NULL always
  */
 /*@unused@*/ /*@null@*/
@@ -681,6 +682,7 @@ rpmdb XrpmdbUnlink (/*@killref@*/ /*@only@*/ rpmdb db, const char * msg,
 /** \ingroup rpmdb
  * Reference a database instance.
  * @param db		rpm database
+ * @param msg
  * @return		new rpm database reference
  */
 /*@unused@*/
@@ -1030,6 +1032,7 @@ void printDepProblems(FILE * fp, rpmProblem probs, int numProblems)
 /**
  * Unreference a problem set instance.
  * @param ps		problem set
+ * @param msg
  * @return		NULL always
  */
 /*@unused@*/ /*@null@*/
@@ -1047,6 +1050,7 @@ rpmProblemSet XrpmpsUnlink (/*@killref@*/ /*@only@*/ rpmProblemSet ps,
 /**
  * Reference a problem set instance.
  * @param ps		transaction set
+ * @param msg
  * @return		new transaction set reference
  */
 /*@unused@*/
@@ -1087,7 +1091,7 @@ void rpmProblemPrint(FILE *fp, rpmProblem prob)
 /**
  * Print problems to file handle.
  * @param fp		file handle
- * @param probs		problem set
+ * @param ps		problem set
  */
 void rpmProblemSetPrint(FILE *fp, rpmProblemSet ps)
 	/*@globals fileSystem @*/
@@ -1305,6 +1309,7 @@ rpmRC rpmInstallSourcePackage(rpmTransactionSet ts, FD_t fd,
 /** \ingroup rpmtrans
  * Unreference a transaction instance.
  * @param ts		transaction set
+ * @param msg
  * @return		NULL always
  */
 /*@unused@*/ /*@null@*/
@@ -1322,6 +1327,7 @@ rpmTransactionSet XrpmtsUnlink (/*@killref@*/ /*@only@*/ rpmTransactionSet ts,
 /** \ingroup rpmtrans
  * Reference a transaction set instance.
  * @param ts		transaction set
+ * @param msg
  * @return		new transaction set reference
  */
 /*@unused@*/
@@ -1370,7 +1376,7 @@ rpmdbMatchIterator rpmtsInitIterator(const rpmTransactionSet ts, int rpmtag,
 /** \ingroup rpmtrans
  * Create an empty transaction set.
  * @param db		rpm database (may be NULL if database is not accessed)
- * @param rootdir	path to top of install tree
+ * @param rootDir	path to top of install tree
  * @return		transaction set
  */
 /*@only@*/ rpmTransactionSet rpmtransCreateSet(
@@ -1575,9 +1581,9 @@ typedef enum rpmtransFlags_e {
 
 /** \ingroup rpmtrans
  * Return copy of rpmlib internal provides.
- * @retval		address of array of rpmlib internal provide names
- * @retval		address of array of rpmlib internal provide flags
- * @retval		address of array of rpmlib internal provide versions
+ * @retval provNames	address of array of rpmlib internal provide names
+ * @retval provFlags	address of array of rpmlib internal provide flags
+ * @retval provVersions	address of array of rpmlib internal provide versions
  * @return		no. of entries
  */
 /*@unused@*/
@@ -1670,7 +1676,6 @@ int rpmtsSetNotifyCallback(rpmTransactionSet ts,
  * @param ts		transaction set
  * @param okProbs	previously known problems (or NULL)
  * @retval newProbs	address to return unfiltered problems (or NULL)
- * @param transFlags	bits to control rpmRunTransactions()
  * @param ignoreSet	bits to filter problem types
  * @return		0 on success, -1 on error, >0 with newProbs set
  */
@@ -1697,7 +1702,7 @@ int rpmRunTransactions(rpmTransactionSet ts,
 
 /**
  * Return value of tag from name.
- * @param targstr	name of tag
+ * @param tagstr	name of tag
  * @return		tag value
  */
 int tagValue(const char *tagstr)
diff --git a/lib/signature.c b/lib/signature.c
index 4438b1248..3c8572663 100644
--- a/lib/signature.c
+++ b/lib/signature.c
@@ -859,6 +859,7 @@ exit:
  * Verify header immutable region SHA1 digest.
  * @param ts		transaction set
  * @retval t		verbose success/failure text
+ * @param sha1ctx
  * @return 		RPMSIG_OK on success
  */
 static rpmVerifySignatureReturn
@@ -1043,6 +1044,7 @@ static inline unsigned char nibble(char c)
  * Verify PGP (aka RSA/MD5) signature.
  * @param ts		transaction set
  * @retval t		verbose success/failure text
+ * @param md5ctx
  * @return 		RPMSIG_OK on success
  */
 static rpmVerifySignatureReturn
@@ -1151,6 +1153,7 @@ exit:
  * Verify GPG (aka DSA) signature.
  * @param ts		transaction set
  * @retval t		verbose success/failure text
+ * @param sha1ctx
  * @return 		RPMSIG_OK on success
  */
 static rpmVerifySignatureReturn
diff --git a/lib/verify.c b/lib/verify.c
index e2d8ad67f..56ece5423 100644
--- a/lib/verify.c
+++ b/lib/verify.c
@@ -198,7 +198,6 @@ int rpmVerifyFile(const rpmTransactionSet ts, const TFI_t fi,
  * @todo malloc/free/refcount handling is fishy here.
  * @param qva		parsed query/verify options
  * @param ts		transaction set
- * @param h             header
  * @param fi		file info set
  * @param scriptFd      file handle to use for stderr (or NULL)
  * @return              0 on success