From c23f1472c85148410079edf8a7f648154a34e5b5 2012-03-07 14:12:20 From: sauimone Date: 2012-03-07 14:12:20 Subject: [PATCH] fixed example paths in doc --- diff --git a/doc/qcharts.qdocconf b/doc/qcharts.qdocconf index f06faef..7d05155 100644 --- a/doc/qcharts.qdocconf +++ b/doc/qcharts.qdocconf @@ -6,15 +6,15 @@ 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 diff --git a/doc/src/example-areachart.qdoc b/doc/src/example-areachart.qdoc index dc6a31e..0a87311 100644 --- a/doc/src/example-areachart.qdoc +++ b/doc/src/example-areachart.qdoc @@ -9,22 +9,22 @@ 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 */ \ No newline at end of file diff --git a/doc/src/example-linechart.qdoc b/doc/src/example-linechart.qdoc index 3fac9dc..eb0e0ce 100644 --- a/doc/src/example-linechart.qdoc +++ b/doc/src/example-linechart.qdoc @@ -9,18 +9,18 @@ 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 */ \ No newline at end of file diff --git a/doc/src/example-presenterchart.qdoc b/doc/src/example-presenterchart.qdoc index 6684ab0..b814c91 100644 --- a/doc/src/example-presenterchart.qdoc +++ b/doc/src/example-presenterchart.qdoc @@ -13,25 +13,25 @@ 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 */ \ No newline at end of file diff --git a/doc/src/example-scatterchart.qdoc b/doc/src/example-scatterchart.qdoc index 3540f40..0d01380 100644 --- a/doc/src/example-scatterchart.qdoc +++ b/doc/src/example-scatterchart.qdoc @@ -9,18 +9,18 @@ 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 */ \ No newline at end of file diff --git a/doc/src/example-splinechart.qdoc b/doc/src/example-splinechart.qdoc index 5d75ae2..bb77d7b 100644 --- a/doc/src/example-splinechart.qdoc +++ b/doc/src/example-splinechart.qdoc @@ -9,34 +9,34 @@ 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 */ diff --git a/doc/src/tutorials.qdoc b/doc/src/tutorials.qdoc index e978993..839a3d9 100644 --- a/doc/src/tutorials.qdoc +++ b/doc/src/tutorials.qdoc @@ -4,23 +4,23 @@ \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 */