summaryrefslogtreecommitdiff
path: root/build/rpmspec.h
diff options
context:
space:
mode:
authorjbj <devnull@localhost>2001-01-11 14:13:04 +0000
committerjbj <devnull@localhost>2001-01-11 14:13:04 +0000
commit2e137679467f975e486879f672969375fc9fcf70 (patch)
tree7de8bd1d352ecae7c9ccd68d3ba1c00e7d4a3099 /build/rpmspec.h
parent67aa2355659586f88f8481778bf46e8d44f59788 (diff)
downloadrpm-2e137679467f975e486879f672969375fc9fcf70.tar.gz
rpm-2e137679467f975e486879f672969375fc9fcf70.tar.bz2
rpm-2e137679467f975e486879f672969375fc9fcf70.zip
doxygen annotations for build/*.
- fix: don't hang on build error. - fix: remove "error: " prefix from signature verification message. CVS patchset: 4426 CVS date: 2001/01/11 14:13:04
Diffstat (limited to 'build/rpmspec.h')
-rw-r--r--build/rpmspec.h43
1 files changed, 25 insertions, 18 deletions
diff --git a/build/rpmspec.h b/build/rpmspec.h
index e55aed2ed..8cd9956b8 100644
--- a/build/rpmspec.h
+++ b/build/rpmspec.h
@@ -6,13 +6,13 @@
* The Spec and Package data structures used during build.
*/
-/**
+/** \ingroup rpmbuild
*/
typedef struct SpecStruct *Spec;
#include "rpmmacro.h"
-/**
+/** \ingroup rpmbuild
*/
struct TriggerFileEntry {
int index;
@@ -29,7 +29,7 @@ struct TriggerFileEntry {
#define RPMBUILD_DEFAULT_LANG "C"
-/**
+/** \ingroup rpmbuild
*/
struct Source {
/*@owned@*/ char *fullSource;
@@ -39,14 +39,14 @@ struct Source {
/*@owned@*/ struct Source *next;
};
-/**
+/** \ingroup rpmbuild
*/
typedef struct ReadLevelEntry {
int reading;
/*@dependent@*/ struct ReadLevelEntry *next;
} RLE_t;
-/**
+/** \ingroup rpmbuild
*/
typedef struct OpenFileInfo {
/*@only@*/ const char *fileName;
@@ -57,7 +57,7 @@ typedef struct OpenFileInfo {
/*@owned@*/ struct OpenFileInfo *next;
} OFI_t;
-/**
+/** \ingroup rpmbuild
*/
struct spectag {
int t_tag;
@@ -67,7 +67,7 @@ struct spectag {
/*@only@*/ const char *t_msgid;
};
-/**
+/** \ingroup rpmbuild
*/
struct spectags {
/*@owned@*/ struct spectag *st_t;
@@ -75,7 +75,7 @@ struct spectags {
int st_ntags;
};
-/**
+/** \ingroup rpmbuild
*/
struct speclines {
/*@only@*/ char **sl_lines;
@@ -83,7 +83,7 @@ struct speclines {
int sl_nlines;
};
-/**
+/** \ingroup rpmbuild
* The structure used to store values parsed from a spec file.
*/
struct SpecStruct {
@@ -138,7 +138,7 @@ struct SpecStruct {
/*@owned@*/ struct PackageStruct *packages; /*!< Package list. */
};
-/**
+/** \ingroup rpmbuild
* The structure used to store values for a package.
*/
struct PackageStruct {
@@ -173,7 +173,7 @@ struct PackageStruct {
/*@dependent@*/ struct PackageStruct *next;
};
-/**
+/** \ingroup rpmbuild
*/
typedef struct PackageStruct *Package;
@@ -181,31 +181,38 @@ typedef struct PackageStruct *Package;
extern "C" {
#endif
-/**
+/** \ingroup rpmbuild
+ * Create and initialize Spec structure.
*/
/*@only@*/ Spec newSpec(void);
-/**
+/** \ingroup rpmbuild
+ * Destroy Spec structure.
+ * @param spec spec file control structure
*/
void freeSpec(/*@only@*/ Spec spec);
-/**
+/** \ingroup rpmbuild
+ * @param spec spec file control structure
*/
extern void (*freeSpecVec) (Spec spec); /* XXX FIXME */
-/**
+/** \ingroup rpmbuild
*/
struct OpenFileInfo * newOpenFileInfo(void);
-/**
+/** \ingroup rpmbuild
+ * @param spec spec file control structure
*/
struct spectag *stashSt(Spec spec, Header h, int tag, const char *lang);
-/**
+/** \ingroup rpmbuild
+ * @param spec spec file control structure
*/
int addSource(Spec spec, Package pkg, const char *field, int tag);
-/**
+/** \ingroup rpmbuild
+ * @param spec spec file control structure
*/
int parseNoSource(Spec spec, const char *field, int tag);