Commit Graph

263 Commits

Author SHA1 Message Date
Jerome Pasion
a08b5201c1 Doc: Adding Enginio's export macro to the list of excluded QDoc tokens.
-helps the QDoc parser read C++ API when the macro is excluded.

Task-number: QTBUG-33360
Change-Id: Ic7e86c0d1cec4a1960d20b1c92c4b60396eb3ea6
Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2014-04-16 07:28:39 +02:00
Topi Reinio
4f31b01e36 Doc: Fix template code for unordered lists
The CSS for unordered lists placed a nested list
vertically too close to its parent list item.
This commit fixes the issue.

Task-number: QTBUG-38217
Change-Id: Ia5003f2aab197f455ed5bbea2e1ee2e6475aaffe
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-04-09 20:53:06 +02:00
Jerome Pasion
e14ef58f3d Doc: Add a section all modules can use for example documentation.
-modules that use the qt-module-defaults.qdocconf have access to the
 .qdocinc file.

-content about running examples can be used by example documentation.

Task-number: QTBUG-33597
Change-Id: I88d93a9982c05a24b4f7ac1b2cfb3293e56031b2
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2014-04-09 10:37:29 +02:00
Leena Miettinen
cb8e33fc0f Doc: fix link to changed topic title in Qt Creator Manual
The "Creating an Android Application" tutorial was
adapted to also apply to iOS and renamed as
"Creating a Mobile Application". The page name (HTML)
was changed as well.

Change-Id: I445a258e21242b3c19b8fd83b35d24514ffc94cc
Reviewed-by: Sergio Ahumada <sahumada@blackberry.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-04-04 10:02:59 +02:00
Kai Koehne
e7270b68fe Doc: Update year to 2014
Change-Id: Iae2f31232fb364b26aa4da99048d92c262b4fdec
Reviewed-by: Sergio Ahumada <sahumada@blackberry.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-03-27 15:22:33 +01:00
Topi Reinio
ddf2e2367c Doc: Move IPC example documentation
Examples under examples/ipc were not part of any module
documentation. This change adds the above folder to
Qt Core documentation, and moves the corresponding
files so that the example documentation is built
correctly.

Change-Id: If1f34ce7ef04a02df8a87f820bb2e68ffa723dd4
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-03-27 15:16:20 +01:00
Marc Mutz
163a8d5a76 Doc: ignore Q_DECL_NOEXCEPT_EXPR and QT_DEPRECATED_X
This fixes most of the \fn-not-found errors in QtCore.

Change-Id: I61a48646c6341cb3310bbb83f190a15e9225fd14
Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com>
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
2014-03-17 20:52:49 +01:00
Leena Miettinen
a9d4aea494 Doc: Add links to new Qt Creator Manual topics
Beautifier and Windows Runtime plugins were added for 3.1.

Change-Id: I6ad16aa004e4ea2c468d2dc07e3d6142e63ff396
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2014-03-13 13:26:58 +01:00
Nico Vertriest
267eab3f39 Doc: correction link, example and parameter issues qtbase
Moved codecs folder to qtbase/examples
Corrected quote in dropsite.qdoc
Replaced snippet statement by include statement
Added doc for undocumented parameters

Task-number: QTBUG-34749

Change-Id: If4de95b8d39e5680fd0f63f8d2b6685a4b0a8052
Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com>
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
2014-03-10 16:02:19 +01:00
Jerome Pasion
93d35c07d0 Doc: Updated CSS used by the offline documentation.
-new layout for landing page
-updates to title sizes and changes to footer
-fixes to general paragraph issues

-index.qdoc changed in qtdoc repository

Task-number: QTBUG-36411
Change-Id: Icb4fb0374e474137686f4cb67c64dc0249fef2c4
Reviewed-by: Martin Smith <martin.smith@digia.com>
2014-02-20 11:06:40 +01:00
Jerome Pasion
4179302d65 Doc: Adding a new page to Qt Creator's external page file.
-new page called "Creating an Android Applicaion"

Change-Id: Ibe17f7c96aee3fe6c549a27d3b0f2b93cc0a5453
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2014-02-14 12:24:35 +01:00
Frederik Gladhorn
c30fc6949a Merge remote-tracking branch 'origin/release' into stable
Change-Id: I4680723bef393a15d5aa63b9dd7d5fbb599bd9fa
2014-01-27 18:58:04 +01:00
Jerome Pasion
68fb37d762 Doc: Remove unused defines from global template.
-Qt NFC and Qt Bluetooth no longer need them

Change-Id: Ie198cfc3d5171c04cdd2c36b83ec5f1718e16972
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Alex Blasche <alexander.blasche@digia.com>
2014-01-27 11:56:33 +01:00
Nico Vertriest
4fab72a5eb Doc: corrected broken links
Links fixed:  Extra Filters
              Basic Tools
              blockingfortuneclient
              Thread Support
              Drag and drop examples
              qBinaryFind
              qmake common project types
              imagegestures
Task-number: QTBUG-34749
Change-Id: Ib93dda00716dc596db327fee5b97e110a9f27fa7
Reviewed-by: Martin Smith <martin.smith@digia.com>
2014-01-23 17:00:30 +01:00
Venu
e976d67205 Updated the list of examples tagged for Android
Tested the examples that are tagged for
user experience and relevance for mobile devices, and
updated the list accordingly.

Task-number: QTBUG-34805
Change-Id: I1ccd23fa626deb42c0fea4e03a2bf7a8dd2a856c
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
2014-01-23 13:01:47 +01:00
Thiago Macieira
48caaee170 Ask qdoc not to parse Q_DECL_UNUSED
We have it on function declarations and it gets a bit lost...

Change-Id: I19ba2e760f3714c26e78c3d8fd2570af3dcd136e
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>
2014-01-14 18:52:14 +01:00
Nico Vertriest
04133551a5 Doc: Move XML example documentation to correct location
Moving the examples documentation to resolve doc linking
issues.

Task-number: QTBUG-34749
Change-Id: I2adb1b5d37911c7df6a78a03741d3d43ab24eafb
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2013-12-20 10:37:43 +01:00
Nico Vertriest
d9bad12fc8 Doc: solved link problem for dombookmarks.qdoc
Task-number: QTBUG-34749
Change-Id: I2f2fbf16314e069ab04e5c5ab4bcef9780c008a2
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2013-12-16 19:29:52 +01:00
Nico Vertriest
eaff48d362 Doc: Moved Books SQL Example documentation
Moved qdoc and image file to correct qdoc folder.
Added brief and ingroup statements to books.qdoc.

Task-number: QTBUG-34749

Change-Id: I5806ffd6f116cccf10238e3e1a9fc627ad0e93a9
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2013-12-05 14:56:29 +01:00
Christian Strømme
426fd70ec1 Update the list of examples that work on Android.
Some of the examples that where tagged with "android" are no longer
supported (e.g., video widget), others just don't work.
This patch replaces those that have equivalent examples that are known
to work, plus some new ones that where missing (Camera, AndroidExtras
and AudioOutput).

Change-Id: I9173ab31d0ef0b55613fd5342e7d2e6d95d4d980
Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
2013-11-21 11:02:37 +01:00
Marc Mutz
38e90ad2b3 qcompilerdetection.h: add Q_COMPILER_UNIFORM_INIT
Up to now, the feature classe Uniform Initialization was subsumed by the
Q_COMPILER_INITIALIZER_LISTS flag together with support for
std::initializer_list.

This caused at least two problems:
1. On QNX, the standard libray does not ship <initializer_list>, even
   though the compiler (a GCC 4.6, IIRC) supports it. But since there
   was only one Q_COMPILER flag for both, support for the compiler-only
   part of the feature had to be disabled, too.
2. MSVC 2013 supports initializer lists, but has a bug that renders full
   uniform initialization support, as required for QUuid, useless.

By splitting the feature into two, we can separate them better, and do
so in QUuid, which is the only class that currently takes advantage of
uniform initialization (to provide constexpr constructors).

Since Q_COMPILER_INITIALIZER_LISTS worked as a flag for uniform
initialization so far, with the two known exceptions above,
UNIFORM_INIT is defined whenever INITIALIZER_LIST is, except that
I don't revert UNIFORM_INIT on QNX as I do for INITIALIZER_LISTS
and that I expect the MSVC 2013 features to set INITIALIZER_LIST,
but not UNIFORM_INIT.

Task-number: QTBUG-34705

Change-Id: I81916e950a0f3aab3de7977e0326d2de3d31b14c
Reviewed-by: Yuchen Deng <loaden@gmail.com>
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
2013-11-15 06:30:53 +01:00
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