From c080226a60e3a48f827c91df172f249b424d2bb0 Mon Sep 17 00:00:00 2001 From: Thierry Vignaud Date: Sun, 11 May 2014 02:27:26 +0200 Subject: [PATCH] add short summaries to headers that miss one --- cliutils.h | 5 +++++ lib/rpmcallback.h | 6 ++++++ lib/rpmcli.h | 2 ++ lib/rpmlegacy.h | 5 +++++ lib/rpmtag.h | 6 ++++++ lib/rpmtd.h | 6 ++++++ lib/rpmvf.h | 2 ++ rpmio/argv.h | 2 ++ rpmio/rpmio.h | 1 + rpmio/rpmkeyring.h | 2 ++ rpmio/rpmmacro.h | 2 ++ rpmio/rpmsq.h | 1 + rpmio/rpmstrpool.h | 7 +++++++ rpmio/rpmsw.h | 2 ++ rpmio/rpmurl.h | 2 ++ rpmio/rpmutil.h | 3 ++- sign/rpmsign.h | 5 +++++ system.h | 2 ++ 18 files changed, 60 insertions(+), 1 deletion(-) diff --git a/cliutils.h b/cliutils.h index 35aa25285d..b5deee1bac 100644 --- a/cliutils.h +++ b/cliutils.h @@ -1,6 +1,11 @@ #ifndef _CLIUTIL_H #define _CLIUTIL_H +/** \file cliutils.h + * + * Misc helpers for RPM CLI tools + */ + #include #include #include diff --git a/lib/rpmcallback.h b/lib/rpmcallback.h index f0d6ba610d..dfc22ab7f2 100644 --- a/lib/rpmcallback.h +++ b/lib/rpmcallback.h @@ -1,6 +1,12 @@ #ifndef _RPMCALLBACK_H #define _RPMCALLBACK_H +/** \ingroup rpmcallback + * \file lib/rpmcallback.h + * + * (un)install callbacks + */ + #include #ifdef __cplusplus diff --git a/lib/rpmcli.h b/lib/rpmcli.h index 4adb3d1a64..1c5370150e 100644 --- a/lib/rpmcli.h +++ b/lib/rpmcli.h @@ -3,6 +3,8 @@ /** \ingroup rpmcli rpmbuild * \file lib/rpmcli.h + * + * Parsing RPM command line arguments */ #include diff --git a/lib/rpmlegacy.h b/lib/rpmlegacy.h index 2f9e0a03e4..22739dfb27 100644 --- a/lib/rpmlegacy.h +++ b/lib/rpmlegacy.h @@ -1,6 +1,11 @@ #ifndef _RPMLEGACY_H #define _RPMLEGACY_H +/** \ingroup header_legacy + * \file lib/rpmlegacy.h + * + * Some deprecated legacy API (do NOT use) + */ #include #include diff --git a/lib/rpmtag.h b/lib/rpmtag.h index dc62de2be6..0288ce03fe 100644 --- a/lib/rpmtag.h +++ b/lib/rpmtag.h @@ -1,6 +1,12 @@ #ifndef _RPMTAG_H #define _RPMTAG_H +/** \ingroup rpmtag + * \file lib/rpmtag.h + * + * Accessing RPM tags: values, types, ... + */ + #include #ifdef __cplusplus diff --git a/lib/rpmtd.h b/lib/rpmtd.h index 76f1ca56cd..3f1ea2d948 100644 --- a/lib/rpmtd.h +++ b/lib/rpmtd.h @@ -1,6 +1,12 @@ #ifndef _RPMTD_H #define _RPMTD_H +/** \ingroup rpmtd + * \file lib/rpmtd.h + * + * RPM Tag Data Container API + */ + #include #include diff --git a/lib/rpmvf.h b/lib/rpmvf.h index 51690b8573..3a0c063bd9 100644 --- a/lib/rpmvf.h +++ b/lib/rpmvf.h @@ -4,6 +4,8 @@ /** \ingroup rpmvf * \file lib/rpmvf.h * @todo Add a more complete API... + * + * \brief Verify a package. The constants that enable/disable some sanity checks (mainly used at post (un)install) */ #include diff --git a/rpmio/argv.h b/rpmio/argv.h index 7b59d347d7..602b1dc200 100644 --- a/rpmio/argv.h +++ b/rpmio/argv.h @@ -3,6 +3,8 @@ /** \ingroup rpmargv * \file rpmio/argv.h + * + * Argument Manipulation API. */ #include diff --git a/rpmio/rpmio.h b/rpmio/rpmio.h index 8cebe16caf..9bd1086490 100644 --- a/rpmio/rpmio.h +++ b/rpmio/rpmio.h @@ -4,6 +4,7 @@ /** \ingroup rpmio * \file rpmio/rpmio.h * + * RPM I/O API (Fd_t is RPM equivalent to libc's FILE) */ #include diff --git a/rpmio/rpmkeyring.h b/rpmio/rpmkeyring.h index f9e2f59ff0..8aeed8c6c2 100644 --- a/rpmio/rpmkeyring.h +++ b/rpmio/rpmkeyring.h @@ -3,6 +3,8 @@ /** \ingroup rpmkeyring * \file rpmio/rpmkeyring.h + * + * RPM keyring API */ #include diff --git a/rpmio/rpmmacro.h b/rpmio/rpmmacro.h index 8027f98c0b..c13f8d0d7a 100644 --- a/rpmio/rpmmacro.h +++ b/rpmio/rpmmacro.h @@ -3,6 +3,8 @@ /** \ingroup rpmio * \file rpmio/rpmmacro.h + * + * Macro API */ #include diff --git a/rpmio/rpmsq.h b/rpmio/rpmsq.h index 22bfcc564a..1d44c53a7d 100644 --- a/rpmio/rpmsq.h +++ b/rpmio/rpmsq.h @@ -4,6 +4,7 @@ /** \ingroup rpmio * \file rpmio/rpmsq.h * + * Signal Queue API */ #include #include diff --git a/rpmio/rpmstrpool.h b/rpmio/rpmstrpool.h index 3f261bbc00..11c946973b 100644 --- a/rpmio/rpmstrpool.h +++ b/rpmio/rpmstrpool.h @@ -1,6 +1,13 @@ #ifndef _RPMSTRPOOL_H #define _RPMSTRPOOL_H +/** \ingroup rpmstrpool + * \file rpmio/rpmstrpool.h + * + * String pools manipulation helper functions + * + */ + #include #ifdef __cplusplus diff --git a/rpmio/rpmsw.h b/rpmio/rpmsw.h index 7c285e7848..61d6fe3178 100644 --- a/rpmio/rpmsw.h +++ b/rpmio/rpmsw.h @@ -3,6 +3,8 @@ /** \ingroup rpmio * \file rpmio/rpmsw.h + * + * Statistics API */ #include diff --git a/rpmio/rpmurl.h b/rpmio/rpmurl.h index e820e95e72..588c95df1a 100644 --- a/rpmio/rpmurl.h +++ b/rpmio/rpmurl.h @@ -3,6 +3,8 @@ /** \ingroup rpmio * \file rpmio/rpmurl.h + * + * A couple utils for URL Manipulation */ #ifdef __cplusplus diff --git a/rpmio/rpmutil.h b/rpmio/rpmutil.h index 90cc08f24c..9e8a25d0f6 100644 --- a/rpmio/rpmutil.h +++ b/rpmio/rpmutil.h @@ -3,7 +3,8 @@ #include -/* +/** \file rpmio/rpmutil.h + * * Miscellaneous utility macros: * - portability wrappers for various gcc extensions like __attribute__() * - ... diff --git a/sign/rpmsign.h b/sign/rpmsign.h index 0f9c94f3ff..b41e3caabd 100644 --- a/sign/rpmsign.h +++ b/sign/rpmsign.h @@ -1,6 +1,11 @@ #ifndef _RPMSIGN_H #define _RPMSIGN_H +/** \file sign/rpmsign.h + * + * Signature API + */ + #include #include diff --git a/system.h b/system.h index 40b9933fd7..879644c242 100644 --- a/system.h +++ b/system.h @@ -1,5 +1,7 @@ /** * \file system.h + * + * Some misc low-level API */ #ifndef H_SYSTEM