Split C++ API docs to 2D and 3D

Task-number: QTBUG-120593
Pick-to: 6.7
Change-Id: I1c6bc9bc98e52c18b7938f651832b018281ba487
Reviewed-by: Jere Tuliniemi <jere.tuliniemi@qt.io>
Reviewed-by: Sami Varanka <sami.varanka@qt.io>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
This commit is contained in:
Tomi Korpipaa 2024-01-10 13:26:14 +02:00
parent 5edc5b72fa
commit 4b226ac0d9
47 changed files with 114 additions and 29 deletions

View File

@ -523,3 +523,6 @@ if(QT_FEATURE_graphs_2d)
add_subdirectory(graphs2d)
endif()
qt_internal_add_docs(Graphs
doc/qtgraphs.qdocconf
)

View File

@ -4,10 +4,11 @@
/*!
\title Qt Graphs
\page qtgraphs-index.html
\brief Provides functionality for 3D graphs.
\brief Provides functionality for 2D and 3D graphs.
The Qt Graphs module enables you to visualize data in 3D as
bar, scatter, and surface graphs. It's especially useful for visualizing
The Qt Graphs module enables you to visualize data in 2D and 3D graphs.
3D has support for bar, scatter, and surface graphs. 2D has support for
bars, lines, and scatter. It's especially useful for visualizing
depth maps and large quantities of rapidly changing data, such as data
received from multiple sensors. The look and feel of graphs can be
customized by using themes or by adding custom items and labels.
@ -15,6 +16,8 @@
Qt Graphs is built on Qt 6 and the 3D graphs on Qt Quick 3D to take advantage of
hardware acceleration and Qt Quick.
\note This module is in Technical Preview
\section1 Using the Module
\section2 QtGraphs QML API
@ -45,15 +48,13 @@
\section1 Examples
\list
\li \l{Qt Graphs 2D Examples}
\li \l{Qt Graphs 3D Examples}
\li \l{Qt Graphs Examples}
\endlist
\section1 API Reference
\list
\li \l{Qt Graphs C++ Classes}
\li \l{Qt Graphs 2D QML Types}
\li \l{Qt Graphs 3D QML Types}
\li \l{Qt Graphs QML Types}
\endlist
\section1 Licenses and Attributions

View File

@ -3,11 +3,14 @@
/*!
\module QtGraphs
\title Qt Graphs C++ Classes
\ingroup modules
\qtcmakepackage Graphs
\qtvariable graphs
\modulestate Technical Preview
*/
/*!
\title Qt Graphs C++ Classes
\group graphs
\brief C++ classes for the Qt Graphs API.
@ -15,13 +18,43 @@
*/
/*!
\qmlmodule QtGraphs \QtMajorVersion.\QtMinorVersion
\title Qt Graphs 2D C++ Classes
\group graphs_2D
\ingroup graphs
\brief C++ classes for the Qt Graphs 2D API.
The Qt Graphs 2D functionality can be accessed via these C++ classes.
*/
/*!
\title Qt Graphs 3D C++ Classes
\group graphs_3D
\ingroup graphs
\brief C++ classes for the Qt Graphs 3D API.
The Qt Graphs 3D functionality can be accessed via these C++ classes.
*/
/*!
\qmlmodule QtGraphs
\modulestate Technical Preview
*/
/*!
\group graphs_qml_3D
\title Qt Graphs QML Types
\group graphs_qml
\brief QML types for the Qt Graphs API.
The Qt Graphs functionality can be accessed via these QML types.
*/
/*!
\title Qt Graphs 3D QML Types
\group graphs_qml_3D
\ingroup graphs_qml
\brief QML types for the Qt Graphs 3D API.
@ -31,8 +64,9 @@
*/
/*!
\group graphs_qml_2D
\title Qt Graphs 2D QML Types
\group graphs_qml_2D
\ingroup graphs_qml
\brief QML types for the Qt Graphs 2D API.
@ -42,8 +76,18 @@
*/
/*!
\group graphs_examples_3D
\group graphs_examples
\title Qt Graphs Examples
\brief Examples for the Qt Graphs.
For some code examples, see one of the Qt Graphs examples:
*/
/*!
\title Qt Graphs 3D Examples
\group graphs_examples_3D
\ingroup graphs_examples
\brief Examples for the Qt Graphs 3D.
@ -57,8 +101,9 @@
*/
/*!
\group graphs_examples_2D
\title Qt Graphs 2D Examples
\group graphs_examples_2D
\ingroup graphs_examples
\brief Examples for the Qt Graphs 2D.

View File

@ -9,6 +9,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QBarCategoryAxis
\inmodule QtGraphs
\ingroup graphs_2D
\brief The QBarCategoryAxis class adds categories to a chart's axes.
QBarCategoryAxis can be set up to show an axis line with tick marks, grid lines, and shades.

View File

@ -9,6 +9,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QAbstractAxis
\inmodule QtGraphs
\ingroup graphs_2D
\brief The QAbstractAxis class is a base class used for specialized axis classes.
Each series can be bound to one or more horizontal and vertical axes, but mixing axis types
@ -18,6 +19,7 @@ QT_BEGIN_NAMESPACE
The properties and visibility of various axis elements, such as axis line, title, labels,
and grid lines, can be individually controlled.
*/
/*!
\qmltype AbstractAxis
\instantiates QAbstractAxis

View File

@ -10,6 +10,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QValueAxis
\inmodule QtGraphs
\ingroup graphs_2D
\brief The QValueAxis class adds values to a chart's axes.
A value axis can be set up to show an axis line with tick marks, grid lines, and shades.

View File

@ -11,6 +11,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QAbstractBarSeries
\inmodule QtGraphs
\ingroup graphs_2D
\brief The QAbstractBarSeries class is an abstract parent class for all bar series classes.
In bar charts, bars are defined as bar sets that contain one data value for each category.

View File

@ -11,6 +11,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QBarSeries
\inmodule QtGraphs
\ingroup graphs_2D
\brief The QBarSeries class presents a series of data as vertical bars grouped by category.
This class draws data as a series of vertical bars grouped by category, with one bar per

View File

@ -10,6 +10,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QBarSet
\inmodule QtGraphs
\ingroup graphs_2D
\brief The QBarSet class represents one set of bars in a bar chart.
A bar set contains one data value for each category. The first value of a set is assumed to

View File

@ -10,6 +10,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QAbstractSeries
\inmodule QtGraphs
\ingroup graphs_2D
\brief The QAbstractSeries class is a base class for all Qt Chart series.
Usually, the series type specific inherited classes are used instead of the base class.

View File

@ -96,7 +96,3 @@ qt_internal_extend_target(Graphs CONDITION MACOS
Qt::GuiPrivate
)
qt_internal_add_docs(Graphs
doc/qtgraphs.qdocconf
)

View File

@ -9,6 +9,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QAbstract3DAxis
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QAbstract3DAxis class is a base class for the axes of a 3D graph.
*
* This class specifies the enumerations, properties, and functions shared by

View File

@ -9,6 +9,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QCategory3DAxis
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QCategory3DAxis class manipulates an axis of a graph.
*
* QCategory3DAxis provides an axis that can be given labels. The axis is

View File

@ -10,6 +10,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QLogValue3DAxisFormatter
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QLogValue3DAxisFormatter class provides formatting rules for a
* logarithmic value axis.
*

View File

@ -9,6 +9,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QValue3DAxis
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QValue3DAxis class manipulates an axis of a graph.
*
* A value axis can be given a range of values and segment and subsegment

View File

@ -9,6 +9,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QValue3DAxisFormatter
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QValue3DAxisFormatter class is a base class for 3D value axis
* formatters.
*

View File

@ -11,6 +11,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QAbstract3DSeries
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QAbstract3DSeries class is a base class for all 3D data series.
*
* There are inherited classes for each supported series type: QBar3DSeries,

View File

@ -9,6 +9,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QAbstractDataProxy
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QAbstractDataProxy class is a base class for all 3D graph proxies.
*
* The following graphs type specific inherited classes are used instead

View File

@ -13,6 +13,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QBar3DSeries
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QBar3DSeries class represents a data series in a 3D bar graph.
*
* This class manages the series specific visual elements, as well as the series

View File

@ -4,13 +4,14 @@
/*!
* \class QBarDataItem
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QBarDataItem class provides a container for resolved data to be
* added to bar graphs.
*
* A bar data item holds the data for a single rendered bar in a graph.
* Bar data proxies parse data into QBarDataItem instances for bar graphs.
*
* \sa QBarDataProxy, {Qt Graphs C++ Classes}
* \sa QBarDataProxy, {Qt Graphs 3D C++ Classes}
*/
/*!

View File

@ -9,6 +9,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QBarDataProxy
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QBarDataProxy class is the data proxy for a 3D bars graph.
*
* A bar data proxy handles adding, inserting, changing, and removing rows of

View File

@ -8,6 +8,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QCustom3DItem
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QCustom3DItem class adds a custom item to a graph.
*
* A custom item has a custom mesh, position, scaling, rotation, and an optional

View File

@ -9,6 +9,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QCustom3DLabel
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QCustom3DLabel class adds a custom label to a graph.
*
* The text, font, position, scaling, rotation, and colors of a custom label can

View File

@ -9,6 +9,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QCustom3DVolume
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QCustom3DVolume class adds a volume rendered object to a graph.
*
* A volume rendered

View File

@ -13,6 +13,7 @@ const float defaultMaxValue = 10.0f;
/*!
* \class QHeightMapSurfaceDataProxy
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief Base proxy class for Q3DSurface.
*
* QHeightMapSurfaceDataProxy takes care of surface related height map data

View File

@ -9,6 +9,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QItemModelBarDataProxy
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief Proxy class for presenting data in item models with Q3DBars.
*
* QItemModelBarDataProxy allows you to use QAbstractItemModel derived models as

View File

@ -9,6 +9,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QItemModelScatterDataProxy
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief Proxy class for presenting data in item models with Q3DScatter.
*
* QItemModelScatterDataProxy allows you to use QAbstractItemModel derived

View File

@ -9,6 +9,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QItemModelSurfaceDataProxy
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief Proxy class for presenting data in item models with Q3DSurface.
*
* QItemModelSurfaceDataProxy allows you to use QAbstractItemModel derived

View File

@ -11,6 +11,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QScatter3DSeries
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QScatter3DSeries class represents a data series in a 3D scatter
* graph.
*

View File

@ -4,6 +4,7 @@
/*!
* \class QScatterDataItem
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QScatterDataItem class provides a container for resolved data to
* be added to scatter graphs.
*
@ -11,7 +12,7 @@
* graph. Scatter data proxies parse data into QScatterDataItem instances for
* scatter graphs.
*
* \sa QScatterDataProxy, {Qt Graphs C++ Classes}
* \sa QScatterDataProxy, {Qt Graphs 3D C++ Classes}
*/
/*!

View File

@ -10,6 +10,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QScatterDataProxy
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QScatterDataProxy class is the data proxy for 3D scatter graphs.
*
* A scatter data proxy handles adding, inserting, changing, and removing data

View File

@ -11,6 +11,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QSurface3DSeries
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QSurface3DSeries class represents a data series in a 3D surface
* graph.
*

View File

@ -4,6 +4,7 @@
/*!
* \class QSurfaceDataItem
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QSurfaceDataItem class provides a container for resolved data to
* be added to surface graphs.
*
@ -11,7 +12,7 @@
* Surface data proxies parse data into QSurfaceDataItem instances for
* surface graphs.
*
* \sa QSurfaceDataProxy, {Qt Graphs C++ Classes}
* \sa QSurfaceDataProxy, {Qt Graphs 3D C++ Classes}
*/
/*!

View File

@ -10,6 +10,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QSurfaceDataProxy
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QSurfaceDataProxy class is the data proxy for a 3D surface graph.
*
* A surface data proxy handles surface related data in rows. For this it

View File

@ -12,7 +12,7 @@
This type is uncreatable, but it contains properties that are shared between
the 3D graphs types.
\sa Bars3D, Scatter3D, Surface3D, {Qt Graphs C++ Classes}
\sa Bars3D, Scatter3D, Surface3D, {Qt Graphs 3D C++ Classes}
*/
/*!

View File

@ -20,7 +20,7 @@
*
* See \l{Simple Bar Graph} for more thorough usage example.
*
* \sa Bar3DSeries, ItemModelBarDataProxy, Scatter3D, Surface3D, {Qt Graphs C++ Classes}
* \sa Bar3DSeries, ItemModelBarDataProxy, Scatter3D, Surface3D, {Qt Graphs 3D C++ Classes}
*/
/*!

View File

@ -20,7 +20,7 @@
See \l{Simple Scatter Graph} for more thorough usage example.
\sa Scatter3DSeries, ScatterDataProxy, Bars3D, Surface3D, {Qt Graphs C++ Classes}
\sa Scatter3DSeries, ScatterDataProxy, Bars3D, Surface3D, {Qt Graphs 3D C++ Classes}
*/
/*!

View File

@ -20,7 +20,7 @@
See \l{Surface Graph Gallery} for more thorough usage example.
\sa Surface3DSeries, ItemModelSurfaceDataProxy, Bars3D, Scatter3D, {Qt Graphs C++ Classes}
\sa Surface3DSeries, ItemModelSurfaceDataProxy, Bars3D, Scatter3D, {Qt Graphs 3D C++ Classes}
*/
/*!

View File

@ -9,6 +9,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class Q3DBars
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The Q3DBars class provides methods for rendering 3D bar graphs.
*
* This class enables developers to render bar graphs in 3D and to view them by
@ -69,7 +70,7 @@ QT_BEGIN_NAMESPACE
* can learn more by familiarizing yourself with the examples provided, like the
* \l{Simple Bar Graph}.
*
* \sa Q3DScatter, Q3DSurface, {Qt Graphs C++ Classes}
* \sa Q3DScatter, Q3DSurface, {Qt Graphs 3D C++ Classes}
*/
/*!

View File

@ -9,6 +9,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class Q3DScatter
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The Q3DScatter class provides methods for rendering 3D scatter graphs.
*
* This class enables developers to render scatter graphs in 3D and to view them
@ -55,7 +56,7 @@ QT_BEGIN_NAMESPACE
* example. You can learn more by familiarizing yourself with the examples
* provided, like the \l{Simple Scatter Graph}.
*
* \sa Q3DBars, Q3DSurface, {Qt Graphs C++ Classes}
* \sa Q3DBars, Q3DSurface, {Qt Graphs 3D C++ Classes}
*/
/*!

View File

@ -8,6 +8,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class Q3DScene
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief Q3DScene class provides description of the 3D scene being visualized.
*
* The 3D scene contains a single active camera and a single active light

View File

@ -9,6 +9,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class Q3DSurface
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The Q3DSurface class provides methods for rendering 3D surface plots.
*
* This class enables developers to render 3D surface plots and to view them by
@ -73,7 +74,7 @@ QT_BEGIN_NAMESPACE
* provided, like the \l{Surface Graph Gallery}.
*
*
* \sa Q3DBars, Q3DScatter, {Qt Graphs C++ Classes}
* \sa Q3DBars, Q3DScatter, {Qt Graphs 3D C++ Classes}
*/
/*!

View File

@ -14,6 +14,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QAbstract3DGraph
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The QAbstract3DGraph class provides a window and render loop for
* graphs.
*
@ -39,7 +40,7 @@ QT_BEGIN_NAMESPACE
* graphWindow->setFlags(graphWindow->flags() ^ Qt::FramelessWindowHint);
* \endcode
*
* \sa Q3DBars, Q3DScatter, Q3DSurface, {Qt Graphs C++ Classes}
* \sa Q3DBars, Q3DScatter, Q3DSurface, {Qt Graphs 3D C++ Classes}
*/
/*!

View File

@ -23,6 +23,7 @@ static const float rotationSpeed = 100.0f;
/*!
* \class Q3DInputHandler
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief Basic wheel mouse based input handler.
*
* Q3DInputHandler is the basic input handler for wheel mouse type of input

View File

@ -8,6 +8,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class QAbstract3DInputHandler
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief The base class for implementations of 3D input handlers.
*
* QAbstract3DInputHandler is the base class that is subclassed by different

View File

@ -22,6 +22,7 @@ static const float touchZoomDrift = 0.02f;
/*!
* \class QTouch3DInputHandler
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief Basic touch display based input handler.
*
* QTouch3DInputHandler is the basic input handler for touch screen devices.

View File

@ -13,6 +13,7 @@ QT_BEGIN_NAMESPACE
/*!
* \class Q3DTheme
* \inmodule QtGraphs
* \ingroup graphs_3D
* \brief Q3DTheme class provides a visual style for graphs.
*
* Specifies visual properties that affect the whole graph. There are several