From 8faa61c020369ecf850a823a505b946485fa1bea Mon Sep 17 00:00:00 2001 From: jbj Date: Wed, 20 Oct 2004 10:19:34 +0000 Subject: [PATCH] Doxygen fiddles. CVS patchset: 7495 CVS date: 2004/10/20 10:19:34 --- lib/cpio.h | 2 +- lib/depends.c | 1 + lib/rpmgi.h | 13 ++++++---- lib/rpmlib.h | 18 +++++++------- lib/rpmts.h | 2 +- lib/signature.h | 6 ++--- lib/transaction.c | 16 ++++++------ popt/popt.h | 2 +- python/rpmmodule.c | 2 +- rpmio/fts.h | 62 +++++++++++++++++++++++----------------------- rpmio/macro.c | 1 - rpmio/rpmio.c | 2 +- rpmio/rpmmacro.h | 2 +- 13 files changed, 66 insertions(+), 63 deletions(-) diff --git a/lib/cpio.h b/lib/cpio.h index b7362f138..c716097da 100644 --- a/lib/cpio.h +++ b/lib/cpio.h @@ -91,7 +91,7 @@ struct cpioCrcPhysicalHeader { char checksum[8]; /* ignored !! */ }; -#define PHYS_HDR_SIZE 110 /*!< Don't depend on sizeof(struct) */ +#define PHYS_HDR_SIZE 110 /* Don't depend on sizeof(struct) */ #ifdef __cplusplus extern "C" { diff --git a/lib/depends.c b/lib/depends.c index 8208cf816..a7d132e9f 100644 --- a/lib/depends.c +++ b/lib/depends.c @@ -946,6 +946,7 @@ static inline /*@observer@*/ const char * const identifyDepend(int_32 f) * @param requires relation * @param zap max. no. of co-requisites to remove (-1 is all)? * @retval nzaps address of no. of relations removed + * @param msglvl message level at which to spew * @return (possibly NULL) formatted "q <- p" releation (malloc'ed) */ /*@-boundswrite@*/ diff --git a/lib/rpmgi.h b/lib/rpmgi.h index e0d9d8bb1..ac883dbd0 100644 --- a/lib/rpmgi.h +++ b/lib/rpmgi.h @@ -2,7 +2,7 @@ #define H_RPMGI /** \ingroup rpmio - * \file rpmio/rpmgi.h + * \file lib/rpmgi.h */ #include @@ -105,10 +105,13 @@ rpmgi rpmgiFree(/*@killref@*/ /*@only@*/ /*@null@*/ rpmgi gi) /*@globals rpmGlobalMacroContext, h_errno, internalState @*/ /*@modifies gi, rpmGlobalMacroContext, h_errno, internalState @*/; -/** Create a generalized iterator. - * @param argv iterator argv array - * @param flags iterator flags - * @return new general iterator +/** + * Return a generalized iterator. + * @param ts transaction set + * @param tag rpm tag + * @param keyp key data (NULL for sequential access) + * @param keylen key data length (0 will use strlen(keyp)) + * @return new iterator */ /*@null@*/ rpmgi rpmgiNew(rpmts ts, int tag, /*@null@*/ const void * keyp, size_t keylen) diff --git a/lib/rpmlib.h b/lib/rpmlib.h index b6c714088..0a2447092 100644 --- a/lib/rpmlib.h +++ b/lib/rpmlib.h @@ -214,15 +214,15 @@ extern const struct headerSprintfExtension_s rpmHeaderFormats[]; /** * Pseudo-tags used by the rpmdb and rpmgi iterator API's. */ -#define RPMDBI_PACKAGES 0 /*!< Installed package headers. */ -#define RPMDBI_DEPENDS 1 /*!< Dependency resolution cache. */ -#define RPMDBI_LABEL 2 /*!< Fingerprint search marker. */ -#define RPMDBI_ADDED 3 /*!< Added package headers. */ -#define RPMDBI_REMOVED 4 /*!< Removed package headers. */ -#define RPMDBI_AVAILABLE 5 /*!< Available package headers. */ -#define RPMDBI_HDLIST 6 /*!< (rpmgi) Header list. */ -#define RPMDBI_ARGLIST 7 /*!< (rpmgi) Argument list. */ -#define RPMDBI_FTSWALK 8 /*!< (rpmgi) File tree walk. */ +#define RPMDBI_PACKAGES 0 /* Installed package headers. */ +#define RPMDBI_DEPENDS 1 /* Dependency resolution cache. */ +#define RPMDBI_LABEL 2 /* Fingerprint search marker. */ +#define RPMDBI_ADDED 3 /* Added package headers. */ +#define RPMDBI_REMOVED 4 /* Removed package headers. */ +#define RPMDBI_AVAILABLE 5 /* Available package headers. */ +#define RPMDBI_HDLIST 6 /* (rpmgi) Header list. */ +#define RPMDBI_ARGLIST 7 /* (rpmgi) Argument list. */ +#define RPMDBI_FTSWALK 8 /* (rpmgi) File tree walk. */ /** * Tags identify data in package headers. diff --git a/lib/rpmts.h b/lib/rpmts.h index f1cf55c9e..f209c7d39 100644 --- a/lib/rpmts.h +++ b/lib/rpmts.h @@ -576,7 +576,7 @@ rpmtsType rpmtsGetType(rpmts ts) * RPMTRANS_TYPE_AUTOROLLBACK * * @param ts transaction set - * @param rollback rpmtsType + * @param type transaction type * @return void */ void rpmtsSetType(rpmts ts, rpmtsType type) diff --git a/lib/signature.h b/lib/signature.h index 036af89fc..df81ca456 100644 --- a/lib/signature.h +++ b/lib/signature.h @@ -79,9 +79,9 @@ int rpmAddSignature(Header sig, const char * file, /** * Possible actions for rpmLookupSignatureType() */ -#define RPMLOOKUPSIG_QUERY 0 /*!< Lookup type in effect */ -#define RPMLOOKUPSIG_DISABLE 1 /*!< Disable (--sign was not given) */ -#define RPMLOOKUPSIG_ENABLE 2 /*!< Re-enable %_signature */ +#define RPMLOOKUPSIG_QUERY 0 /* Lookup type in effect */ +#define RPMLOOKUPSIG_DISABLE 1 /* Disable (--sign was not given) */ +#define RPMLOOKUPSIG_ENABLE 2 /* Re-enable %_signature */ /** \ingroup signature * Return type of signature needed for signing/building. diff --git a/lib/transaction.c b/lib/transaction.c index 935ecdfa0..09d5319b0 100644 --- a/lib/transaction.c +++ b/lib/transaction.c @@ -1091,15 +1091,15 @@ static rpmRC _rpmtsRollback(rpmts rollbackTransaction) * be made more efficient (only create on per running transaction). * @param ts rpm transaction * @param te transaction element - * @return hdrp Repackaged header - * @return fn Repackaged package's path (transaction key) + * @retval hdrp Repackaged header + * @retval fnp Repackaged package's path (transaction key) * @return RPMRC_NOTFOUND or RPMRC_OK */ static rpmRC getRepackageHeaderFromTE(rpmts ts, rpmte te, /*@out@*/ /*@null@*/ Header *hdrp, - /*@out@*/ /*@null@*/ const char **fn) + /*@out@*/ /*@null@*/ const char **fnp) /*@globals rpmGlobalMacroContext, h_errno, fileSystem, internalState @*/ - /*@modifies ts, *hdrp, *fn, + /*@modifies ts, *hdrp, *fnp, rpmGlobalMacroContext, fileSystem, internalState @*/ { int_32 tid; @@ -1122,8 +1122,8 @@ static rpmRC getRepackageHeaderFromTE(rpmts ts, rpmte te, /* Set header pointer to null if its not already */ if (hdrp) *hdrp = NULL; - if (fn) - *fn = NULL; + if (fnp) + *fnp = NULL; /* Get the TID of the current transaction */ tid = rpmtsGetTid(ts); @@ -1213,8 +1213,8 @@ exit: if (hdrp != NULL) *hdrp = headerLink(h); /*@-branchstate@*/ - if (fn != NULL) - *fn = rp; + if (fnp != NULL) + *fnp = rp; else rp = _free(rp); /*@=branchstate@*/ diff --git a/popt/popt.h b/popt/popt.h index 3eac333c6..9872a5e77 100644 --- a/popt/popt.h +++ b/popt/popt.h @@ -131,7 +131,7 @@ struct poptOption { struct poptAlias { /*@owned@*/ /*@null@*/ const char * longName; /*!< may be NULL */ - char shortName; /*!< may be '\0' */ + char shortName; /*!< may be NUL */ int argc; /*@owned@*/ const char ** argv; /*!< must be free()able */ diff --git a/python/rpmmodule.c b/python/rpmmodule.c index 751d59e79..7cd6e5031 100644 --- a/python/rpmmodule.c +++ b/python/rpmmodule.c @@ -1,5 +1,5 @@ /** \ingroup py_c - * \file python/_rpmmodule.c + * \file python/rpmmodule.c */ #include "system.h" diff --git a/rpmio/fts.h b/rpmio/fts.h index ff9c613da..7429101a1 100644 --- a/rpmio/fts.h +++ b/rpmio/fts.h @@ -94,18 +94,18 @@ typedef struct { /*@globals fileSystem @*/ /*@modifies *st, fileSystem @*/; -#define FTS_COMFOLLOW 0x0001 /*!< follow command line symlinks */ -#define FTS_LOGICAL 0x0002 /*!< logical walk */ -#define FTS_NOCHDIR 0x0004 /*!< don't change directories */ -#define FTS_NOSTAT 0x0008 /*!< don't get stat info */ -#define FTS_PHYSICAL 0x0010 /*!< physical walk */ -#define FTS_SEEDOT 0x0020 /*!< return dot and dot-dot */ -#define FTS_XDEV 0x0040 /*!< don't cross devices */ -#define FTS_WHITEOUT 0x0080 /*!< return whiteout information */ -#define FTS_OPTIONMASK 0x00ff /*!< valid user option mask */ +#define FTS_COMFOLLOW 0x0001 /* follow command line symlinks */ +#define FTS_LOGICAL 0x0002 /* logical walk */ +#define FTS_NOCHDIR 0x0004 /* don't change directories */ +#define FTS_NOSTAT 0x0008 /* don't get stat info */ +#define FTS_PHYSICAL 0x0010 /* physical walk */ +#define FTS_SEEDOT 0x0020 /* return dot and dot-dot */ +#define FTS_XDEV 0x0040 /* don't cross devices */ +#define FTS_WHITEOUT 0x0080 /* return whiteout information */ +#define FTS_OPTIONMASK 0x00ff /* valid user option mask */ -#define FTS_NAMEONLY 0x0100 /*!< (private) child names only */ -#define FTS_STOP 0x0200 /*!< (private) unrecoverable error */ +#define FTS_NAMEONLY 0x0100 /* (private) child names only */ +#define FTS_STOP 0x0200 /* (private) unrecoverable error */ int fts_options; /*!< fts_open options, global flags */ } FTS; @@ -136,30 +136,30 @@ typedef struct _ftsent { #define FTS_ROOTLEVEL 0 short fts_level; /*!< depth (-1 to N) */ -#define FTS_D 1 /*!< preorder directory */ -#define FTS_DC 2 /*!< directory that causes cycles */ -#define FTS_DEFAULT 3 /*!< none of the above */ -#define FTS_DNR 4 /*!< unreadable directory */ -#define FTS_DOT 5 /*!< dot or dot-dot */ -#define FTS_DP 6 /*!< postorder directory */ -#define FTS_ERR 7 /*!< error; errno is set */ -#define FTS_F 8 /*!< regular file */ -#define FTS_INIT 9 /*!< initialized only */ -#define FTS_NS 10 /*!< stat(2) failed */ -#define FTS_NSOK 11 /*!< no stat(2) requested */ -#define FTS_SL 12 /*!< symbolic link */ -#define FTS_SLNONE 13 /*!< symbolic link without target */ -#define FTS_W 14 /*!< whiteout object */ +#define FTS_D 1 /* preorder directory */ +#define FTS_DC 2 /* directory that causes cycles */ +#define FTS_DEFAULT 3 /* none of the above */ +#define FTS_DNR 4 /* unreadable directory */ +#define FTS_DOT 5 /* dot or dot-dot */ +#define FTS_DP 6 /* postorder directory */ +#define FTS_ERR 7 /* error; errno is set */ +#define FTS_F 8 /* regular file */ +#define FTS_INIT 9 /* initialized only */ +#define FTS_NS 10 /* stat(2) failed */ +#define FTS_NSOK 11 /* no stat(2) requested */ +#define FTS_SL 12 /* symbolic link */ +#define FTS_SLNONE 13 /* symbolic link without target */ +#define FTS_W 14 /* whiteout object */ u_short fts_info; /*!< user flags for FTSENT structure */ -#define FTS_DONTCHDIR 0x01 /*!< don't chdir .. to the parent */ -#define FTS_SYMFOLLOW 0x02 /*!< followed a symlink to get here */ +#define FTS_DONTCHDIR 0x01 /* don't chdir .. to the parent */ +#define FTS_SYMFOLLOW 0x02 /* followed a symlink to get here */ u_short fts_flags; /*!< private flags for FTSENT structure */ -#define FTS_AGAIN 1 /*!< read node again */ -#define FTS_FOLLOW 2 /*!< follow symbolic link */ -#define FTS_NOINSTR 3 /*!< no instructions */ -#define FTS_SKIP 4 /*!< discard node */ +#define FTS_AGAIN 1 /* read node again */ +#define FTS_FOLLOW 2 /* follow symbolic link */ +#define FTS_NOINSTR 3 /* no instructions */ +#define FTS_SKIP 4 /* discard node */ u_short fts_instr; /*!< fts_set() instructions */ /*@dependent@*/ diff --git a/rpmio/macro.c b/rpmio/macro.c index 1c72a39d0..4391d128d 100644 --- a/rpmio/macro.c +++ b/rpmio/macro.c @@ -288,7 +288,6 @@ findEntry(MacroContext mc, const char * name, size_t namelen) * @param buf input buffer * @param size inbut buffer size (bytes) * @param fd file handle - * @param escapes permit escaped newlines? * @return buffer, or NULL on end-of-file */ /*@-boundswrite@*/ diff --git a/rpmio/rpmio.c b/rpmio/rpmio.c index 27b5a7d2b..c7151018a 100644 --- a/rpmio/rpmio.c +++ b/rpmio/rpmio.c @@ -2756,7 +2756,7 @@ DBGIO(fd, (stderr, "==> Fclose(%p) %s\n", (fd ? fd : NULL), fdbg(fd))); /** * Convert stdio fmode to open(2) mode, filtering out zlib/bzlib flags. - * returns stdio[0] = '\0' on error. + * returns stdio[0] = NUL on error. * * - gzopen: [0-9] is compession level * - gzopen: 'f' is filtered (Z_FILTERED) diff --git a/rpmio/rpmmacro.h b/rpmio/rpmmacro.h index 8bab4b0ca..737a3d0b5 100644 --- a/rpmio/rpmmacro.h +++ b/rpmio/rpmmacro.h @@ -69,7 +69,7 @@ void rpmDumpMacroTable (/*@null@*/ MacroContext mc, /** * Return URL path(s) from a (URL prefixed) pattern glob. - * @patterns glob pattern + * @param patterns glob pattern * @retval *argcPtr no. of paths * @retval *argvPtr array of paths (malloc'd contiguous blob) * @return 0 on success