Add rpmtag + tag api doxygen group to librpm + hacking docs
authorPanu Matilainen <pmatilai@redhat.com>
Fri, 23 Nov 2007 13:44:32 +0000 (15:44 +0200)
committerPanu Matilainen <pmatilai@redhat.com>
Fri, 23 Nov 2007 13:44:32 +0000 (15:44 +0200)
doc/hacking/Doxyheader
doc/librpm/Doxyheader
lib/rpmlib.h

index ac5d415..23bea0a 100644 (file)
@@ -36,7 +36,9 @@
  */
 /** \defgroup  signature       SIGNATURE.
  */
-/** \defgroup  header  HEADER.
+/** \defgroup  header  Header API.
+ */
+/** \defgroup   rpmtag  Header Tag API.
  */
 /** \defgroup  payload PAYLOAD.
  */
index bb40582..9404052 100644 (file)
@@ -30,7 +30,9 @@
  */
 /** \defgroup  signature       SIGNATURE.
  */
-/** \defgroup  header  HEADER.
+/** \defgroup  header  Header API.
+ */
+/** \defgroup  rpmtag  Header Tag API.
  */
 /** \defgroup  rpmdb   Database API.
  */
index 4c0ff3f..eb28b21 100644 (file)
@@ -160,7 +160,7 @@ extern const struct headerSprintfExtension_s rpmHeaderFormats[];
 #define        RPMDBI_ARGLIST          7       /* (rpmgi) Argument list. */
 #define        RPMDBI_FTSWALK          8       /* (rpmgi) File tree  walk. */
 
-/**
+/** \ingroup rpmtag
  * Tags identify data in package headers.
  * @note tags should not have value 0!
  */
@@ -659,7 +659,7 @@ typedef int (*HME_t) (Header h, rpmTag tag, rpmTagType type,
  */
 typedef int (*HRE_t) (Header h, int32_t tag);
 
-/**
+/** 
  * @todo Generalize filter mechanism.
  */
 typedef enum rpmprobFilterFlags_e {
@@ -886,21 +886,21 @@ int rpmCheckRpmlibProvides(const rpmds key);
 void rpmShowRpmlibProvides(FILE * fp);
 
 
-/**
+/** \ingroup rpmtag
  * Return tag name from value.
  * @param tag          tag value
  * @return             tag name, "(unknown)" on not found
  */
 const char * rpmTagGetName(int tag);
 
-/**
+/** \ingroup rpmtag
  * Return tag data type from value.
  * @param tag          tag value
  * @return             tag data type, RPM_NULL_TYPE on not found.
  */
 int rpmTagGetType(int tag);
 
-/**
+/** \ingroup rpmtag
  * Return tag value from name.
  * @param tagstr       name of tag
  * @return             tag value, -1 on not found