summaryrefslogtreecommitdiff
path: root/doc/librpm
diff options
context:
space:
mode:
authorbiao716.wang <biao716.wang@samsung.com>2023-08-28 14:57:22 +0900
committerbiao716.wang <biao716.wang@samsung.com>2023-08-28 14:57:22 +0900
commit0fb104edc1e949fd224866aa900463aa2d6588d0 (patch)
treecdc9ddc3123edd5741e5151f3076c9bfc9535916 /doc/librpm
parenta0dea826f88a4c5c9ceb722592cceedeb75a32fe (diff)
downloadlibrpm-tizen-0fb104edc1e949fd224866aa900463aa2d6588d0.tar.gz
librpm-tizen-0fb104edc1e949fd224866aa900463aa2d6588d0.tar.bz2
librpm-tizen-0fb104edc1e949fd224866aa900463aa2d6588d0.zip
Upgrade version to 4.14sandbox/wangbiao/rpm414_tizen
Change-Id: Ifd629ba679a11ede4d831195c6aea2245efc3300 Signed-off-by: biao716.wang <biao716.wang@samsung.com>
Diffstat (limited to 'doc/librpm')
-rw-r--r--doc/librpm/Doxyheader58
-rw-r--r--doc/librpm/Doxyheader.h136
2 files changed, 136 insertions, 58 deletions
diff --git a/doc/librpm/Doxyheader b/doc/librpm/Doxyheader
deleted file mode 100644
index c8456c342..000000000
--- a/doc/librpm/Doxyheader
+++ /dev/null
@@ -1,58 +0,0 @@
-/*! \mainpage librpm API Documentation.
- */
-/** \defgroup rpmcli Command Line API.
- */
-/** \defgroup rpmbuild Build API.
- */
-/** \defgroup rpmrc RPMRC.
- */
-/** \defgroup rpmtypes RPM data types.
- */
-/** \defgroup rpmts Transaction Set API.
- */
-/** \defgroup rpmte Transaction Element API.
- */
-/** \defgroup rpmds Dependency Set API.
- */
-/** \defgroup rpmfi File Info API.
- */
-/** \defgroup rpmfc File Classification API.
- */
-/** \defgroup rpmps Problem Set API.
- */
-/** \defgroup rpmprob Problem Element API.
- */
-/** \defgroup rpmkeyring RPM keyring API.
- */
-/** \defgroup rpmmacro Macro API.
- */
-/** \defgroup rpmlog Logging API.
- */
-/** \defgroup rpmpgp OpenPGP API.
- */
-/** \defgroup rpmsq Signal Queue API.
- */
-/** \defgroup rpmsw Statistics API.
- */
-/** \defgroup signature Signature API.
- */
-/** \defgroup header Header API.
- */
-/** \defgroup rpmtag RPM Tag API.
- */
-/** \defgroup rpmtd RPM Tag Data Container API.
- */
-/** \defgroup rpmdb Database API.
- */
-/** \defgroup rpmio RPM IO API.
- */
-/** \defgroup rpmfileutil File and Path Manipulation API.
- */
-/** \defgroup rpmurl URL Manipulation API.
- */
-/** \defgroup rpmstring String Manipulation API.
- */
-/** \defgroup rpmstrpool String Pool API.
- */
-/** \defgroup rpmargv Argument Manipulation API.
- */
diff --git a/doc/librpm/Doxyheader.h b/doc/librpm/Doxyheader.h
new file mode 100644
index 000000000..365075ab2
--- /dev/null
+++ b/doc/librpm/Doxyheader.h
@@ -0,0 +1,136 @@
+/*! \mainpage librpm API Documentation.
+ This documents the librpm API as available to rpm itself and to the
+ various depsolvers or language bindings that rely upon it.
+
+ It enables to build tools for:
+ - \link rpmbuild creating \endlink,
+ - \link rpmsign signing \endlink,
+ - \link rpmtd querying \endlink,
+ - or \link rpmts (un)installing \endlink RPM packages.
+
+ */
+/** \defgroup buildsign Building & signing packages:
+ *
+ * @{
+ */
+/** \defgroup rpmbuild Build API.
+ \brief API for building packages.
+ */
+/** \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 datatypes Data types:
+ *
+ * @{
+ */
+/** \defgroup rpmtypes RPM data types.
+ \brief The abstract RPM data types.
+ */
+/** \defgroup rpmstring String Manipulation API.
+ \brief String Manipulation API.
+ */
+/** \defgroup rpmstrpool String Pool API.
+ \brief How to store strings in pools.
+ */
+/** @} */
+/** \defgroup install (un)Installing packages:
+ *
+ * @{
+ */
+/** \defgroup rpmds Dependency Set API.
+ \brief How to compare dependencies.
+ */
+/** \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 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 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 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 headquery Querying package headers:
+ *
+ * @{
+ */
+/** \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 io I/O
+ *
+ * @{
+ */
+/** \defgroup header Header API.
+/** \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 rpmargv Argument Manipulation API.
+ \brief Argument Manipulation API.
+ */
+/** \defgroup rpmcli Command Line API.
+ \brief Parsing RPM command line arguments.
+ */
+/** @} */
+/** \defgroup rpmsq Signal Queue API.
+ \brief Signal Queue API.
+ */
+/** \defgroup rpmsw Statistics API.
+ \brief Statistics API.
+ */
+/** \defgroup rpmrc RPMRC.
+ \brief Reading config files and getting some important configuration values.
+ */
+/** @} */