diff options
| -rw-r--r-- | build/rpmfc.h | 33 | ||||
| -rw-r--r-- | doc/hacking/Doxyheader | 2 | ||||
| -rw-r--r-- | doc/librpm/Doxyheader | 2 |
3 files changed, 24 insertions, 13 deletions
diff --git a/build/rpmfc.h b/build/rpmfc.h index 92ecbb43f..c4f958b1c 100644 --- a/build/rpmfc.h +++ b/build/rpmfc.h @@ -1,6 +1,11 @@ #ifndef _H_RPMFC_ #define _H_RPMFC_ +/** \ingroup rpmfc rpmbuild + * \file build/rpmfc.h + * Structures and methods for build-time file classification. + */ + #include <magic.h> #include <rpmlib.h> /* for rpmds, rpmSpec */ @@ -14,11 +19,11 @@ extern "C" { extern int _rpmfc_debug; -/** +/** \ingroup rpmfc */ typedef struct rpmfc_s * rpmfc; -/** +/** \ingroup rpmfc */ enum FCOLOR_e { RPMFC_BLACK = 0, @@ -58,13 +63,15 @@ enum FCOLOR_e { RPMFC_INCLUDE = (1 << 30), RPMFC_ERROR = (1 << 31) }; +/** \ingroup rpmfc + */ typedef enum FCOLOR_e FCOLOR_t; -/** +/** \ingroup rpmfc */ typedef struct rpmfcTokens_s * rpmfcToken; -/** +/** \ingroup rpmfc * Return helper output. * @param av helper argv (with possible macros) * @param sb_stdin helper input @@ -74,14 +81,14 @@ typedef struct rpmfcTokens_s * rpmfcToken; int rpmfcExec(ARGV_t av, StringBuf sb_stdin, StringBuf * sb_stdoutp, int failnonzero); -/** +/** \ingroup rpmfc * Return file color given file(1) string. * @param fmstr file(1) string * @return file color */ int rpmfcColoring(const char * fmstr); -/** +/** \ingroup rpmfc * Print results of file classification. * @todo Remove debugging routine. * @param msg message prefix (NULL for none) @@ -90,20 +97,20 @@ int rpmfcColoring(const char * fmstr); */ void rpmfcPrint(const char * msg, rpmfc fc, FILE * fp); -/** +/** \ingroup rpmfc * Destroy a file classifier. * @param fc file classifier * @return NULL always */ rpmfc rpmfcFree(rpmfc fc); -/** +/** \ingroup rpmfc * Create a file classifier. * @return new file classifier */ rpmfc rpmfcNew(void); -/** +/** \ingroup rpmfc * Build file class dictionary and mappings. * @param fc file classifier * @param argv files to classify @@ -112,14 +119,14 @@ rpmfc rpmfcNew(void); */ int rpmfcClassify(rpmfc fc, ARGV_t argv, int16_t * fmode); -/** +/** \ingroup rpmfc * Build file/package dependency dictionary and mappings. * @param fc file classifier * @return 0 on success */ int rpmfcApply(rpmfc fc); -/** +/** \ingroup rpmfc * Generate package dependencies. * @param spec spec file control * @param pkg package control @@ -127,14 +134,14 @@ int rpmfcApply(rpmfc fc); */ int rpmfcGenerateDepends(const rpmSpec spec, Package pkg); -/** +/** \ingroup rpmfc * Retrieve file classification provides * @param fc file classifier * @return rpmds dependency set of fc provides */ rpmds rpmfcProvides(rpmfc fc); -/** +/** \ingroup rpmfc * Retrieve file classification requires * @param fc file classifier * @return rpmds dependency set of fc requires diff --git a/doc/hacking/Doxyheader b/doc/hacking/Doxyheader index 6c0fd8f1a..5cca27e13 100644 --- a/doc/hacking/Doxyheader +++ b/doc/hacking/Doxyheader @@ -18,6 +18,8 @@ */ /** \defgroup rpmfi File Info API. */ +/** \defgroup rpmfc File Classification API. + */ /** \defgroup rpmps Problem Set API. */ /** \defgroup rpmgi Generalized Iterator API. diff --git a/doc/librpm/Doxyheader b/doc/librpm/Doxyheader index 421917814..f04c1d3e2 100644 --- a/doc/librpm/Doxyheader +++ b/doc/librpm/Doxyheader @@ -14,6 +14,8 @@ */ /** \defgroup rpmfi File Info API. */ +/** \defgroup rpmfc File Classification API. + */ /** \defgroup rpmps Problem Set API. */ /** \defgroup rpmgi Generalized Iterator API. |