diff options
| author | Panu Matilainen <pmatilai@redhat.com> | 2007-11-23 14:51:30 +0200 |
|---|---|---|
| committer | Panu Matilainen <pmatilai@redhat.com> | 2007-11-23 14:51:30 +0200 |
| commit | 43d1baef0f8e95e9340802faebc7ffffe3421b2d (patch) | |
| tree | 9094eaf83bc6e2b5aee3b7bae3d6569087881e6a | |
| parent | bdce039f8567890296ef80cc80574dd9947ab571 (diff) | |
| download | rpm-43d1baef0f8e95e9340802faebc7ffffe3421b2d.tar.gz rpm-43d1baef0f8e95e9340802faebc7ffffe3421b2d.tar.bz2 rpm-43d1baef0f8e95e9340802faebc7ffffe3421b2d.zip | |
doxygen groupings for rpmsw, add to librpm + hacking dox
| -rw-r--r-- | doc/hacking/Doxyheader | 2 | ||||
| -rw-r--r-- | doc/librpm/Doxyheader | 2 | ||||
| -rw-r--r-- | rpmio/rpmsw.h | 27 |
3 files changed, 19 insertions, 12 deletions
diff --git a/doc/hacking/Doxyheader b/doc/hacking/Doxyheader index 0a6b30c6c..6c0fd8f1a 100644 --- a/doc/hacking/Doxyheader +++ b/doc/hacking/Doxyheader @@ -28,6 +28,8 @@ */ /** \defgroup rpmsq Signal Queue API. */ +/** \defgroup rpmsw Statistics API. + */ /** \defgroup lead LEAD. */ /** \defgroup signature SIGNATURE. diff --git a/doc/librpm/Doxyheader b/doc/librpm/Doxyheader index 7263e153b..421917814 100644 --- a/doc/librpm/Doxyheader +++ b/doc/librpm/Doxyheader @@ -24,6 +24,8 @@ */ /** \defgroup rpmsq Signal Queue API. */ +/** \defgroup rpmsw Statistics API. + */ /** \defgroup lead LEAD. */ /** \defgroup signature SIGNATURE. diff --git a/rpmio/rpmsw.h b/rpmio/rpmsw.h index d9f62d1da..624448ace 100644 --- a/rpmio/rpmsw.h +++ b/rpmio/rpmsw.h @@ -9,19 +9,19 @@ extern "C" { #endif -/** \ingroup rpmio +/** \ingroup rpmsw */ typedef unsigned long int rpmtime_t; -/** \ingroup rpmio +/** \ingroup rpmsw */ typedef struct rpmsw_s * rpmsw; -/** \ingroup rpmio +/** \ingroup rpmsw */ typedef struct rpmop_s * rpmop; -/** \ingroup rpmio +/** \ingroup rpmsw */ struct rpmsw_s { union { @@ -31,7 +31,7 @@ struct rpmsw_s { } u; }; -/** \ingroup rpmio +/** \ingroup rpmsw * Cumulative statistics for an operation. */ struct rpmop_s { @@ -41,25 +41,28 @@ struct rpmop_s { rpmtime_t usecs; /*!< Number of ticks. */ }; -/** Return benchmark time stamp. +/** \ingroup rpmsw + * Return benchmark time stamp. * @param *sw time stamp * @return 0 on success */ rpmsw rpmswNow(rpmsw sw); -/** Return benchmark time stamp difference. +/** \ingroup rpmsw + * Return benchmark time stamp difference. * @param *end end time stamp * @param *begin begin time stamp * @return difference in micro-seconds */ rpmtime_t rpmswDiff(rpmsw end, rpmsw begin); -/** Return benchmark time stamp overhead. +/** \ingroup rpmsw + * Return benchmark time stamp overhead. * @return overhead in micro-seconds */ rpmtime_t rpmswInit(void); -/** \ingroup rpmio +/** \ingroup rpmsw * Enter timed operation. * @param op operation statistics * @param rc -1 clears usec counter @@ -67,7 +70,7 @@ rpmtime_t rpmswInit(void); */ int rpmswEnter(rpmop op, ssize_t rc); -/** \ingroup rpmio +/** \ingroup rpmsw * Exit timed operation. * @param op operation statistics * @param rc per-operation data (e.g. bytes transferred) @@ -75,7 +78,7 @@ int rpmswEnter(rpmop op, ssize_t rc); */ rpmtime_t rpmswExit(rpmop op, ssize_t rc); -/** \ingroup rpmio +/** \ingroup rpmsw * Sum statistic counters. * @param to result statistics * @param from operation statistics @@ -83,7 +86,7 @@ rpmtime_t rpmswExit(rpmop op, ssize_t rc); */ rpmtime_t rpmswAdd(rpmop to, rpmop from); -/** \ingroup rpmio +/** \ingroup rpmsw * Subtract statistic counters. * @param to result statistics * @param from operation statistics |