summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2021-08-18 09:58:44 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2021-08-18 12:53:40 +0000
commit186714b094d4f65f46488b1f80058fd5bf69e96c (patch)
tree7fadb857cd49dcacea41db66fb13b59abeeb9fee
parentc517764a2f85a341813f232712ecbdbc5c967982 (diff)
Doc: Fix the qdoc warnings
qt5/qtcharts/src/chartsqml2/declarativechart.cpp:80: (qdoc) warning: C++ class DeclarativeChart not found: \instantiates DeclarativeChart qt5/qtcharts/src/chartsqml2/declarativepolarchart.cpp:35: (qdoc) warning: C++ class DeclarativePolarChart not found: \instantiates DeclarativePolarChart qt5/qtcharts/src/charts/legend/qlegend.cpp:238: (qdoc) warning: Undocumented parameter 'attachedToChart' in QLegend::attachedToChartChanged() qt5/qtcharts/src/charts/barchart/qbarset.cpp:693: (qdoc) warning: Undocumented parameter 'color' in QBarSet::setSelectedColor() qt5/qtcharts/src/charts/xychart/qxyseries.cpp:1607: (qdoc) warning: Can't link to 'QXYSeries::selectedColor()' qt5/qtcharts/src/charts/xychart/qxyseries.cpp:1624: (qdoc) warning: Undocumented parameter 'size' in QXYSeries::setMarkerSize() qt5/qtcharts/src/charts/xychart/qxyseries.cpp:1585: (qdoc) warning: Can't link to 'QXYSeries::selectedColor()' Task-number: QTBUG-95860 Change-Id: Id91d07df2caaac6de5a19536abaa56bef9686ba5 Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit 621d29d8f26f33c5e74c0bc839fa289019ec1825) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/charts/barchart/qbarset.cpp2
-rw-r--r--src/charts/legend/qlegend.cpp4
-rw-r--r--src/charts/xychart/qxyseries.cpp20
3 files changed, 13 insertions, 13 deletions
diff --git a/src/charts/barchart/qbarset.cpp b/src/charts/barchart/qbarset.cpp
index faccf07f..f7ad4909 100644
--- a/src/charts/barchart/qbarset.cpp
+++ b/src/charts/barchart/qbarset.cpp
@@ -691,7 +691,7 @@ QColor QBarSet::selectedColor() const
}
/*!
- Sets the color of the selected bars.
+ Sets the \a color of the selected bars.
\sa selectedColor
\since 6.2
*/
diff --git a/src/charts/legend/qlegend.cpp b/src/charts/legend/qlegend.cpp
index 49766c6f..9e2778e9 100644
--- a/src/charts/legend/qlegend.cpp
+++ b/src/charts/legend/qlegend.cpp
@@ -236,8 +236,8 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \fn void QLegend::attachedToChartChanged(bool)
- This signal is emitted when the legend is attached to or detached from the legend.
+ \fn void QLegend::attachedToChartChanged(bool attached)
+ This signal is emitted when the legend is \a attached to or detached from the chart.
\since 6.2
*/
diff --git a/src/charts/xychart/qxyseries.cpp b/src/charts/xychart/qxyseries.cpp
index 9c30b1e4..5f15f0ad 100644
--- a/src/charts/xychart/qxyseries.cpp
+++ b/src/charts/xychart/qxyseries.cpp
@@ -1585,12 +1585,12 @@ const QImage &QXYSeries::lightMarker() const
/*!
Sets the image used for drawing markers on selected series's points to \a selectedLightMarker.
- The default value is QImage(), meaning usual QXYSeries::lightMarker() will be painted.
+ The default value is QImage(), meaning usual lightMarker() will be painted.
- This is an equivalent for QXYSeries::setSelectedColor() if you prefer light markers over
- normal points, but you still want to distinguish selected points.
+ This is an equivalent for \l{selectedColor} if you prefer light markers over
+ normal points, but still want to distinguish selected points.
- \sa QXYSeries::lightMarker(), QXYSeries::selectedColor(), QXYSeries::setPointSelected()
+ \sa lightMarker(), selectedColor, setPointSelected()
\since 6.2
*/
void QXYSeries::setSelectedLightMarker(const QImage &selectedLightMarker)
@@ -1605,14 +1605,14 @@ void QXYSeries::setSelectedLightMarker(const QImage &selectedLightMarker)
}
/*!
- Returns the image used for drawing markers on selected series's points.
+ Returns the image used for drawing markers on selected series' points.
- The default value is QImage(), meaning usual QXYSeries::lightMarker() will be painted.
+ The default value is QImage(), meaning usual lightMarker() will be painted.
- This is an equivalent for QXYSeries::selectedColor() if you prefer light markers over
- normal points, but you still want to distinguish selected points.
+ This is equivalent to \l{selectedColor} if you prefer light markers over
+ normal points, but still want to distinguish selected points.
- \sa QXYSeries::lightMarker(), QXYSeries::selectedColor(), QXYSeries::setPointSelected()
+ \sa lightMarker(), selectedColor, setPointSelected()
\since 6.2
*/
const QImage &QXYSeries::selectedLightMarker() const
@@ -1622,7 +1622,7 @@ const QImage &QXYSeries::selectedLightMarker() const
}
/*!
- Sets the size of the marker used to render points in the series.
+ Sets the \a size of the marker used to render points in the series.
The default size is 15.0.
\sa QScatterSeries::markerSize