Doxygen fiddles.

CVS patchset: 7495
CVS date: 2004/10/20 10:19:34
This commit is contained in:
jbj 2004-10-20 10:19:34 +00:00
parent 2c192f3e33
commit 8faa61c020
13 changed files with 66 additions and 63 deletions

View File

@ -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" {

View File

@ -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@*/

View File

@ -2,7 +2,7 @@
#define H_RPMGI
/** \ingroup rpmio
* \file rpmio/rpmgi.h
* \file lib/rpmgi.h
*/
#include <rpmlib.h>
@ -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)

View File

@ -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.

View File

@ -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)

View File

@ -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.

View File

@ -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@*/

View File

@ -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 */

View File

@ -1,5 +1,5 @@
/** \ingroup py_c
* \file python/_rpmmodule.c
* \file python/rpmmodule.c
*/
#include "system.h"

View File

@ -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@*/

View File

@ -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@*/

View File

@ -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)

View File

@ -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