HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r2750:0968736234d9

Fix documentation appearance...

Titta Heikkala -

r2750:0968736234d9

parent child

Context file:

r2750:0968736234d9

Collapse all files

src/charts/axis/categoryaxis/qcategoryaxis.cpp +2 -14

                 Unlike with the QBarCategoryAxis the QCategoryAxis allows the categories ranges widths to be specified freely.
                 Example code on how to use QCategoryAxis:
-                \table
+                \image api_category_axis.png
-                    \row
-                        \li  \br
-                            \br
                 \code
                 QChartView *chartView = new QChartView;
                 QLineSeries *series = new QLineSeries;
                 axisY->append("Third", 52);
                 chartView->chart()->setAxisY(axisY, series);
                 \endcode
-                        \li \br
-                           \inlineimage api_category_axis.png
-                \endtable
             */
             /*!
                 \qmltype CategoryAxis
                 \brief CategoryAxis allows putting a named ranges on the axis.
                 For example:
-                \table
+                \image examples_qmlaxes3.png
-                    \row
-                        \li \br
-                            \br
-                            \br
                 \snippet qmlaxes/qml/qmlaxes/View3.qml 1
-                        \li \inlineimage examples_qmlaxes3.png
-                \endtable
             */
             /*!

src/charts/doc/src/examples-audio.qdoc +1 -1

             /*!
                  \example audio
-                 \title Audio example
+                 \title Audio Example
                  \ingroup qtcharts_examples
                  \brief This example shows the drawing of dynamic data (microphone input).

src/charts/doc/src/examples-barmodelmapper.qdoc +1 -1

             /*!
                  \example barmodelmapper
-                 \title BarModelMapper example
+                 \title BarModelMapper Example
                  \ingroup qtcharts_examples
                  \brief This example shows how to use QAbstractItemModel derived model as the data for the bar

src/charts/doc/src/examples-callout.qdoc +1 -1

             /*!
                  \example callout
-                 \title Callout example
+                 \title Callout Example
                  \ingroup qtcharts_examples
                  \brief This example shows how to draw an additional element (a callout) on top of the chart.

src/charts/doc/src/examples-chartthemes.qdoc +1 -1

             /*!
                 \example chartthemes
-                \title Chart themes example
+                \title Chart Themes Example
                 \ingroup qtcharts_examples
                 \brief The example shows the look and feel of the different built-in themes.

src/charts/doc/src/examples-donutbreakdown.qdoc +1 -1

             /*!
                  \example donutbreakdown
-                 \title Donut chart breakdown example
+                 \title Donut Chart Breakdown Example
                  \ingroup qtcharts_examples
                  \brief This example shows how to use create a donut breakdown chart using QPieSeries API.

src/charts/doc/src/examples-dynamicspline.qdoc +1 -1

             /*!
                  \example dynamicspline
-                 \title Dynamic spline example
+                 \title Dynamic Spline Example
                  \ingroup qtcharts_examples
                  \brief This example shows how to draw dynamic data.

src/charts/doc/src/examples-legend.qdoc +2 -5

                 alignment can be modified.
                 When the legend is detached, it can be resized and positioned freely.
-                \table
+                \image examples_legend_detach.png
-                    \row
+                \image examples_legend_detach2.png
-                        \li \inlineimage examples_legend_detach.png
-                        \li \inlineimage examples_legend_detach2.png
-                \endtable
                 Here we turn the legend visible and set its alignment to the bottom of the chart.

src/charts/doc/src/examples-nesteddonuts.qdoc +1 -1

             /*!
                  \example nesteddonuts
-                 \title Nested donuts example
+                 \title Nested Donuts Example
                  \ingroup qtcharts_examples
                  \brief This example shows how to create a nested donuts chart using the QPieSeries API.

src/charts/doc/src/examples-piechartcustomization.qdoc +1 -1

             /*!
                 \example piechartcustomization
-                \title Pie chart customization example
+                \title Pie Chart Customization Example
                 \ingroup qtcharts_examples
                 \brief This example shows how the look and feel of a pie chart can be customized.

src/charts/doc/src/examples-qmlaxes.qdoc +8 -17

@@ -23,28 +23,19
23		23
24	\brief This is a demonstration of how to use axes in your QML application.	24	\brief This is a demonstration of how to use axes in your QML application.
25		25
26	\table
27	\row
28	\li \br
29	We begin with a chart that has a line series and a scatter series with random	26	We begin with a chart that has a line series and a scatter series with random
30	data. Both series use the same axes.	27	data. Both series use the same axes.
31	\br	28
32	\br	29	\image examples_qmlaxes1.png
33	\snippet qmlaxes/qml/qmlaxes/View1.qml 1	30	\snippet qmlaxes/qml/qmlaxes/View1.qml 1
34	\li \inlineimage examples_qmlaxes1.png	31
35	\row
36	\li \br
37	The next example shows a chart with some accurate historical data that makes us to use a DateTimeAxis.	32	The next example shows a chart with some accurate historical data that makes us to use a DateTimeAxis.
38	\br	33
39	\br	34	\image examples_qmlaxes2.png
40	\snippet qmlaxes/qml/qmlaxes/View2.qml 1	35	\snippet qmlaxes/qml/qmlaxes/View2.qml 1
41	\li \inlineimage examples_qmlaxes2.png	36
42	\row
43	\li \br
44	And the final example with a chart that uses a CategoryAxis to make the data easier to understand.	37	And the final example with a chart that uses a CategoryAxis to make the data easier to understand.
45	\br	38
46	\br	39	\image examples_qmlaxes3.png
47	\snippet qmlaxes/qml/qmlaxes/View3.qml 1	40	\snippet qmlaxes/qml/qmlaxes/View3.qml 1
48	\li \inlineimage examples_qmlaxes3.png
49	\endtable
50	*/	41	*/

src/charts/doc/src/examples-qmlchart.qdoc +27 -88

@@ -18,126 +18,65
18		18
19	/*!	19	/*!
20	\example qmlchart	20	\example qmlchart
21	\title Qml ~~charts e~~xample	21	\title Qml Charts Example
22	\ingroup qtcharts_examples	22	\ingroup qtcharts_examples
23		23
24	\brief This basic demonstration shows how to use the different chart types by using qml.	24	\brief This basic demonstration shows how to use the different chart types by using qml.
25		25
26	Creating each chart type begins with the creation of a ChartView.	26	Creating each chart type begins with the creation of a ChartView.
27		27
28	\table
29	\row
30	\li \br
31	To create a pie, we use the PieSeries API together with a few PieSlices:	28	To create a pie, we use the PieSeries API together with a few PieSlices:
32	\br	29
33	\br	30	\image examples_qmlchart1.png
34	\snippet qmlchart/qml/qmlchart/View1.qml 1	31	\snippet qmlchart/qml/qmlchart/View1.qml 1
35	\li \inlineimage examples_qmlchart1.png
36	\endtable
37		32
38	\table
39	\row
40	\li \br
41	To create a chart with a line series:	33	To create a chart with a line series:
42	\br	34
43	\br	35	\image examples_qmlchart2.png
44	\snippet qmlchart/qml/qmlchart/View2.qml 1	36	\snippet qmlchart/qml/qmlchart/View2.qml 1
45	\li \inlineimage examples_qmlchart2.png
46	\endtable
47		37
48	\table
49	\row
50	\li \br
51	And spline series:	38	And spline series:
52	\br	39
53	\br	40	\image examples_qmlchart3.png
54	\snippet qmlchart/qml/qmlchart/View3.qml 1	41	\snippet qmlchart/qml/qmlchart/View3.qml 1
55	\li \inlineimage examples_qmlchart3.png
56	\endtable
57		42
58	\table
59	\row
60	\li \br
61	Then we create a chart that illustrates the NHL All-Star player selections by using	43	Then we create a chart that illustrates the NHL All-Star player selections by using
62	three area series:	44	three area series:
63	\br	45
64	\br	46	\image examples_qmlchart4.png
65	\snippet qmlchart/qml/qmlchart/View4.qml 1	47	\snippet qmlchart/qml/qmlchart/View4.qml 1
66	\dots	48	\dots
67	\li \inlineimage examples_qmlchart4.png
68	\endtable
69		49
70	\table
71	\row
72	\li \br
73	Then a couple of scatter series:	50	Then a couple of scatter series:
74	\br	51
75	\br	52	\image examples_qmlchart5.png
76	\snippet qmlchart/qml/qmlchart/View5.qml 1	53	\snippet qmlchart/qml/qmlchart/View5.qml 1
77	\dots	54	\dots
78	\li \inlineimage examples_qmlchart5.png
79	\endtable
80		55
81	And a few different bar series:	56	And a few different bar series:
82	\table	57
83	\row	58	\image examples_qmlchart6.png
84	\li \br
85	\br
86	\br
87	\snippet qmlchart/qml/qmlchart/View6.qml 1	59	\snippet qmlchart/qml/qmlchart/View6.qml 1
88	\li \inlineimage examples_qmlchart6.png	60
89	\endtable	61	\image examples_qmlchart7.png
90	\table
91	\row
92	\li \br
93	\br
94	\br
95	\snippet qmlchart/qml/qmlchart/View7.qml 1	62	\snippet qmlchart/qml/qmlchart/View7.qml 1
96	\li \inlineimage examples_qmlchart7.png	63
97	\endtable	64	\image examples_qmlchart8.png
98	\table
99	\row
100	\li \br
101	\br
102	\br
103	\snippet qmlchart/qml/qmlchart/View8.qml 1	65	\snippet qmlchart/qml/qmlchart/View8.qml 1
104	\li \inlineimage examples_qmlchart8.png	66
105	\endtable	67	\image examples_qmlchart9.png
106	\table
107	\row
108	\li \br
109	\br
110	\br
111	\snippet qmlchart/qml/qmlchart/View9.qml 1	68	\snippet qmlchart/qml/qmlchart/View9.qml 1
112	\li \inlineimage examples_qmlchart9.png	69
113	\endtable	70	\image examples_qmlchart10.png
114	\table
115	\row
116	\li \br
117	\br
118	\br
119	\snippet qmlchart/qml/qmlchart/View10.qml 1	71	\snippet qmlchart/qml/qmlchart/View10.qml 1
120	\li \inlineimage examples_qmlchart10.png	72
121	\endtable	73	\image examples_qmlchart11.png
122	\table
123	\row
124	\li \br
125	\br
126	\br
127	\snippet qmlchart/qml/qmlchart/View11.qml 1	74	\snippet qmlchart/qml/qmlchart/View11.qml 1
128	\li \inlineimage examples_qmlchart11.png	75
129	\endtable	76	And finally an example demonstrating how to create a donut chart with two pie series:
130		77
131	\table	78	\image examples_qmlchart12.png
132	\row
133	\li \br
134	And finally an example demonstrating how to create a donut chart with two pie
135	series:
136	\br
137	\br
138	\snippet qmlchart/qml/qmlchart/View12.qml 1	79	\snippet qmlchart/qml/qmlchart/View12.qml 1
139	\li \inlineimage examples_qmlchart12.png
140	\endtable
141		80
142	Additionally, antialiasing is set with the qml property in Qt Quick 2.	81	Additionally, antialiasing is set with the qml property in Qt Quick 2.
143	*/	82	*/

src/charts/doc/src/examples-qmlcustomlegend.qdoc +8 -20

                 This application shows you how to create your own custom legend instead of using the
                 built-in legend of ChartView API.
-                \table
-                    \row
-                        \li \br
                 The main view of the application shows a stacked area chart. This is how one of
-                            \br
                 the stacked areas is created. See ChartViewStacked.qml and AnimatedAreaSeries.qml.
-                            \br
-                            \br
+                \image examples_qmlcustomlegend1.png
                 \snippet qmlcustomlegend/qml/qmlcustomlegend/ChartViewStacked.qml 1
-                        \li \inlineimage examples_qmlcustomlegend1.png
-                    \row
-                        \li \br
                 Hovering with mouse on top of the legend will highlight the hovered series.
-                            \br
                 (see CustomLegend.qml).
-                            \br
-                            \br
+                \image examples_qmlcustomlegend2.png
                 \snippet qmlcustomlegend/qml/qmlcustomlegend/CustomLegend.qml 1
                 \snippet qmlcustomlegend/qml/qmlcustomlegend/CustomLegend.qml 2
                 \dots
                 \snippet qmlcustomlegend/qml/qmlcustomlegend/CustomLegend.qml 3
-                        \li \inlineimage examples_qmlcustomlegend2.png
-                    \row
-                        \li \br
                 You can also select one of the stacked areas for a closer look as a line series by
-                            \br
                 a mouse click (see ChartViewHighlighted.qml).
-                            \br
-                            \br
+                \image examples_qmlcustomlegend3.png
                 \snippet qmlcustomlegend/qml/qmlcustomlegend/ChartViewHighlighted.qml 1
-                        \li \inlineimage examples_qmlcustomlegend3.png
-                \endtable
             */

src/charts/doc/src/examples-qmlpolarchart.qdoc +9 -19

@@ -23,31 +23,21
23		23
24	\brief This is a demonstration on how to use a polar chart in your QML application.	24	\brief This is a demonstration on how to use a polar chart in your QML application.
25		25
26	\table
27	\row
28	\li \br
29	We begin with a chart that has a spline series and a scatter series with random	26	We begin with a chart that has a spline series and a scatter series with random
30	data. Both series use the same axes.	27	data. Both series use the same axes.
31	\br	28
32	\br	29	\image examples_qmlpolarchart1.png
33	\snippet qmlpolarchart/qml/qmlpolarchart/View1.qml 1	30	\snippet qmlpolarchart/qml/qmlpolarchart/View1.qml 1
34	\li \inlineimage examples_qmlpolarchart1.png	31
35	\row
36	\li \br
37	The next example shows a chart with some accurate historical data for which we need	32	The next example shows a chart with some accurate historical data for which we need
38	to use a DateTimeAxis	33	to use a DateTimeAxis and a AreaSeries.
39	and a AreaSeries.	34
40	\br	35	\image examples_qmlpolarchart2.png
41	\br
42	\snippet qmlpolarchart/qml/qmlpolarchart/View2.qml 1	36	\snippet qmlpolarchart/qml/qmlpolarchart/View2.qml 1
43	\li \inlineimage examples_qmlpolarchart2.png	37
44	\row
45	\li \br
46	And the final example with a chart that uses a CategoryAxis to make the data easier	38	And the final example with a chart that uses a CategoryAxis to make the data easier
47	to understand.	39	to understand.
48	\br	40
49	\br	41	\image examples_qmlpolarchart3.png
50	\snippet qmlpolarchart/qml/qmlpolarchart/View3.qml 1	42	\snippet qmlpolarchart/qml/qmlpolarchart/View3.qml 1
51	\li \inlineimage examples_qmlpolarchart3.png
52	\endtable
53	*/	43	*/

src/charts/doc/src/examples-scatterinteractions.qdoc 0 0

NO CONTENT: modified file

src/charts/doc/src/examples-temperaturerecords.qdoc +1 -1

             /*!
                 \example temperaturerecords
-                \title Temperature records example
+                \title Temperature Records Example
                 \ingroup qtcharts_examples
                 \brief The example shows how to create a bar chart with negative bars.

src/charts/doc/src/index.qdoc +1 -2

                 \page index.html
                 \keyword About
-                Qt Charts is a part of the Qt Enterprise addons package. It provides a set of easy to use chart
+                Qt Charts module provides a set of easy to use chart components. It uses the Qt Graphics View
-                components which are available for Qt customers. It uses the Qt Graphics View
                 Framework, therefore charts can be easily integrated to modern user interfaces. Qt Charts can
                 be used as QWidgets, QGraphicsWidget, or QML types. Users can easily create impressive
                 graphs by selecting one of the charts themes.

src/charts/doc/src/qtcharts.qdoc +1 -7

                 The Qt Charts QML API is an intuitive and simple way to show charts in your QML
                 applications.
-                \table
-                    \row
-                        \li \br
                 Use the following QML to create a simple pie chart:
-                            \br
+                \image examples_qmlpiechart.png
-                            \br
                 \snippet qmlpiechart/qml/qmlpiechart/main.qml 1
                 \snippet qmlpiechart/qml/qmlpiechart/main.qml 2
                 \snippet qmlpiechart/qml/qmlpiechart/main.qml 3
-                        \li \inlineimage examples_qmlpiechart.png
-                \endtable
                 \note Since Qt Creator 3.0 the project created with Qt Quick Application wizard based on
                 Qt Quick 2 template uses QGuiApplication by default. As Qt Charts utilizes Qt Graphics View

src/charts/piechart/qpieseries.cpp +2 -5

                 Full pie is 360 degrees where 0 is at 12 a'clock.
                 See the \l {PieChart Example} {pie chart example} or \l {DonutChart Example} {donut chart example} to learn how to use QPieSeries.
-                \table 100%
+                \image examples_piechart.png
-                \row
+                \image examples_donutchart.png
-                \li \image examples_piechart.png
-                \li \image examples_donutchart.png
-                \endtable
             */
             /*!
                 \qmltype PieSeries

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages