From a97aa6be67a229208f40016dc8fa619b16496443 Mon Sep 17 00:00:00 2001 From: Ulf Hermann Date: Fri, 11 Jul 2014 11:44:37 +0200 Subject: [PATCH] QmlProfiler: Apply documentation style to sortedtimelinemodel.cpp Change-Id: I5ed4449b3003d53c27859e11606d4b4dceee229a Reviewed-by: Leena Miettinen --- src/plugins/qmlprofiler/sortedtimelinemodel.cpp | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/plugins/qmlprofiler/sortedtimelinemodel.cpp b/src/plugins/qmlprofiler/sortedtimelinemodel.cpp index 6a39b96d5b7..db23a35a974 100644 --- a/src/plugins/qmlprofiler/sortedtimelinemodel.cpp +++ b/src/plugins/qmlprofiler/sortedtimelinemodel.cpp @@ -29,7 +29,7 @@ /*! \class QmlProfiler::SortedTimelineModel - \brief Sorted model for timeline data + \brief The SortedTimelineModel class provides a sorted model for timeline data. The SortedTimelineModel lets you keep range data sorted by both start and end times, so that visible ranges can easily be computed. The only precondition for that to work is that the ranges @@ -83,7 +83,7 @@ /*! \fn int SortedTimelineModel::insertStart(qint64 startTime, const Data &item) Inserts the given data as range start at the given time position and - returns its index. The range end isn't set. + returns its index. The range end is not set. */ /*! @@ -94,14 +94,14 @@ /*! \fn int SortedTimelineModel::findFirstIndexNoParents(qint64 startTime) const Looks up the first range with an end time greater than the given time and - returns its index. If no such range is found it returns -1. + returns its index. If no such range is found, it returns -1. */ /*! \fn int SortedTimelineModel::findFirstIndex(qint64 startTime) const Looks up the first range with an end time greater than the given time and - returns its parent's index. If no such range is found it returns -1. If there - is no parent it returns the found range's index. The parent of a range is the + returns its parent's index. If no such range is found, it returns -1. If there + is no parent, it returns the found range's index. The parent of a range is the range with the lowest start time that completely covers the child range. "Completely covers" means: parent.startTime <= child.startTime && parent.endTime >= child.endTime @@ -110,7 +110,7 @@ /*! \fn int SortedTimelineModel::findLastIndex(qint64 endTime) const Looks up the last range with a start time smaller than the given time and - returns its index. If no such range is found it returns -1. + returns its index. If no such range is found, it returns -1. */ /*!