##// END OF EJS Templates
Fix various documentation issues...
Miikka Heikkinen -
r2582:8fe6fadece73
parent child
Show More
1 NO CONTENT: new file 100644, binary diff hidden
NO CONTENT: new file 100644, binary diff hidden
@@ -45,8 +45,8 contains(QT_MAJOR_VERSION, 5) {
45 HELPGENERATOR_CMD = qhelpgenerator
45 HELPGENERATOR_CMD = qhelpgenerator
46 }
46 }
47
47
48 QHP_FILE = doc/html/qtcommercialcharts.qhp
48 QHP_FILE = doc/html/qtcharts.qhp
49 QCH_FILE = doc/qch/qtcommercialcharts.qch
49 QCH_FILE = doc/qch/qtcharts.qch
50
50
51 docs.target = docs
51 docs.target = docs
52 docs.depends = qch_docs FORCE
52 docs.depends = qch_docs FORCE
@@ -31,7 +31,7 HTML.footer = \
31 "</div> \n" \
31 "</div> \n" \
32 "<div class=\"footer\">\n" \
32 "<div class=\"footer\">\n" \
33 " <p>\n" \
33 " <p>\n" \
34 " <acronym title=\"Copyright\">&copy;</acronym> 2013 Digia ." \
34 " <acronym title=\"Copyright\">&copy;</acronym> 2013 Digia." \
35 " Qt and Qt logos are trademarks of of Digia Corporation \n" \
35 " Qt and Qt logos are trademarks of of Digia Corporation \n" \
36 " in Finland and/or other countries worldwide.</p>\n" \
36 " in Finland and/or other countries worldwide.</p>\n" \
37 " <p>\n" \
37 " <p>\n" \
@@ -12,7 +12,7 HTML.scripts =
12 # These also need to be listed in qhp.Qt.extraFiles with the correct
12 # These also need to be listed in qhp.Qt.extraFiles with the correct
13 # directory prefixes.
13 # directory prefixes.
14
14
15 extraimages.HTML = qt_commercial_logo.png \
15 extraimages.HTML = qt-logo.png \
16 digia_logo.png \
16 digia_logo.png \
17 qcharts.png \
17 qcharts.png \
18 arrow_down.png \
18 arrow_down.png \
@@ -1,33 +1,33
1 qhp.projects = QtCommercialCharts
1 qhp.projects = QtCharts
2 qhp.QtCommercialCharts.file = qtcommercialcharts.qhp
2 qhp.QtCharts.file = qtcharts.qhp
3 qhp.QtCommercialCharts.namespace = com.digia.qtcommercialcharts.$QT_CHARTS_VERSION_TAG
3 qhp.QtCharts.namespace = com.digia.qtcharts.$QT_CHARTS_VERSION_TAG
4 qhp.QtCommercialCharts.virtualFolder = doc
4 qhp.QtCharts.virtualFolder = doc
5 qhp.QtCommercialCharts.indexTitle = QtCommercial Charts Reference $QT_CHARTS_VERSION
5 qhp.QtCharts.indexTitle = Qt Charts Reference $QT_CHARTS_VERSION
6 qhp.QtCommercialCharts.filterAttributes = qtcommercialcharts $QT_CHARTS_VERSION
6 qhp.QtCharts.filterAttributes = qtcharts $QT_CHARTS_VERSION
7 qhp.QtCommercialCharts.customFilters.QtCommercialCharts.name = QtCommercial Charts $QT_CHARTS_VERSION
7 qhp.QtCharts.customFilters.QtCharts.name = Qt Charts $QT_CHARTS_VERSION
8 qhp.QtCommercialCharts.customFilters.QtCommercialCharts.filterAttributes = qtcommercialcharts $QT_CHARTS_VERSION
8 qhp.QtCharts.customFilters.QtCharts.filterAttributes = qtcharts $QT_CHARTS_VERSION
9 qhp.QtCommercialCharts.indexRoot =
9 qhp.QtCharts.indexRoot =
10
10
11 qhp.QtCommercialCharts.subprojects = gettingstarted classes qmlclasses examples demos
11 qhp.QtCharts.subprojects = gettingstarted classes qmlclasses examples demos
12
12
13 qhp.QtCommercialCharts.subprojects.gettingstarted.title = Getting Started
13 qhp.QtCharts.subprojects.gettingstarted.title = Getting Started
14 qhp.QtCommercialCharts.subprojects.gettingstarted.indexTitle = QtCommercial Charts getting started
14 qhp.QtCharts.subprojects.gettingstarted.indexTitle = Qt Charts getting started
15
15
16 qhp.QtCommercialCharts.subprojects.classes.title = API Classes
16 qhp.QtCharts.subprojects.classes.title = API Classes
17 qhp.QtCommercialCharts.subprojects.classes.indexTitle = QtCommercial Charts API
17 qhp.QtCharts.subprojects.classes.indexTitle = Qt Charts API
18
18
19 qhp.QtCommercialCharts.subprojects.qmlclasses.title = QML API
19 qhp.QtCharts.subprojects.qmlclasses.title = QML API
20 qhp.QtCommercialCharts.subprojects.qmlclasses.indexTitle = QtCommercial Charts QML API
20 qhp.QtCharts.subprojects.qmlclasses.indexTitle = Qt Charts QML API
21
21
22 qhp.QtCommercialCharts.subprojects.examples.title = Examples
22 qhp.QtCharts.subprojects.examples.title = Examples
23 qhp.QtCommercialCharts.subprojects.examples.indexTitle = QtCommercial Charts Examples
23 qhp.QtCharts.subprojects.examples.indexTitle = Qt Charts Examples
24
24
25 qhp.QtCommercialCharts.subprojects.demos.title = Demos
25 qhp.QtCharts.subprojects.demos.title = Demos
26 qhp.QtCommercialCharts.subprojects.demos.indexTitle = QtCommercial Charts Demos
26 qhp.QtCharts.subprojects.demos.indexTitle = Qt Charts Demos
27
27
28 # Files not referenced in any qdoc file.
28 # Files not referenced in any qdoc file.
29 # See also extraimages.HTML
29 # See also extraimages.HTML
30 qhp.QtCommercialCharts.extraFiles = index.html \
30 qhp.QtCharts.extraFiles = index.html \
31 examples.html \
31 examples.html \
32 demos.html \
32 demos.html \
33 images/arrow_down.png \
33 images/arrow_down.png \
@@ -40,5 +40,5 qhp.QtCommercialCharts.extraFiles = index.html \
40 images/digia_logo.png \
40 images/digia_logo.png \
41 images/horBar.png \
41 images/horBar.png \
42 images/qcharts.png \
42 images/qcharts.png \
43 images/qt_commercial_logo.png \
43 images/qt-logo.png \
44 style/offline.css
44 style/offline.css
@@ -1,10 +1,10
1 /*!
1 /*!
2 \page classes.html
2 \page classes.html
3 \title Qt Enterprise Charts API
3 \title Qt Charts API
4 \keyword All Classes
4 \keyword All Classes
5
5
6 Charts API is build on top of Qt Graphics View Framework. Charts can be displayed as QGraphicsWidget using QChart class. However
6 Charts API is build on top of Qt Graphics View Framework. Charts can be displayed as QGraphicsWidget using QChart class. However
7 there is also convenience class QChartView which is QWidget based. These lets quickly use QCharts as normal Qt widget.
7 there is also convenience class QChartView which is QWidget based. These lets quickly use Qt Charts as normal Qt widget.
8
8
9 Each chart type is represented by QAbstractSeries derived class. To create given chart type users have to use instance of related series class and add it to QChart instance.
9 Each chart type is represented by QAbstractSeries derived class. To create given chart type users have to use instance of related series class and add it to QChart instance.
10 \code
10 \code
@@ -4,7 +4,7
4
4
5 \image demos_qmloscilloscope.png
5 \image demos_qmloscilloscope.png
6
6
7 Oscilloscope application demonstrates how to use Qt Enterprise Charts QML API to implement an
7 Oscilloscope application demonstrates how to use Qt Charts QML API to implement an
8 application with strict performance requirements. The application uses generated data with
8 application with strict performance requirements. The application uses generated data with
9 configurable characteristics to mimic a simple oscilloscope user interface. To find out the
9 configurable characteristics to mimic a simple oscilloscope user interface. To find out the
10 actual screen refresh performance of the application, you can set QML_SHOW_FRAMERATE = 1 to
10 actual screen refresh performance of the application, you can set QML_SHOW_FRAMERATE = 1 to
@@ -1,13 +1,15
1 /*!
1 /*!
2 \example demos/quick2chart
2 \example demos/quick2chart
3 \title QtQuick 2 charts demo
3 \title Qt Quick 2 charts demo
4 \subtitle
4 \subtitle
5
5
6 \image demos_qmlchart1.png
6 \image demos_qmlchart1.png
7
7
8 This is a reimplementation of \l{Qml charts demo} in QtQuick 2.
8 This is a reimplementation of \l{Qml charts demo} in Qt Quick 2.
9
9
10 Only difference in qml files is importing the correct version of QtQuick:
10 The main difference in qml files is importing the correct version of Qt Quick:
11
11
12 \snippet ../demos/quick2chart/qml/quick2chart/View1.qml 2
12 \snippet ../demos/quick2chart/qml/quick2chart/View1.qml 2
13
14 Additionally, antialiasing is set with qml property in Qt Quick 2.
13 */
15 */
@@ -1,16 +1,16
1 /*!
1 /*!
2 \example demos/quick2oscilloscope
2 \example demos/quick2oscilloscope
3 \title QtQuick 2 Oscilloscope
3 \title Qt Quick 2 Oscilloscope
4
4
5 \image demos_qmloscilloscope.png
5 \image demos_qmloscilloscope.png
6
6
7 This is a reimplementation of \l{Oscilloscope} demo in QtQuick 2.
7 This is a reimplementation of \l{Oscilloscope} demo in Qt Quick 2.
8
8
9 Only difference in qml files is importing the correct version of QtQuick:
9 The main difference in qml files is importing the correct version of Qt Quick:
10
10
11 \snippet ../demos/quick2oscilloscope/qml/quick2oscilloscope/main.qml 3
11 \snippet ../demos/quick2oscilloscope/qml/quick2oscilloscope/main.qml 3
12
12
13 \note QML_SHOW_FRAMERATE environment variable doesn't work with QtQuick 2.
13 \note QML_SHOW_FRAMERATE environment variable doesn't work with Qt Quick 2.
14 Starting with Qt 5.1.0, QSG_RENDER_TIMING environment variable can be used
14 Starting with Qt 5.1.0, QSG_RENDER_TIMING environment variable can be used
15 similarly to display rendering time.
15 similarly to display rendering time.
16 */
16 */
@@ -1,6 +1,6
1 /*!
1 /*!
2 \page demos.html
2 \page demos.html
3 \title Qt Enterprise Charts Demos
3 \title Qt Charts Demos
4 \keyword Demos
4 \keyword Demos
5
5
6 \raw HTML
6 \raw HTML
@@ -65,17 +65,17
65 </tr>
65 </tr>
66 <tr>
66 <tr>
67 <td><a href="demos-qmlpolarchart.html">Qml Polar Chart</a></td>
67 <td><a href="demos-qmlpolarchart.html">Qml Polar Chart</a></td>
68 <td><a href="demos-quick2chart.html">QtQuick 2 Basic Charts</a></td>
68 <td><a href="demos-quick2chart.html">Qt Quick 2 Basic Charts</a></td>
69 </tr>
69 </tr>
70 <tr>
70 <tr>
71 <td><a href="demos-qmlpolarchart.html"><img src="images/demos_qmlpolarchart1.png" width="300" alt="Qml Polar Chart" /></a></td>
71 <td><a href="demos-qmlpolarchart.html"><img src="images/demos_qmlpolarchart1.png" width="300" alt="Qml Polar Chart" /></a></td>
72 <td><a href="demos-quick2chart.html"><img src="images/demos_qmlchart1.png" width="300" alt="QtQuick 2 Basic Charts" /></a></td>
72 <td><a href="demos-quick2chart.html"><img src="images/demos_qmlchart1.png" width="300" alt="Qt Quick 2 Basic Charts" /></a></td>
73 </tr>
73 </tr>
74 <tr>
74 <tr>
75 <td><a href="demos-quick2oscilloscope.html">QtQuick 2 Oscilloscope</a></td>
75 <td><a href="demos-quick2oscilloscope.html">Qt Quick 2 Oscilloscope</a></td>
76 </tr>
76 </tr>
77 <tr>
77 <tr>
78 <td><a href="demos-quick2oscilloscope.html"><img src="images/demos_qmloscilloscope.png" width="300" alt="QtQuick 2 Oscilloscope" /></a></td>
78 <td><a href="demos-quick2oscilloscope.html"><img src="images/demos_qmloscilloscope.png" width="300" alt="Qt Quick 2 Oscilloscope" /></a></td>
79 </tr>
79 </tr>
80 </table>
80 </table>
81 </div>
81 </div>
@@ -1,6 +1,6
1 /*!
1 /*!
2 \page examples.html
2 \page examples.html
3 \title Qt Enterprise Charts Examples
3 \title Qt Charts Examples
4 \keyword Examples
4 \keyword Examples
5
5
6 \raw HTML
6 \raw HTML
@@ -1,6 +1,6
1 /*!
1 /*!
2 \page gettingstarted.html
2 \page gettingstarted.html
3 \title Qt Enterprise Charts getting started
3 \title Qt Charts getting started
4 \keyword Introduction
4 \keyword Introduction
5
5
6 Compiling:
6 Compiling:
@@ -12,7 +12,7
12
12
13 Depending on the OS and the compiler you are using "make" might need to be replaced with another command like: nmake, mingw32-make, etc.
13 Depending on the OS and the compiler you are using "make" might need to be replaced with another command like: nmake, mingw32-make, etc.
14
14
15 To uninstall the Qt Enterprise Charts run:
15 To uninstall the Qt Charts run:
16 \code
16 \code
17 make uninstall
17 make uninstall
18 \endcode
18 \endcode
@@ -43,7 +43,7
43
43
44 \bold {Widget project}
44 \bold {Widget project}
45
45
46 To use the QCharts classes add Qt Enterprise Charts namespace macro in your header file.
46 To use the Qt Charts classes add Qt Charts namespace macro in your header file.
47 \code
47 \code
48 #include<QWidget>
48 #include<QWidget>
49 #include<QChartView>
49 #include<QChartView>
@@ -57,7 +57,7
57
57
58 Add an import line to your *.qml file:
58 Add an import line to your *.qml file:
59 \code
59 \code
60 import QtCommercial.Chart 1.2
60 import QtCommercial.Chart 1.3
61 \endcode
61 \endcode
62
62
63 \raw HTML
63 \raw HTML
@@ -4,12 +4,12
4
4
5 \raw HTML
5 \raw HTML
6 <div class="qchart">
6 <div class="qchart">
7 <img src="images/qt_commercial_logo.png" alt="qt_logo"/>
7 <img src="images/qt-logo.png" alt="qt-logo"/>
8
8
9 <p>
9 <p>
10 QCharts is a part of Qt Enterprise addons package. It provides a set of easy to use chart
10 Qt Charts is a part of Qt addons package. It provides a set of easy to use chart
11 components which are available for Qt Enterprise customers. It uses Qt Graphics View
11 components which are available for Qt customers. It uses Qt Graphics View
12 Framework, therefore charts can be easily integrated to modern user interfaces. QCharts can
12 Framework, therefore charts can be easily integrated to modern user interfaces. Qt Charts can
13 be used as QWidgets, QGraphicsWidget or QML elements. Users can easily create impressive
13 be used as QWidgets, QGraphicsWidget or QML elements. Users can easily create impressive
14 graphs by selecting one of the charts themes.
14 graphs by selecting one of the charts themes.
15 </p>
15 </p>
@@ -1,9 +1,9
1 /*!
1 /*!
2 \page qml.html
2 \page qml.html
3 \title Qt Enterprise Charts QML API
3 \title Qt Charts QML API
4 \keyword Charts QML API
4 \keyword Charts QML API
5
5
6 Qt Enterprise Charts QML API is an intuitive and simple way to show charts in your QML
6 Qt Charts QML API is an intuitive and simple way to show charts in your QML
7 applications.
7 applications.
8
8
9 \table
9 \table
@@ -18,13 +18,13
18 \o \inlineimage examples_qmlpiechart.png
18 \o \inlineimage examples_qmlpiechart.png
19 \endtable
19 \endtable
20
20
21 \note Since Qt Enterprise Charts utilizes Qt Graphics View Framework for drawing, it works best
21 \note Since Qt Charts utilizes Qt Graphics View Framework for drawing, it works best
22 with QtQuick 1, which is based on the same framework.
22 with Qt Quick 1, which is based on the same framework.
23 As of release 1.3.0, Qt Enterprise Charts is also usable with QtQuick 2, though the performance
23 As of release 1.3.0, Qt Charts is also usable with Qt Quick 2, though the performance
24 is slightly worse than with QtQuick 1 due to additional rendering step that is required.
24 is slightly worse than with Qt Quick 1 due to additional rendering step that is required.
25
25
26 \note QtQuick 1 is supported from Qt 4.7.4 onwards because of missing
26 \note Qt Quick 1 is supported from Qt 4.7.4 onwards because of missing
27 Q_REVISION macro in the earlier Qt releases. QtQuick 2 is supported with only Qt 5.
27 Q_REVISION macro in the earlier Qt releases. Qt Quick 2 is supported with only Qt 5.
28
28
29 \raw HTML
29 \raw HTML
30 <table cellpadding="2" cellspacing="1" border="0" width="95%" class="indextable">
30 <table cellpadding="2" cellspacing="1" border="0" width="95%" class="indextable">
@@ -39,8 +39,6 QTCOMMERCIALCHART_BEGIN_NAMESPACE
39 any line connecting the two points becomes meaningless, so choose the axis ranges accordingly
39 any line connecting the two points becomes meaningless, so choose the axis ranges accordingly
40 when displaying line, spline, or area series.
40 when displaying line, spline, or area series.
41
41
42 \note Polar charts do not support multiple axes of same orientation.
43
44 The following QML shows how to create a polar chart with two series:
42 The following QML shows how to create a polar chart with two series:
45 \snippet ../demos/qmlpolarchart/qml/qmlpolarchart/View1.qml 1
43 \snippet ../demos/qmlpolarchart/qml/qmlpolarchart/View1.qml 1
46
44
@@ -54,7 +54,7 QString QChartsPlugin::includeFile() const
54
54
55 QString QChartsPlugin::group() const
55 QString QChartsPlugin::group() const
56 {
56 {
57 return tr("QCharts Widgets");
57 return tr("Qt Charts Widgets");
58 }
58 }
59
59
60 QIcon QChartsPlugin::icon() const
60 QIcon QChartsPlugin::icon() const
@@ -64,7 +64,7 QIcon QChartsPlugin::icon() const
64
64
65 QString QChartsPlugin::toolTip() const
65 QString QChartsPlugin::toolTip() const
66 {
66 {
67 return tr("An qcharts view widget");
67 return tr("An Qt Charts view widget");
68 }
68 }
69
69
70 QString QChartsPlugin::whatsThis() const
70 QString QChartsPlugin::whatsThis() const
1 NO CONTENT: file was removed, binary diff hidden
NO CONTENT: file was removed, binary diff hidden
General Comments 0
You need to be logged in to leave comments. Login now