diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2019-11-09 15:24:21 +0100 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@qt.io> | 2019-11-11 10:50:28 +0000 |
| commit | 57b67d631dee93f6473786f38504da32fb0bb6b8 (patch) | |
| tree | 80b0fc0bee63b80a395ada3b527d9e42ea43f0f3 /src | |
| parent | de7d5543ae093b84a6526cad0d8c56fc12f7526f (diff) | |
Doc: Fix documentation warnings
In qchartglobal.h we omit defining the QT_CHARTS_NAMESPACE and
related macros for documentation builds, but qchart.h has one
unguarded use which Clang complains about when generating the
precompiled header. Use the Q_CLANG_QDOC macro to omit that one
as well.
Fix undocumented parameters and one duplicated \qmlproperty to
bring the warning count to zero.
Fixes: QTBUG-79830
Change-Id: Ifb047f5a5e2828f09857fbe6df79cbb77464357a
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src')
| -rw-r--r-- | src/charts/axis/qabstractaxis.cpp | 2 | ||||
| -rw-r--r-- | src/charts/boxplotchart/qboxset.cpp | 5 | ||||
| -rw-r--r-- | src/charts/qchart.h | 2 | ||||
| -rw-r--r-- | src/chartsqml2/declarativechart.cpp | 8 |
4 files changed, 7 insertions, 10 deletions
diff --git a/src/charts/axis/qabstractaxis.cpp b/src/charts/axis/qabstractaxis.cpp index bf7d7dfb..c1e55f83 100644 --- a/src/charts/axis/qabstractaxis.cpp +++ b/src/charts/axis/qabstractaxis.cpp @@ -370,7 +370,7 @@ QT_CHARTS_BEGIN_NAMESPACE /*! \fn void QAbstractAxis::labelsEditableChanged(bool editable) \since 5.13 - This signal is emitted when the labels editability changes. + This signal is emitted when the \a editable state of the label changes. */ /*! diff --git a/src/charts/boxplotchart/qboxset.cpp b/src/charts/boxplotchart/qboxset.cpp index 7d5f562d..e9771d12 100644 --- a/src/charts/boxplotchart/qboxset.cpp +++ b/src/charts/boxplotchart/qboxset.cpp @@ -73,11 +73,6 @@ QT_CHARTS_BEGIN_NAMESPACE */ /*! - \qmlproperty QString BoxSet::brushFilename - The name of the file used as a brush for the box-and-whiskers item. -*/ - -/*! \fn void QBoxSet::clicked() This signal is emitted when the user clicks a box-and-whiskers item in the chart. */ diff --git a/src/charts/qchart.h b/src/charts/qchart.h index e287500d..1c233fb2 100644 --- a/src/charts/qchart.h +++ b/src/charts/qchart.h @@ -199,6 +199,8 @@ private: QT_CHARTS_END_NAMESPACE +#ifndef Q_CLANG_QDOC Q_DECLARE_OPERATORS_FOR_FLAGS(QT_CHARTS_NAMESPACE::QChart::AnimationOptions) +#endif #endif // QCHART_H diff --git a/src/chartsqml2/declarativechart.cpp b/src/chartsqml2/declarativechart.cpp index 23ee2a11..6cb811aa 100644 --- a/src/chartsqml2/declarativechart.cpp +++ b/src/chartsqml2/declarativechart.cpp @@ -325,22 +325,22 @@ QT_CHARTS_BEGIN_NAMESPACE /*! \qmlmethod Axis ChartView::axisX(AbstractSeries series) - The x-axis of the series. + The x-axis of the \a series. */ /*! \qmlmethod ChartView::setAxisX(AbstractAxis axis, AbstractSeries series) - Sets the x-axis of the series. + Sets the x-axis of the \a series to \a axis. */ /*! \qmlmethod Axis ChartView::axisY(AbstractSeries series) - The y-axis of the series. + The y-axis of the \a series. */ /*! \qmlmethod ChartView::setAxisY(AbstractAxis axis, AbstractSeries series) - Sets the y-axis of the series. + Sets the y-axis of the \a series to \a axis. */ /*! |