HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r2880:023f3b1edeaa

Doc: Remove the additional "Getting Started" page...

Venugopal Shivashankar -

r2880:023f3b1edeaa

parent child

Context file:

r2880:023f3b1edeaa

Collapse all files

src/charts/doc/src/index.qdoc +5 -5

                  \snippet doc_src_qtcharts.cpp 0
-                 \note If you are only using a few classes from this module, we recommend including only those
-                 specific classes instead of the whole module.
+                 \note Since Qt Creator 3.0, projects created with Qt Quick Application
+                 wizard based on the Qt Quick 2 template uses QGuiApplication by default.
+                 All such QGuiApplication instances in the project must be replaced with
+                 QApplication as the module depends on Qt's \l{Graphics View Framework}
+                 for rendering.
                  To link against the Qt Charts module, add this line to your \c qmake project file:
                  \snippet doc_src_qtcharts.pro 0
-                 See the \l{Qt Charts Getting Started}{Getting started} page for further information on
-                 how to use Qt Charts in your application.
                  \section1 References
                  \list
                      \li \l{Qt Charts C++ Classes}

src/charts/doc/src/qtcharts.qdoc 0 -121

		@@ -86,124 +86,3
86	86
87	87	\annotatedlist qtcharts_examples
88	88	*/
89
90		/*!
91		\group qtcharts_getting_started
92		\title Qt Charts Getting Started
93
94		\section1 Installing the Qt Charts module
95
96		Use the \c {Package Manager} in \c {Maintenance Tool} or the \c {Online installer} to install
97		the Qt Charts module. The module can be found under \c {Qt Enterprise Add-Ons} in the
98		package manager.
99
100		After installation Qt Charts documentation and examples are available in Qt Creator.
101		Examples can be found on the examples page of Qt Creator by selecting the Qt Charts
102		component from the drop-down menu.
103
104		The source code is installed into the QtCharts folder under EnterpriseAddOns.
105
106		\section1 Building Qt Charts
107
108		To build the Qt Charts module from source code yourself, set up a command prompt with
109		an environment for building Qt applications, navigate to the directory containing
110		\c {qtcharts.pro}, and configure the project with qmake:
111		\code
112		qmake
113		\endcode
114
115		qmake should be run from the folder where Qt has been installed. For example,
116		if Qt is built with -prefix /opt/MyXCompiledQt, then qmake should be run
117		from /opt/MyXCompiledQt/bin/qmake.
118
119		After running qmake, build the project with make:
120		\table
121		\header
122		\li OS \li Make command
123		\row
124		\li Linux \li make
125		\row
126		\li Windows (MinGw) \li mingw32-make
127		\row
128		\li Windows (MSVC) \li nmake
129		\row
130		\li OSX \li make
131		\endtable
132
133		The above generates the default makefiles for your configuration, which is typically
134		the release build if you are using precompiled binary Qt distribution. To build both debug
135		and release, or one specifically, use one of the following qmake lines instead.
136
137		For debug builds:
138		\code
139		qmake CONFIG+=debug
140		make
141		\endcode
142		or
143		\code
144		qmake CONFIG+=debug_and_release
145		make debug
146		\endcode
147
148		For release builds:
149		\code
150		qmake CONFIG+=release
151		make
152		\endcode
153		or
154		\code
155		qmake CONFIG+=debug_and_release
156		make release
157		\endcode
158
159		For both builds (Windows/OS X only):
160		\code
161		qmake CONFIG+="debug_and_release build_all"
162		make
163		\endcode
164
165		After building, install the module to your Qt directory:
166		\code
167		make install
168		\endcode
169
170		If you want to uninstall the module:
171		\code
172		make uninstall
173		\endcode
174
175		To build a statically linked version of the Qt Charts module, give the following commands:
176
177		\snippet doc_src_qtcharts.cpp 1
178
179		\section1 Running examples
180
181		Qt Charts examples are found under the \c examples subdirectory. To build and run a single
182		example, in this case qmlpolarchart, navigate to the example directory and enter the following
183		commands:
184
185		\snippet doc_src_qtcharts.cpp 2
186
187		\note On some platforms, such as Windows, the executable can be generated under debug or
188		release folders, depending on your build.
189
190		\section1 Creating a simple application
191
192		To create a simple application, start by creating a new Qt Gui Application project in Qt
193		Creator and add this line to the \c .pro file of the project:
194
195		\snippet doc_src_qtcharts.pro 0
196
197		In the \c main.cpp file, include the module headers and declare namespace usage:
198
199		\snippet doc_src_qtcharts.cpp 0
200
201		\note Since Qt Creator 3.0 the project created with Qt Quick Application wizard based on
202		Qt Quick 2 template uses QGuiApplication by default. As Qt Charts utilizes Qt Graphics View
203		Framework for drawing, QApplication must be used. The project created with the wizard is
204		usable with Qt Charts after the QGuiApplication is replaced with QApplication.
205
206		For further code examples, see one of the Qt Charts examples:
207
208		\annotatedlist qtcharts_examples
209		*/

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