HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r496:c23f1472c851

fixed example paths in doc

sauimone -

r496:c23f1472c851

parent child

Context file:

r496:c23f1472c851

Collapse all files

doc/qcharts.qdocconf +4 -4

             include(compat.qdocconf)
             include(macros.qdocconf)
             include(qchart-html-template.qdocconf)
             project = QtCommercialCharts
             description = Library for creating charts
             sourcedirs = ../src \
-                         ../example \
+                         ../examples \
                          ./src
             headerdirs = ../src \
-                         ../example
+                         ../examples
             exampledirs = ../ \
                           ../src \
-                          ../example
+                          ../examples
-            excludefiles += ../example/linechart/linechart.pro
+            excludefiles += ../examples/linechart/linechart.pro
             sources.fileextensions = *.cpp *.qdoc *.mm *.qml
             headers.fileextensions = *.h *.ch *.h++ *.hh *.hpp *.hxx
             examples.fileextensions = *.cpp *.h *.js *.xq *.svg *.xml *.ui *.qhp *.qhcp *.qml
             examples.imageextensions = *.png *.jpeg *.jpg *.gif *.mng
             imagedirs = ./images
             outputdir = ./html
             Cpp.ignoretokens        = QTCOMMERCIALCHART_EXPORT \
                                       QTCOMMERCIALCHART_END_NAMESPACE \
                                       QTCOMMERCIALCHART_BEGIN_NAMESPACE
             Cpp.ignoredirectives    = Q_DECLARE_HANDLE \
                                       Q_DECLARE_INTERFACE \
                                       Q_DECLARE_METATYPE \
                                       Q_DECLARE_OPERATORS_FOR_FLAGS \
                                       Q_DECLARE_PRIVATE \
                                       Q_DECLARE_PUBLIC \
                                       Q_DECLARE_SHARED \
                                       Q_DECLARE_TR_FUNCTIONS \
                                       Q_DECLARE_TYPEINFO \
                                       Q_DISABLE_COPY \
                                       QT_FORWARD_DECLARE_CLASS \
                                       Q_DUMMY_COMPARISON_OPERATOR \
                                       Q_ENUMS \
                                       Q_FLAGS \
                                       Q_INTERFACES \
                                       __attribute__

doc/src/example-areachart.qdoc +5 -5

             /*!
                  \example example/areachart
                  \title AreaChart Example
                  \subtitle
                  The example shows how to create simple area chart.
                 \image areachart.png
                 To create area charts, we need two QLineSeries instances. They are going to define upper and lower boundary of the area.
-                \snippet ../example/areachart/main.cpp 1
+                \snippet ../examples/areachart/main.cpp 1
                 We add data to both series, we use stream operator.
-                \snippet ../example/areachart/main.cpp 2
+                \snippet ../examples/areachart/main.cpp 2
                 Now we create QAreaSeries instance using two line series objects. We set the custom gradient fill and width of the outline.
-                \snippet ../example/areachart/main.cpp 3
+                \snippet ../examples/areachart/main.cpp 3
                 In the end we create QChartView instance, set title, set anti-aliasing and add area series. We also set the specific range for axes.
-                \snippet ../example/areachart/main.cpp 4
+                \snippet ../examples/areachart/main.cpp 4
                 Chart is ready to be shown.
-                \snippet ../example/areachart/main.cpp 5
+                \snippet ../examples/areachart/main.cpp 5
             */

doc/src/example-linechart.qdoc +4 -4

             /*!
                  \example example/linechart
                  \title LineChart Example
                  \subtitle
                  The example shows how to create simple line chart.
                 \image linechart.png
                 To create line charts, QLineSeries instance is needed. Here we create two line series and we set the color and width of line.
-                \snippet ../example/linechart/main.cpp 1
+                \snippet ../examples/linechart/main.cpp 1
                 We add data to be shown to both series. We can use add() member function or use stream operator.
-                \snippet ../example/linechart/main.cpp 2
+                \snippet ../examples/linechart/main.cpp 2
                 In the end we create QChartView instance, set title, set anti-aliasing and add both series.
-                \snippet ../example/linechart/main.cpp 3
+                \snippet ../examples/linechart/main.cpp 3
                 Chart is ready to be shown.
-                \snippet ../example/linechart/main.cpp 4
+                \snippet ../examples/linechart/main.cpp 4
             */

doc/src/example-presenterchart.qdoc +5 -5

             /*!
                  \example example/presenterchart
                  \title PresenterChart Example
                  \subtitle
                  The example shows how to create chart which presents the same set of data as line, scatter and spline charts.
                  ChartPresenter will switch between these three chart types every few seconds.
                  Please note this example does not use common data model. A use of common data model is documented here.[TODO]
                 \image presenterchart1.png
                 \image presenterchart2.png
                 \image presenterchart3.png
                 We create simple ChartView class which derives form QChartView.
-                \snippet ../example/presenterchart/chartview.h 1
+                \snippet ../examples/presenterchart/chartview.h 1
                 Class will implement \c handleTimeout() slot which we are going to use to trigger switching between different chart presentations.
                 Class members \c m_series and \c m_titles are going to store series and related titles. In example we are going to present data as a line chart
                 using QLineSeries , as scatter chart using QScatterSeries, and as a spline chart using QSplineSeries. We create needed instances in constructor of ChartView class.
                 We set custom line and points colors.
-                \snippet ../example/presenterchart/chartview.cpp 1
+                \snippet ../examples/presenterchart/chartview.cpp 1
                 We add data to all three series. We can use add() member function. If data set is large,it is wiser to use shared data model, as described here.[TODO]
-                \snippet ../example/presenterchart/chartview.cpp 2
+                \snippet ../examples/presenterchart/chartview.cpp 2
                 In the end we store references all the created series and matching titles.
-                \snippet ../example/presenterchart/chartview.cpp 3
+                \snippet ../examples/presenterchart/chartview.cpp 3
                 In  \c handleTimeout() slot  we change currently displayed chart by removing previous series and adding next series from the \c m_series list. We also set proper title.
-                \snippet ../example/presenterchart/chartview.cpp 4
+                \snippet ../examples/presenterchart/chartview.cpp 4
             */

doc/src/example-scatterchart.qdoc +4 -4

             /*!
                  \example example/scatterchart
                  \title ScatterChart Example
                  \subtitle
                  The example shows how to create simple scatter chart.
                 \image scatterchart.png
                 To create scatter charts, QScatterSeries instance is needed. Here we create scatter series instance and we set the type, color and width of outline for scatter points.
-                \snippet ../example/scatterchart/main.cpp 1
+                \snippet ../examples/scatterchart/main.cpp 1
                 We add data to be shown. We can use add() member function or use stream operator.
-                \snippet ../example/scatterchart/main.cpp 2
+                \snippet ../examples/scatterchart/main.cpp 2
                 In the end we create QChartView instance, set title, set anti-aliasing and add scatter series.
-                \snippet ../example/scatterchart/main.cpp 3
+                \snippet ../examples/scatterchart/main.cpp 3
                 Chart is ready to be shown.
-                \snippet ../example/scatterchart/main.cpp 4
+                \snippet ../examples/scatterchart/main.cpp 4
             */

doc/src/example-splinechart.qdoc +8 -8

             /*!
                  \example example/splinechart
                  \title SplineChart Example
                  \subtitle
                  The example shows how to create simple spline chart.
             \image splinechart_example
                 To create spline chart we need to put our data into QSplineSeries. QSplineSeries automatically calculates spline segment control points that are needed to properly draw the spline.
-                \snippet ../example/splinechart/splinewidget.cpp 1
+                \snippet ../examples/splinechart/splinewidget.cpp 1
                 Customize the look of the spline, by setting its pen's color and pen's width
-                \snippet ../example/splinechart/splinewidget.cpp 2
+                \snippet ../examples/splinechart/splinewidget.cpp 2
             Now lets add some data points to the series.
-            	\snippet ../example/splinechart/splinewidget.cpp add points to series
+            	\snippet ../examples/splinechart/splinewidget.cpp add points to series
             The data series has been populated. To display it on a chart we create QChartView object and add the data series to it. We also set the ranges on both axises, so that our chart is fully visible and there is some excess of space for adding more data points.
-                \snippet ../example/splinechart/splinewidget.cpp 3
+                \snippet ../examples/splinechart/splinewidget.cpp 3
                 Then we add two buttons for adding and removing data points. Buttons clicked() signals are connected to handler functions.
-                \snippet ../example/splinechart/splinewidget.cpp 4
+                \snippet ../examples/splinechart/splinewidget.cpp 4
                 In the end we add the chart and the buttons to the widget's layout.
-                \snippet ../example/splinechart/splinewidget.cpp 5
+                \snippet ../examples/splinechart/splinewidget.cpp 5
             Here is the handler function for add new data point button:
-            \snippet ../example/splinechart/splinewidget.cpp add point
+            \snippet ../examples/splinechart/splinewidget.cpp add point
             And here is one for remove the last data point in the series:
-            \snippet ../example/splinechart/splinewidget.cpp remove point
+            \snippet ../examples/splinechart/splinewidget.cpp remove point
             */

doc/src/tutorials.qdoc +5 -5

             /*!
                 \page tutorials.html
                 \title Tutorials
                 \keyword Tutorials
                 For example, to create a chart with line series using a widget based application:
-                \snippet ../example/chartview/main.cpp 1
+                \snippet ../examples/chartview/main.cpp 1
                 \image chartview_example.jpg
                 To replace the line series with a pie series you use the dedicated QPieSeries class:
-                \snippet ../example/chartview/main.cpp 3
+                \snippet ../examples/chartview/main.cpp 3
                 \image chartview_example_pie.jpg
             	To use a scatter series you use QScatterSeries class:
-                \snippet ../example/chartview/main.cpp 4
+                \snippet ../examples/chartview/main.cpp 4
                 \image chartview_example_scatter.jpg
             	And to show a bar series you use one of the bar series classes, for example QBarChartSeries:
-                \snippet ../example/chartview/main.cpp 5
+                \snippet ../examples/chartview/main.cpp 5
                 \image chartview_example_bar.jpg
                 If you need to give a more professional touch to your chart you can switch from the default
             	theme to one of the other themes:
-                \snippet ../example/chartview/main.cpp 2
+                \snippet ../examples/chartview/main.cpp 2
                 \image chartview_example_theme.jpg
             */

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