add short summaries to headers that miss one

cms-externals · Jan 28, 2016 · c080226 · c080226
1 parent a1794f9
commit c080226
Show file tree

Hide file tree

Showing 18 changed files with 60 additions and 1 deletion.
diff --git 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 <stdio.h>
 #include <popt.h>
 #include <rpm/rpmutil.h>

diff --git 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 <rpm/rpmtypes.h>
 
 #ifdef __cplusplus

diff --git 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 <popt.h>

diff --git 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 <rpm/rpmtypes.h>
 #include <rpm/rpmutil.h>
 

diff --git 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 <rpm/rpmtypes.h>
 
 #ifdef __cplusplus

diff --git 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 <rpm/rpmtypes.h>
 #include <rpm/argv.h>
 

diff --git 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 <rpm/rpmtypes.h>
 

diff --git a/rpmio/argv.h b/rpmio/argv.h
@@ -3,6 +3,8 @@
 
 /** \ingroup rpmargv
  * \file rpmio/argv.h
+ *
+ * Argument Manipulation API.
  */
 
 #include <stdio.h>

diff --git 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 <sys/types.h>

diff --git a/rpmio/rpmkeyring.h b/rpmio/rpmkeyring.h
@@ -3,6 +3,8 @@
 
 /** \ingroup rpmkeyring
  * \file rpmio/rpmkeyring.h
+ *
+ * RPM keyring API
  */
 
 #include <rpm/rpmtypes.h>

diff --git a/rpmio/rpmmacro.h b/rpmio/rpmmacro.h
@@ -3,6 +3,8 @@
 
 /** \ingroup rpmio
  * \file rpmio/rpmmacro.h
+ *
+ * Macro API
  */
 
 #include <stdio.h>

diff --git a/rpmio/rpmsq.h b/rpmio/rpmsq.h
@@ -4,6 +4,7 @@
 /** \ingroup rpmio
  * \file rpmio/rpmsq.h
  *
+ * Signal Queue API
  */
 #include <rpm/rpmsw.h>
 #include <signal.h>

diff --git 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 <rpm/rpmtypes.h>
 
 #ifdef __cplusplus

diff --git a/rpmio/rpmsw.h b/rpmio/rpmsw.h
@@ -3,6 +3,8 @@
 
 /** \ingroup rpmio
  * \file rpmio/rpmsw.h
+ *
+ * Statistics API
  */
 
 #include <unistd.h>

diff --git 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
@@ -3,7 +3,8 @@
 
 #include <unistd.h>
 
-/*
+/** \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
@@ -1,6 +1,11 @@
 #ifndef _RPMSIGN_H
 #define _RPMSIGN_H
 
+/** \file sign/rpmsign.h
+ *
+ * Signature API
+ */
+
 #include <rpm/argv.h>
 #include <rpm/rpmpgp.h>
 

diff --git a/system.h b/system.h
@@ -1,5 +1,7 @@
 /**
  * \file system.h
+ *
+ *  Some misc low-level API
  */
 
 #ifndef	H_SYSTEM