Skip to content

Commit

Permalink
add short summaries to modules
Browse files Browse the repository at this point in the history
  • Loading branch information
soig authored and ffesti committed Jan 28, 2016
1 parent 9f999fe commit a1794f9
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions doc/librpm/Doxyheader
Original file line number Diff line number Diff line change
Expand Up @@ -10,66 +10,98 @@

*/
/** \defgroup rpmcli Command Line API.
\brief Parsing RPM command line arguments (internal).
*/
/** \defgroup rpmbuild Build API.
\brief API for building packages.
*/
/** \defgroup rpmrc RPMRC.
\brief Reading config files and getting some important configuration values.
*/
/** \defgroup rpmtypes RPM data types.
\brief The abstract RPM data types.
*/
/** \defgroup rpmcallback Callback signature & types.
\brief The signature of function to register as callback and the cases where it can be called
*/
/** \defgroup rpmts Transaction Set API.
\brief How to create, run & destroy a package transaction.
*/
/** \defgroup rpmte Transaction Element API.
\brief How to retrieve information from a transaction element.
*/
/** \defgroup rpmds Dependency Set API.
\brief How to compare dependencies.
*/
/** \defgroup rpmfiles File Info Set API.
\brief File Info Set API.
*/
/** \defgroup rpmfi File Info Set Iterator API.
\brief File Info Set Iterator API.
*/
/** \defgroup rpmfc File Classification API.
\brief Structures and methods for build-time file classification
*/
/** \defgroup rpmps Problem Set API.
\brief Problem Set API.
*/
/** \defgroup rpmprob Problem Element API.
\brief Problem Element API.
*/
/** \defgroup rpmvf Verify API.
\brief How to verify a package
*/
/** \defgroup rpmkeyring RPM keyring API.
\brief RPM keyring API.
*/
/** \defgroup rpmmacro Macro API.
\brief Macro API.
*/
/** \defgroup rpmlog Logging API.
\brief RPM Logging facilities.
*/
/** \defgroup rpmpgp OpenPGP API.
\brief OpenPGP constants and structures from RFC-2440.
*/
/** \defgroup rpmsq Signal Queue API.
\brief Signal Queue API (internal).
*/
/** \defgroup rpmsw Statistics API.
\brief Statistics API (internal).
*/
/** \defgroup signature Signature Tags API.
\brief List of signature tags.
*/
/** \defgroup rpmsign Signature API.
\brief How to add or remove a signature from a package header.
*/
/** \defgroup header Header API.
\brief How to manipulate package headers (which carries all information about a package).
*/
/** \defgroup rpmtag RPM Tag API.
\brief Manipulating RPM tags (accessing values, types, ...)
*/
/** \defgroup rpmtd RPM Tag Data Container API.
\brief How to retrieve data from package headers.
*/
/** \defgroup rpmdb Database API.
\brief Opening & accessing the RPM indices using Berkeley DB (the so called rpmdb)
*/
/** \defgroup rpmio RPM IO API.
\brief The RPM IO API (Fd_t is RPM equivalent to libc's FILE).
*/
/** \defgroup rpmfileutil File and Path Manipulation API.
\brief File and path manipulation helper functions.
*/
/** \defgroup rpmurl URL Manipulation API.
\brief A couple utils for URL Manipulation.
*/
/** \defgroup rpmstring String Manipulation API.
\brief String Manipulation API.
*/
/** \defgroup rpmstrpool String Pool API.
\brief How to store strings in pools.
*/
/** \defgroup rpmargv Argument Manipulation API.
\brief Argument Manipulation API (internal).
*/

0 comments on commit a1794f9

Please sign in to comment.