summaryrefslogtreecommitdiffstats
path: root/src/testlib
diff options
context:
space:
mode:
authorMartin Smith <msmith@trolltech.com>2010-02-04 12:44:08 (GMT)
committerMartin Smith <msmith@trolltech.com>2010-02-04 12:44:08 (GMT)
commit3d10c27c7674663028941d41af9ab845dbf31d86 (patch)
tree6b4980f7cfa797d3ce8f543b32423e2032a1f281 /src/testlib
parentc111ccb7ff961c76e424bfab3a3bf6a1b43865dc (diff)
downloadQt-3d10c27c7674663028941d41af9ab845dbf31d86.zip
Qt-3d10c27c7674663028941d41af9ab845dbf31d86.tar.gz
Qt-3d10c27c7674663028941d41af9ab845dbf31d86.tar.bz2
doc: Fixed some qdoc warnings.
Diffstat (limited to 'src/testlib')
-rw-r--r--src/testlib/qbenchmarkmetric.cpp28
1 files changed, 28 insertions, 0 deletions
diff --git a/src/testlib/qbenchmarkmetric.cpp b/src/testlib/qbenchmarkmetric.cpp
index 75297c4..7356134 100644
--- a/src/testlib/qbenchmarkmetric.cpp
+++ b/src/testlib/qbenchmarkmetric.cpp
@@ -41,6 +41,29 @@
#include <QtTest/private/qbenchmarkmetric_p.h>
+/*!
+ \enum QTest::QBenchmarkMetric
+ \since 4.7
+
+ This enum lists all the things that can be benchmarked.
+
+ \value FramesPerSecond Frames per second
+ \value BitsPerSecond Bits per second
+ \value BytesPerSecond Bytes per second
+ \value WalltimeMilliseconds Clock time in milliseconds
+ \value CPUTicks CPU time
+ \value InstructionReads Instruction reads
+ \value Events Event count
+
+ \sa QTest::benchmarkMetricName(), QTest::benchmarkMetricUnit()
+
+ */
+
+/*!
+ \relates QTest
+ \since 4.7
+ Returns the enum value \a metric as a character string.
+ */
const char * QTest::benchmarkMetricName(QBenchmarkMetric metric)
{
switch (metric) {
@@ -63,6 +86,11 @@ const char * QTest::benchmarkMetricName(QBenchmarkMetric metric)
}
};
+/*!
+ \relates QTest
+ \since 4.7
+ Retuns the units of measure for the specified \a metric.
+ */
const char * QTest::benchmarkMetricUnit(QBenchmarkMetric metric)
{
switch (metric) {