doxygen cleanup.

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

5 files changed, 55 insertions, 10 deletions

diff --git a/build/buildio.h b/build/buildio.h
index e25f64a36..d5bc8a455 100644
--- a/build/buildio.h
+++ b/build/buildio.h
@@ -26,7 +26,7 @@ extern "C" {
 
 /**
  * Read rpm package components from file.
- * @param filename	file name of package (or NULL to use stdin)
+ * @param fileName	file name of package (or NULL to use stdin)
  * @retval specp	spec structure to carry package header (or NULL)
  * @retval lead		package lead
  * @retval sigs		package signature
@@ -50,7 +50,7 @@ extern "C" {
  * return a reloaded contiguous header to the caller.
  *
  * @retval hdrp		header to write (final header is returned).
- * @param filename	file name of package
+ * @param fileName	file name of package
  * @param type		RPMLEAD_SOURCE/RPMLEAD_BINARY
  * @param csa
  * @param passPhrase
diff --git a/build/files.c b/build/files.c
index a4d2f1dd9..e223024d9 100644
--- a/build/files.c
+++ b/build/files.c
@@ -298,7 +298,10 @@ VFA_t verifyAttrs[] = {
 /*@=exportlocal =exportheadervar@*/
 
 /**
+ * Parse %verify and %defverify from file manifest.
+ * @param buf
  * @param fl		package file tree walk data
+ * @return		0 on success
  */
 static int parseForVerify(char * buf, FileList fl)
 	/*@modifies buf, fl->processingFailed,
@@ -392,7 +395,9 @@ static int parseForVerify(char * buf, FileList fl)
 
 /**
  * Parse %dev from file manifest.
+ * @param buf
  * @param fl		package file tree walk data
+ * @return		0 on success
  */
 static int parseForDev(char * buf, FileList fl)
 	/*@modifies buf, fl->processingFailed,
@@ -490,7 +495,9 @@ exit:
 
 /**
  * Parse %attr and %defattr from file manifest.
+ * @param buf
  * @param fl		package file tree walk data
+ * @return		0 on success
  */
 static int parseForAttr(char * buf, FileList fl)
 	/*@modifies buf, fl->processingFailed,
@@ -618,7 +625,10 @@ static int parseForAttr(char * buf, FileList fl)
 }
 
 /**
+ * Parse %config from file manifest.
+ * @param buf
  * @param fl		package file tree walk data
+ * @return		0 on success
  */
 static int parseForConfig(char * buf, FileList fl)
 	/*@modifies buf, fl->processingFailed,
@@ -686,7 +696,10 @@ static int langCmp(const void * ap, const void * bp)	/*@*/
 }
 
 /**
+ * Parse %lang from file manifest.
+ * @param buf
  * @param fl		package file tree walk data
+ * @return		0 on success
  */
 static int parseForLang(char * buf, FileList fl)
 	/*@modifies buf, fl->processingFailed,
@@ -877,7 +890,13 @@ VFA_t virtualFileAttributes[] = {
 /*@=exportlocal =exportheadervar@*/
 
 /**
+ * Parse simple attributes (e.g. %dir) from file manifest.
+ & @param spec
+ & @param pkg
+ * @param buf
  * @param fl		package file tree walk data
+ * @retval fileName
+ * @return		0 on success
  */
 static int parseForSimple(/*@unused@*/Spec spec, Package pkg, char * buf,
 			  FileList fl, /*@out@*/ const char ** fileName)
@@ -1015,7 +1034,11 @@ static int compareFileListRecs(const void * ap, const void * bp)	/*@*/
 }
 
 /**
+ * Test if file is located in a %docdir.
+ * @bug Use of strstr(3) might result in false positives.
  * @param fl		package file tree walk data
+ * @param fileName	file path
+ * @return		1 if doc file, 0 if not
  */
 static int isDoc(FileList fl, const char * fileName)	/*@*/
 {
@@ -1062,9 +1085,13 @@ static int checkHardLinks(FileList fl)
 }
 
 /**
+ * Add file entries to header.
  * @todo Should directories have %doc/%config attributes? (#14531)
  * @todo Remove RPMTAG_OLDFILENAMES, add dirname/basename instead.
  * @param fl		package file tree walk data
+ * @param cpioList
+ * @param h
+ * @param isSrc
  */
 static void genCpioListAndHeader(/*@partial@*/ FileList fl,
 		TFI_t * cpioList, Header h, int isSrc)
@@ -1435,9 +1462,14 @@ static /*@null@*/ FileListRec freeFileList(/*@only@*/ FileListRec fileList,
 }
 
 /**
+ * Add a file to the package manifest.
  * @param fl		package file tree walk data
+ * @param diskURL	path to file
+ * @param statp		file stat (possibly NULL)
+ * @return		0 on success
  */
-static int addFile(FileList fl, const char * diskURL, struct stat * statp)
+static int addFile(FileList fl, const char * diskURL,
+		/*@null@*/ struct stat * statp)
 	/*@globals rpmGlobalMacroContext,
 		fileSystem@*/
 	/*@modifies *statp, *fl, fl->processingFailed,
@@ -1652,7 +1684,11 @@ static int addFile(FileList fl, const char * diskURL, struct stat * statp)
 }
 
 /**
+ * Add a file to a binary package.
+ * @param pkg
  * @param fl		package file tree walk data
+ * @param fileURL
+ * @return		0 on success
  */
 static int processBinaryFile(/*@unused@*/ Package pkg, FileList fl,
 		const char * fileURL)
diff --git a/build/rpmbuild.h b/build/rpmbuild.h
index 78cf189a1..769a9b729 100644
--- a/build/rpmbuild.h
+++ b/build/rpmbuild.h
@@ -89,7 +89,7 @@ void freeNames(void)
 /** \ingroup rpmbuild
  * Return cached user name from user id.
  * @todo Implement using hash.
- * @param		user id
+ * @param uid		user id
  * @return		cached user name
  */
 extern /*@observer@*/ const char * getUname(uid_t uid)	/*@*/;
@@ -97,7 +97,7 @@ extern /*@observer@*/ const char * getUname(uid_t uid)	/*@*/;
 /** \ingroup rpmbuild
  * Return cached user name.
  * @todo Implement using hash.
- * @param		user name
+ * @param uname		user name
  * @return		cached user name
  */
 extern /*@observer@*/ const char * getUnameS(const char * uname)	/*@*/;
@@ -105,7 +105,7 @@ extern /*@observer@*/ const char * getUnameS(const char * uname)	/*@*/;
 /** \ingroup rpmbuild
  * Return cached user id.
  * @todo Implement using hash.
- * @param		user name
+ * @param uname		user name
  * @return		cached uid
  */
 uid_t getUidS(const char * uname)	/*@*/;
@@ -113,7 +113,7 @@ uid_t getUidS(const char * uname)	/*@*/;
 /** \ingroup rpmbuild
  * Return cached group name from group id.
  * @todo Implement using hash.
- * @param		group id
+ * @param gid		group id
  * @return		cached group name
  */
 extern /*@observer@*/ const char * getGname(gid_t gid)		/*@*/;
@@ -121,7 +121,7 @@ extern /*@observer@*/ const char * getGname(gid_t gid)		/*@*/;
 /** \ingroup rpmbuild
  * Return cached group name.
  * @todo Implement using hash.
- * @param		group name
+ * @param gname		group name
  * @return		cached group name
  */
 extern /*@observer@*/ const char * getGnameS(const char * gname)	/*@*/;
@@ -129,7 +129,7 @@ extern /*@observer@*/ const char * getGnameS(const char * gname)	/*@*/;
 /** \ingroup rpmbuild
  * Return cached group id.
  * @todo Implement using hash.
- * @param		group name
+ * @param gname		group name
  * @return		cached gid
  */
 gid_t getGidS(const char * gname)	/*@*/;
diff --git a/build/rpmspec.h b/build/rpmspec.h
index 5d2bf192e..517e2fa02 100644
--- a/build/rpmspec.h
+++ b/build/rpmspec.h
@@ -211,12 +211,18 @@ struct OpenFileInfo * newOpenFileInfo(void)	/*@*/;
 
 /** \ingroup rpmbuild
  * @param spec		spec file control structure
+ * @param h
+ * @param tag
+ * @param lang
  */
 spectag stashSt(Spec spec, Header h, int tag, const char * lang)
 	/*@modifies spec->st @*/;
 
 /** \ingroup rpmbuild
  * @param spec		spec file control structure
+ * @param pkg
+ * @param field
+ * @param tag
  */
 int addSource(Spec spec, Package pkg, const char * field, int tag)
 	/*@globals rpmGlobalMacroContext @*/
@@ -227,6 +233,8 @@ int addSource(Spec spec, Package pkg, const char * field, int tag)
 
 /** \ingroup rpmbuild
  * @param spec		spec file control structure
+ * @param field
+ * @param tag
  */
 int parseNoSource(Spec spec, const char * field, int tag)
 	/*@modifies nothing @*/;
diff --git a/build/spec.c b/build/spec.c
index c57efb950..18280e7c8 100644
--- a/build/spec.c
+++ b/build/spec.c
@@ -19,6 +19,7 @@ extern int specedit;
 /*@access TFI_t @*/	/* compared with NULL */
 
 /**
+ * @param p		trigger entry chain
  * @return		NULL always
  */
 static inline
@@ -40,7 +41,7 @@ static inline
 
 /**
  * Destroy source component chain.
- * @param		source component chain
+ * @param s		source component chain
  * @return		NULL always
  */
 static inline