Commit Graph

93 Commits

Author SHA1 Message Date
Geir Vattekar
8647bac9cf Doc: Added some Qt Quick examples to manifest-meta.qdocconf
Change-Id: Ie199b48faf885d9a50b7dfd8a73cc99e69998102
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2013-11-08 16:45:26 +01:00
Leena Miettinen
542e266f88 Doc: update Qt Creator external pages
Removed links to obsolete pages (some pages were combined and
some were removed), added links to new pages, and changed a title.

Change-Id: Iaf0e3adf2edaf048a8bb7e26b3cfd45c4680de2d
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-11-06 14:21:56 +01:00
Jerome Pasion
616b431a21 Doc: Fixed footer style and information for offline builds.
-footer is left aligned and smaller text.
-footer contains fewer <div> which were not used.
-CSS rules for footer changed to accommodate new specifications.
-information not relevant in offline builds taken out.

Task-number: QTBUG-33802
Change-Id: Icc57bad9ead8ce812d5df8e72a7bac8c22831b5f
Reviewed-by: Sami Makkonen <sami.makkonen@digia.com>
Reviewed-by: hjk <hjk121@nokiamail.com>
2013-11-01 12:56:46 +01:00
Geir Vattekar
862a8d46c3 Doc: Added a new Qt Creator \externalpage
Change-Id: I9408e4e2c78b6e734b1478d570a5fc3d382fe124
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2013-10-28 09:41:40 +01:00
Geir Vattekar
febeb2d9cd Doc: Added iOS examples to manifest-meta.qdocconf
Task-number: QTBUG-33593
Change-Id: I7aaa1230d7ed6294ddd5a3db6466894522136393
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-10-24 14:36:22 +02:00
Topi Reinio
d6b2608be1 Doc: Remove Plug & Paint plugins from the list of examples
These example projects are plugins that cannot be run
stand-alone. Remove them from the list of examples
in Qt Creator's Welcome mode.

Task-number: QTBUG-33889
Change-Id: I65b5b91a6c5b73616c10c91b7ab3f5bddbe6e6fe
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>
2013-10-09 11:01:35 +02:00
Jerome Pasion
934fbfc6cf Doc: Added external page link to "The LLDB Debugger".
-needed by an overview in qtdoc

Change-Id: I25a9b1a68de60d2ba155dbba667f4ef8054e728f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2013-10-08 16:02:58 +02:00
J-P Nurmi
5f4c75a50e qdoc: ignore Q_WINEXTRAS_EXPORT
This is required for functions in the QtWin namespace.

Change-Id: I6c38c8ef262377050a75861435da381863340f33
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-10-03 16:12:57 +02:00
Topi Reinio
25f7cddcab Doc: Fix module names of multimedia examples in manifest-meta
These examples are not in Qt Multimedia, but in
Qt Multimedia Widgets module.

Change-Id: I44fe0f10aa3229068646ff226551398a0cb3e27e
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-09-25 14:18:48 +02:00
Sergio Ahumada
a5d34b34fb Merge branch 'stable' into dev
Change-Id: I37d85631ab1165ab91457d8880c4da907a9df73b
2013-09-21 17:33:15 +02:00
Topi Reinio
5ee6c24901 Doc: Define a generic thumbnail for a number of examples
Add examples that do not have any images in their documentation
into manifest-meta qdocconf file, and define a generic image to
use as a thumbnail in Qt Creator Welcome mode.

Task-number: QTBUG-31314
Change-Id: I1625bf15cbaa53e940a07b1828dc77ca5ba45ccc
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-09-17 12:58:34 +02:00
Giuseppe D'Angelo
1b5ab11d28 Make qdoc ignore the Q_DECL_DEPRECATED token
Task-number: QTBUG-27829
Change-Id: Ic3d25cd7da2a2c1266dfa113b7138f4086215777
Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-09-16 10:58:46 +02:00
Sergio Ahumada
f7837e28b5 Merge branch 'stable' into dev
Conflicts:
	src/concurrent/qtconcurrentmedian.h
	src/corelib/itemmodels/qabstractitemmodel.cpp

Change-Id: Iac46a90bbb2958cef7670031a4b59c3becd8538a
2013-09-13 18:04:17 +02:00
Topi Reinio
dc64fef6e4 Doc: Reintroduce \beginqdoc and \endqdoc macros
These macros were previously defined for QDoc manual.
This change adds them to global macros.qdocconf so
they can be used everywhere.

Change-Id: I4fdf5a103ecfb356719951a7d0c6fbd35c887744
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-09-10 11:14:28 +02:00
Topi Reinio
656fb30720 qdoc: Ignore QT_MUTEX_LOCK_NOEXCEPT macros
QT_MUTEX_LOCK_NOEXCEPT is defined as Q_DECL_NOTHROW
on Linux, the latter being already ignored by qdoc.
This change ignores also the former, clearing
related documentation warnings.

Change-Id: Iaeee7a851b4b6d3c2e3308c1b376406c11271807
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-09-09 10:40:37 +02:00
Alex Blasche
e040a27331 Add qdoc ignore tag for new QtPositioning API.
Change-Id: If725ac4e523d56a8dc274f8d6b53c0c34064ca06
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-09-02 16:26:21 +02:00
Topi Reinio
0023774411 qdoc: Enable support for rvalue references in function signatures
qdoc interprets the double-ampersand in function parameters
using rvalue references (e.g. 'Type &&other') incorrectly
as a logical AND operator, resulting in a syntax error.

This change works around the issue by treating '&' the same
as '*', and defining Q_COMPILER_RVALUE_REFS for qdoc.

Task-number: QTBUG-32675
Change-Id: I499611f16f22c33ff5b878da0cd59d67ddf53d72
Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-30 09:22:16 +02:00
Jerome Pasion
ea94afca56 Doc: Changed CSS text-align from "justify" to "left".
-Documentation looks weird when viewed in a narrow window because
 much of the text are long.
-Qt Project's CSS uses "left".
-This change affects any documentation which uses the global
 templates.

Change-Id: I8605a191904cb727b4818d8a1abf127ce2e45eb9
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
Reviewed-by: Jens Bache-Wiig <jens.bache-wiig@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-08-28 12:15:43 +02:00
Martin Smith
e4df7fc75a qdoc: Fix the qdoc \include command
qdoc's \include command now works as expected.
This command is only for including a file that
contains qdoc comments that contain qdoc commands
to be processed by qdoc. The file to be included
should have the .qdocinc suffix, although qdoc
will accept any suffix now. The file must be in
one of the directories specified by the sourcedirs
variable in the qdocconf file.

Task-number: QTBUG-33046
Change-Id: I45ea08932b4218aae369469968117fb5132f764b
Reviewed-by: Alex Blasche <alexander.blasche@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-08-22 16:11:29 +02:00
Frederik Gladhorn
c8ca300e49 Merge remote-tracking branch 'origin/stable' into dev
Conflicts:
	qmake/doc/src/qmake-manual.qdoc
	src/plugins/platforms/xcb/qxcbconnection_xi2.cpp
	src/src.pro

Change-Id: I0a560826c420e46988da3776bd8f9160c365459a
2013-08-21 11:03:18 +02:00
Venu
7510aad98e Doc: Updated the tagged examples list for Android
Removed the Boxes example from the list as it requires
OpenGL.

Task-number: QTBUG-32953
Change-Id: Ieb186afde0a87b12d7ab48037b31ae5895740d60
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
2013-08-14 17:14:56 +02:00
Jerome Pasion
0f79f802be Doc: Adding link to Qt for BlackBerry wiki as external page
Change-Id: I6a93c7b55a90c8616ec67a5cc9b510cc876ed7e2
Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-08-14 11:48:36 +02:00
Frederik Gladhorn
5c23199d4e Merge remote-tracking branch 'origin/stable' into dev
Conflicts:
	configure
	mkspecs/macx-xcode/Info.plist.app
	mkspecs/macx-xcode/Info.plist.lib
	qmake/doc/qmake.qdocconf
	src/corelib/global/qglobal.h
	tests/auto/other/exceptionsafety/exceptionsafety.pro
	tests/auto/widgets/widgets/qcombobox/tst_qcombobox.cpp

Change-Id: I3c769a4a82dc2e99a12c69123fbf17613fd2ac2a
2013-08-14 09:06:31 +02:00
David Faure
794330e40f Doc: ignore "Q_NORETURN" in function signatures.
Needed by the upcoming function
    Q_NORETURN void QCommandLineParser::showHelp(int exitCode)

Change-Id: Ie8550d2d0eff9eb20e629eef4952fa2b0b10f873
Reviewed-by: Laszlo Papp <lpapp@kde.org>
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>
2013-08-13 01:38:54 +02:00
Topi Reinio
ee8b7466bc Doc: Re-highlight Tweet Search demo
The Qt Quick demo Tweet Search works again, add it back as
one of the highlighted examples.

Task-number: QTBUG-31745
Change-Id: I4fc7d1a836159e9bb54fcd9e1a9c2760d97aa80a
Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
2013-07-29 15:08:58 +02:00
Kevin Ottens
288e50227d Add the RFC2822Date format
QDateTime can now be converted to strings compliant to RFC 2822.
Additionally, it supports RFC 850 and RFC 1036 during parsing.
By having them all together, all type of dates found in exchanged
messages on the internet (including USENET) get supported.

Change-Id: I771066c23f409d20b31b7d802f37852ea68ca2a0
Reviewed-by: David Faure <david.faure@kdab.com>
Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>
2013-07-24 15:02:35 +02:00
Jerome Pasion
b625cddcd8 Doc: Edited CSS files in doc/global/template
-edited style convention for readability (as opposed to file size)
-removed extra CSS rule which does nothing

Change-Id: Ica9cbdf0c63bae87a8446afcbc22f74403e3247e
Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-07-23 16:30:06 +02:00
Martin Smith
93a3173444 doc: Added Q_REQUIRED_RESULT to ignored tokens
This macro is apparently knew. It was unknown to qdoc.
Now qdoc knows to ignore it.

Task-number: QTBUG-32344
Change-Id: Id4455ad2329aeb2d2f8cacef99cdd1ff2a72321c
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-07-23 16:30:06 +02:00
Sergio Ahumada
3ef6cf060e Merge branch 'stable' into dev
Conflicts:
	qmake/generators/mac/pbuilder_pbx.cpp
	src/corelib/json/qjsonwriter.cpp
	src/corelib/kernel/qeventdispatcher_blackberry.cpp
	src/plugins/platforms/cocoa/qcocoacolordialoghelper.mm

Change-Id: I24df576c4cbd18fa51b03122f71e32bb83b9028f
2013-07-11 16:42:01 +02:00
Frederik Gladhorn
cb6fec8515 Merge remote-tracking branch 'origin/release' into stable
Change-Id: I53112e20a65b7d706755b4a22622979f3b91a2c2
2013-06-28 19:18:10 +02:00
Frederik Gladhorn
572200989b Merge remote-tracking branch 'origin/stable' into dev
Conflicts:
	configure
	mkspecs/features/create_cmake.prf

Change-Id: I94aea83b83833395d5db399209e0e51b92ef23b5
2013-06-27 13:06:38 +02:00
Jerome Pasion
f63369d833 Doc: Fixed link to "Downloads" page.
-previous link does not exist

Change-Id: I86cb6311145cdcb0ebccd3e141d1e413744d585a
Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
2013-06-27 11:40:41 +02:00
Alex Blasche
0ae1148484 Properly parse the new namespace macros for Bluetooth and NFC libs
Task-number: QTBUG-31851

Change-Id: I4c0eb3cf69ae10246a22f93e76a09d3a72c2196c
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Alex <alexander.blasche@digia.com>
2013-06-26 12:50:37 +02:00
Jerome Pasion
b11cb96f28 Doc: Fixed QDoc's navigation mechanism.
The HTML pages need to display minimal navigation such
as a link to the module landing page or Qt 5's index.html.

-new variables available in qdocconf files:
    navigation.landingpage
    navigation.homepage
    navigation.cppclassespage
    navigation.qmltypespage
    buildversion

The navigation variables are for the new navigation bar.
The buildversion variable is to insert documentation build
information into the pages.

Note about compatibility with Qt Creator docs:
The HTML template files for Qt Creator is retained to keep
Qt Creator compatible with 5.0.x and 5.1.x.

Change-Id: Ibb4d7cada19644204457d822b6b77b2aa7b70f8d
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2013-06-25 14:03:24 +02:00
Jerome Pasion
7b48954df2 Doc: Applying new qt-project.org style to "online" style.
-added images
-modified template and CSS file

Change-Id: I0d50f940271d6af80ade38f50d4efa2028441dba
Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-06-25 14:03:13 +02:00
Frederik Gladhorn
533820320c Merge remote-tracking branch 'origin/release' into stable
Change-Id: I94bb158562ae6b80a87b40139d7302ea7b9b9aa8
2013-06-20 16:13:38 +02:00
Venu
021264a239 Tagged all those examples that work on an Android device
This change enables the developers to list all the tagged
examples on the Qt Creator welcome screen using the "android"
tag.

Task-number: QTBUG-30173
Change-Id: Ic09183eb441497506b2d35f0d83ecd5d73d724f5
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Christian Stromme <christian.stromme@digia.com>
2013-06-19 17:10:44 +02:00
Oswald Buddenhagen
e80841f113 make images non-executable
Change-Id: I7d6c28e7fd18125c95e56eca2d0d6d67003f9c5d
Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-06-17 15:42:00 +02:00
Topi Reinio
19ed991e56 Doc: Remove Tweet Search demo from the list of highlighted examples
Don't highlight the example until it's updated to use a new version
of the Twitter API.

Task-number: QTBUG-31745
Change-Id: If7f9ac3391c549f48cfebcdbe6bdcd12eb4a3e13
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-06-15 19:04:58 +02:00
Stephen Kelly
abaaaea041 Update Urls to CMake docs.
Change-Id: Ic6743e8adb8d386fabc20c17c47fd110a47201da
Reviewed-by: Thomas McGuire <thomas.mcguire@kdab.com>
2013-05-20 12:06:48 +02:00
Topi Reinio
2e82e474d6 Doc: Add tags for Qt WebKit examples
Use the manifest meta-content system to add suitable tags for Qt WebKit
examples.

This enables users to filter for them in Qt Creator Welcome mode by
typing 'webkit'.

Change-Id: Ie9b5f6ff9f455dd3d8f7c64e5f73e30ff021f208
Reviewed-by: Kai Koehne <kai.koehne@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-05-13 15:39:35 +02:00
Topi Reinio
7fa4af5a97 Doc: Highlight a number of examples
Add an 'isHighlighted' attribute to selected examples to bring them
to the top on Qt Creator Welcome mode/Examples tab.

Task-number: QTBUG-29354
Change-Id: I6c72c11f1f8359d889649ff5b7f91e5c4de583bd
Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-05-08 10:01:17 +02:00
Jerome Pasion
1b91379323 Doc: Copying changes to external pages from qtdoc
-the externalsites from qtdoc is being removed and the new copy is in
qtbase/doc/global.

Change-Id: I8f509acf05c0e1f399205daf4e4831cf46475746
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2013-05-07 14:28:43 +02:00
Jerome Pasion
6f87ca2908 Doc: Adding Qt Creator Manual as \externalpage
-This should allow any Qt 5 module which inherit qt-module-defaults
to link to the Qt Creator Manual.

Change-Id: If413fe299fa604d16c06fa261024c1a12be24b09
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-04-30 12:45:30 +02:00
Martin Smith
47a9f80dc1 qdoc: Added missing CPP ignore token, Q_QML_EXPORT
This token must be ignored by qdoc's hapless C++ parser.

Task-number: QTBUG-29444
Change-Id: I02a0c5926a3fa6284648a632341e38614a237a30
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-04-08 11:35:44 +02:00
Venu
f226e7e631 Doc: Added the Q_REVISION macro to the ignore list
This should avoid QDoc warnings when the macro
is used with the signals and slots.

Task-number QTBUG-30105

Change-Id: I8d1b32854c15ff07e6ece7b326be38666ae29c3f
Reviewed-by: Shawn Rutledge <shawn.rutledge@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-03-24 03:21:09 +01:00
Jerome Pasion
cbe6aafc11 Doc: Various changes to global CSS files.
-added style for JavaScript code blocks
-code blocks is scrollable when viewed in a narrow window
-improved alignment of table of contents

Change-Id: I45acdb4c7aa0ae57fe030e7e68a230c1a7d41b8f
Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
2013-02-28 17:14:54 +01:00
Frederik Gladhorn
f4900d340a Merge remote-tracking branch 'origin/stable' into dev
Conflicts:
	src/widgets/styles/qmacstyle_mac.mm

Change-Id: If8326db9e7da3cbf45dbf7475fdff9915c7723b1
2013-02-18 16:14:52 +01:00
Topi Reinio
284958c222 Doc: Support for meta-content in manifest XML files
This change makes qdoc support additional attributes and tags written
to example/demo manifest files. The goal is to enable highlighting of
selected items, as well as having additional content to make searching
for specific categories work better in Qt Creator welcome screen.

This meta-content is stored in manifest-meta.qdocconf, which is loaded
globally for all modules.

Tag handling is also changed to use a QSet to eliminate possible
duplicate tags.

Task-number: QTBUG-29354
Change-Id: I2c4b2dff6229172efbecc2bfc1c269017edc4d56
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-02-15 17:48:36 +01:00
Jerome Pasion
57953e0fea Doc: Added margin to the QML API description.
-added a margin to "qmldoc" div class.

Change-Id: I7297aff4de5d41a7e4de14a09c0a70acb8006bb9
Reviewed-by: Jens Bache-Wiig <jens.bache-wiig@digia.com>
2013-02-15 17:48:36 +01:00