Commit Graph

205 Commits

Author SHA1 Message Date
Topi Reinio
eec3aa499a Doc: Evaluate QT_VERSION >= QT_VERSION_CHECK(6,0,0) to false
This check is used in many places in the public header files,
and correctly documenting the affected declarations depend on
QDoc evaluating it correctly.

As QDoc currently cannot evaluate complex preprocessor
directives, work around this by explicitly evaluating
the version check to false.

Change-Id: If22eff76f6831c92375d9a0b25d04aa46422da13
Task-number: QTBUG-51262
Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
2016-02-22 08:33:57 +00:00
Kai Koehne
7c797b4905 Bump copyright year to 2016
Bump copyright year in tool output and user visible strings to 2016.

Task-number: QTBUG-50578
Change-Id: I2f4aa9089c6672726f554cba7e6009b425d27683
Reviewed-by: Liang Qi <liang.qi@theqtcompany.com>
Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
2016-01-29 13:30:04 +00:00
Volker Krause
e5cd556cd1 Make documentation readable with dark color schemes.
All other colors are hard-coded in here, only the background followed the
palette.

Change-Id: If8033a72f85f953358ffeec4edd80a36b8494c7f
Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
2016-01-28 20:07:10 +00:00
Topi Reinio
f25298bd11 Doc: Update Qt Account url
Change-Id: I123ce085032eeb323f7c60548a9651c5188bb337
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2015-12-21 13:33:00 +00:00
Topi Reinio
e8c7f77854 Doc: Online style: CSS fixes for image alignment
- Remove duplicated rules
    - Add a rule for class centerAlign
    - Remove width restriction from paragraphs in table cells

These fixes enable proper horizontal center-align of images in
table cells.

Change-Id: I68a4863fe642a552260dfd6dbbb5d9675a8d2b4d
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2015-12-09 13:54:27 +00:00
Topi Reinio
b64c11f464 Doc: Online template: dynamically load footer content
Add a line to load footer content from the global style folder.

Change-Id: If57f13c2301e6145a26b3a4d04c7cb4695fe55fe
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
2015-12-09 11:47:49 +00:00
Venugopal Shivashankar
df57e3a33f Doc: Add the missing styles to get multi-column classes list
Add two- and three-column layouts for the 'All C++ Classes'
list. Also affects the layout of 'All QML Types' page.

Task-number: QTBUG-49376
Change-Id: I80953c0955dbc37db5aa4c60eb9ea8e3023a77f2
Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
2015-12-07 19:38:04 +00:00
Topi Reinio
6c0f89b927 Doc: Update the list of highlighted examples
Change-Id: Id4459ca978e9f126f04224722565b97552dfa0ef
Task-number: QTBUG-49458
Reviewed-by: Sami Makkonen <sami.makkonen@theqtcompany.com>
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2015-11-30 11:44:28 +00:00
Venugopal Shivashankar
60e2aa6532 Doc: Add ordered list-specific styles
These additional styles enable the use of lower and uppercase
alphabets to number the list items. They are useful especially
in nested ordered lists where numbering all the list items
using decimal numbers could be confusing.

Change-Id: If1bdf98ff37c2c191d66dfb66a3e8f20d8fa83e5
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2015-11-30 11:18:30 +00:00
Alex Blasche
fbc18abf5a Ignore Q_SERIALBUS_EXPORT and Q_DECL_EQ_DEFAULT in qdoc
Change-Id: I3ec9170aba408e8c01c7940f2537a017dbeae065
Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
2015-11-30 08:46:08 +00:00
Leena Miettinen
09b64aa9d3 Doc: add links to new topics in Qt Creator Manual 3.6
Change-Id: I4e317c8dad847c4b4be5e9a9d7c904abc2fa95c7
Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
2015-11-24 15:17:54 +00:00
Topi Reinio
7c22e14300 Doc: Online style: Decrease font size of enum tables' Value column
A table in enum doc may have long literal strings defined
as enum values - they take up space from the Description column,
and often force a scrollbar to appear, making the entire
table difficult to read.

Alleviate this by reducing the font size for the text in Value
column.

Change-Id: I18495a4f506851f9eff2cd94f5cdfcb03096c698
Task-number: QTWEBSITE-658
Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
2015-11-23 14:15:24 +00:00
Topi Reinio
616f690761 Doc: Use a navigation separator in the simple offline template
As we cannot style the navigation elements freely with the restricted
version of CSS that QTextBrowser supports, we need to inject
separator elements between the prev/next page links.

This change adds a 'bullet' character wrapped in a <span> as a
separator. A rule is added to the standard offline CSS to hide the
separator as it's not needed there.

Change-Id: I13220a2a60e2d3063f94bc7dff0e4320d0bed4f6
Reviewed-by: Martin Smith <martin.smith@digia.com>
2015-10-28 11:55:05 +00:00
Topi Reinio
04fe7af33f Doc: Improve selection of offline template type
Qt 5.6 now includes a version of the offline documentation template
with simplified CSS suited for rendering HTML with a QTextBrowser
backend.

Select the template in qt-html-templates-offline.qdocconf, instead
of the higher-level qt-module-defaults-offline.qdocconf. This is
better because many projects external to qt5 (including Qt Creator)
do not use qt-module-* includes. This way, we can control the
template selection for all projects from a config file.

Change-Id: I766af422d829f3c9519c5a45093473175363d600
Reviewed-by: Martin Smith <martin.smith@digia.com>
2015-10-21 08:15:35 +00:00
Venugopal Shivashankar
21b1a492ed Doc: Add the Map Viewer example to the highlighted examples list
Now that Qt Location is a fully-supported module in 5.6, it is
worth highlighting an example that demonstrates the new feature.

Change-Id: I70553f84af5587e3604115684ea1ea75203b91ce
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>
2015-10-20 08:57:17 +00:00
Topi Reinio
06d90c14b4 Doc: A simplified style for rendering docs with QTextBrowser
Add a new documentation template, with simplified CSS rules that
work better when using QTextBrowser as a backend for Qt Assistant
or Qt Creator Help.

Select this new template by default for offline documentation
builds, but keep the old offline template as part of the template
files; use JavaScript to switch to the 'standard' CSS when the
generated files are viewed with a web browser.

Task-number: QTBUG-48322
Change-Id: Ib197896200bb482935f6e9f3a38976133a1e804d
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2015-10-19 08:22:19 +00:00
Topi Reinio
afcc26619f qdoc: Conditionally generate the navigation bar items as table cells
The new offline template for Qt 5.6, including simplified CSS rules
suitable for rendering with a QTextBrowser, requires the navigation
bar to be generated as an HTML table instead of the previously-used
unordered list.

Make QDoc select between the two based on the contents of
HTML.postheader .qdocconf variable, which defines the header of
the navigation bar.

Modify the old offline CSS to look good also when the nav. bar
is a table.

Task-number: QTBUG-48322
Change-Id: I00e16c24f436e0be049b85d4bcfc916c33ea6b73
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
2015-10-19 08:22:15 +00:00
Liang Qi
925d6eff3e Merge "Merge remote-tracking branch 'origin/5.5' into 5.6" into refs/staging/5.6 2015-10-02 17:24:58 +00:00
Liang Qi
d0eaa737e1 Merge remote-tracking branch 'origin/5.5' into 5.6
Conflicts:
	qmake/doc/src/qmake-manual.qdoc
	src/corelib/tools/qstring.h
	src/gui/image/qimagereader.cpp
	src/network/access/qnetworkaccessmanager.cpp
	src/tools/qdoc/doc/examples/examples.qdoc
	src/widgets/accessible/qaccessiblewidgetfactory_p.h
	src/widgets/doc/qtwidgets.qdocconf

Change-Id: I8fae62283aebefe24e5ca4b4abd97386560c0fcb
2015-10-02 16:59:55 +02:00
Topi Reinio
fbf3daef38 Doc: Update obsolete URLs to external documentation
Change-Id: I199de83971701c14e903e712fcdcd29aaff95c6d
Task-number: QTBUG-48420
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Liang Qi <liang.qi@theqtcompany.com>
2015-10-02 10:14:47 +00:00
Samuel Gaist
843199f303 Add shader files to examples documentation file list
Currently the shader code is not accessible from the examples
documentation page. This patch fixes this by adding .glsl to the file
extensions list for examples

Change-Id: Iafe327d1bd99b78641a89863f9dbaf8112651c45
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-09-22 21:40:13 +00:00
Topi Reinio
93e64c5489 Doc: Update 'Creating a Mobile Application' external link
Change-Id: I7fac2cd248aa367f0b34a63a011d4d007571ec13
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2015-09-21 15:20:26 +00:00
Leena Miettinen
0e895c47b0 Doc: Update links to Qt Creator Manual
We're now at 3.5 level:

- Fixed changed filenames and topic titles
- Removed links to obsolete pages
- Added links to new pages

Task-number: QTBUG-47901
Change-Id: I3393555c86bf3cf58770f230e7a9c7fd7e258476
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-09-07 07:33:07 +00:00
Topi Reinio
03d621cbff Doc: Update online documentation template
Update the online documentation template with following fixes:

   - Improve responsivess for narrow screens: TOC and sidebar
     now collapse into drop-down menus
   - React to hashchange events: When the user edits the anchor
     tag in URL and presses enter, the page is scrolled
     correctly to bring the selected section title into view.
   - Handle Ctrl and Meta keys correctly
   - Improve colors for target section highlighting
   - Minor CSS fixes

Task-number: QTWEBSITE-634
Task-number: QTWEBSITE-657
Change-Id: I7221f38cf4988497f0f24ee66e62b7b7d770a121
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-08-26 09:45:55 +00:00
Frederik Gladhorn
77da617dc8 Merge remote-tracking branch 'origin/5.5' into dev
Conflicts:
	doc/global/qt-cpp-defines.qdocconf
	src/3rdparty/forkfd/forkfd.c
	src/corelib/codecs/qtextcodec.cpp
	src/corelib/kernel/qmetatype.cpp
	src/corelib/tools/qset.qdoc
	src/gui/accessible/qaccessible.cpp
	src/gui/image/qpixmapcache.cpp
	src/opengl/qgl.cpp
	src/tools/qdoc/generator.cpp
	src/widgets/kernel/qwidget.cpp
	tests/auto/widgets/widgets/qcombobox/tst_qcombobox.cpp

Change-Id: I4fbe1fa756a54c6843aa75f4ef70a1069ba7b085
2015-08-06 10:54:01 +02:00
Topi Reinio
dce90451d8 Doc: Add Q_DECLARE_SHARED_NOT_MOVABLE_UNTIL_QT6 to ignored directives
QDoc needs to ignore Q_DECLARE_SHARED_NOT_MOVABLE_UNTIL_QT6,
introduced in commit 075769ca, to avoid failures when parsing
the header files.

Change-Id: I07510248590e290e7a2460d51c8333c135647bcb
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Marc Mutz <marc.mutz@kdab.com>
2015-07-29 07:43:52 +00:00
Nico Vertriest
f9eb2534de Doc: Add Q_MV_IOS to ignored C++ directives
Enumeration QSysInfo::MacVersion uses a macro to define
enumeration values. QDoc gets confused about it and
prints a lot of warnings.

Adding the macro to ignored directives does not resolve
the documentation issue completely (enum values still
show up as '?'), but it gets rid of the warnings.

Task-number: QTBUG-43810
Change-Id: Ie4009646a78c62b5f1860d29855d3941e79d9388
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-07-22 13:47:35 +00:00
Simon Hausmann
b2603b7665 Merge remote-tracking branch 'origin/5.5' into HEAD
Conflicts:
	src/plugins/platforms/windows/qwindowsopengltester.cpp

Change-Id: Ia7abeba9395ccf84e2fa81b91a5725a86dedb9fe
2015-07-17 16:35:42 +02:00
Venugopal Shivashankar
11ed836403 Doc: Updated online template with the latest footer
Change-Id: Ib3d074b21012e6a7dcc8fba7ed5ce2bfefd31681
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-07-16 08:02:58 +00:00
Venugopal Shivashankar
fdcea3a7ca Doc: Updated the footer in the online template
Also fixed a broken facebook like image link in the footer.

Change-Id: I51e9b46d3e90763c41a125bf26ee4dccd375e744
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
2015-07-01 12:26:37 +00:00
Liang Qi
0aa2d318b1 Merge remote-tracking branch 'origin/5.5' into dev
Conflicts:
	src/corelib/global/qglobal.cpp
	src/corelib/global/qglobal.h
	src/corelib/global/qsysinfo.h
	src/corelib/global/qsystemdetection.h
	src/corelib/kernel/qobjectdefs.h
	src/plugins/plugins.pro
	tests/auto/widgets/itemviews/qlistview/qlistview.pro

Change-Id: Ib55aa79d707c4c1453fb9d697f6cf92211ed665c
2015-07-01 11:05:26 +02:00
Martin Smith
b4babd6406 qdoc: Missing names from ignored tokens list
Q_DECL_CF_RETURNS_RETAINED and Q_DECL_NS_RETURNS_AUTORELEASED are
added to qdoc's list of ignored tokens. Without them, qdoc fails
to parse a few function declarations.

Change-Id: If59066a765882d88881eed7db31b4b52a6e570ea
Task-number: QTBUG-46920
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2015-06-30 19:10:47 +00:00
Martin Smith
ce4cfd0028 qdoc: Missing name from ignored directives
Q_ATTRIBUTE_FORMAT_PRINTF is added to qdoc's list of ignored
directives. Without it, qdoc fails to parse a few function
declarations.

Change-Id: Ie24a58d9a5dcdffb8c103b2f5e34dd09b9471f06
Task-number: QTBUG-46920
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2015-06-30 19:10:37 +00:00
Topi Reinio
fb46d63e41 Doc: Update the list of highlighted examples
Remove highlighting for a number of older and less relevant examples.
Add examples from new modules, and examples that have been visually
polished.

Task-number: QTBUG-37203
Change-Id: I4e9be9a54f1ecea3bb407c049c1d44a7c00333a6
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-06-22 06:24:59 +00:00
Topi Reinio
bb7c78ed73 Doc: Remove generic thumbnails for a number of examples
These examples now define their own images. Having duplicate
definitions is bad as it results in invalid example manifest
xml, and Qt Creator fails to detect all examples declared in
that file.

Task-number: QTBUG-41996
Change-Id: Ia9d6cd0b3ec4e82b79b1df54774c2d9cea279a59
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com>
Reviewed-by: Liang Qi <liang.qi@theqtcompany.com>
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2015-06-05 20:04:34 +00:00
Martin Smith
275a970c30 doc: Added Q_NEVER_INLINE to ignored tokens
This helps qdoc's parser.

Change-Id: I4c7f2dff348b87659c93ddb14d012d5bf2e626f2
Task-number: QTBUG-46498
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-06-05 19:44:35 +00:00
Venugopal Shivashankar
a4d66348d6 Doc: Added the Qt Multimedia backends wiki link
The wiki will be linked to from the Qt Multimedia
index page.

Change-Id: I2b60c203f759494cdf12021659847817007639f1
Task-number: QTBUG-30381
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Reviewed-by: Yoann Lopes <yoann.lopes@theqtcompany.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-05-13 11:55:07 +00:00
Liang Qi
605617b5dc Merge remote-tracking branch 'origin/5.4' into 5.5
Change-Id: I004854a25ebbf12b1fda88900162fe7878716c58
2015-04-15 09:09:24 +02:00
Topi Reinio
d238f7e019 Doc: Update online documentation template
This change brings the online template up to date with recent
changes:
    - Update links in header and footer.
    - To improve page load time and reduce load on qt.io,
      do not load images from the main site.
    - Fix auto-scroll/highlight jQuery to work on anchors
      containing full stop ('.') characters
    - Responsiveness: Fix menu issues with narrow views
    - Fix styling of subscript/superscript HTML tags
    - Make script URIs protocol-agnostic

Change-Id: I219e8ce6ff2e70f9374ad5e037ceda8f710a6a10
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-04-14 08:32:46 +00:00
Liang Qi
ce9519593a Merge remote-tracking branch 'origin/5.4' into 5.5
Conflicts:
	mkspecs/android-g++/qmake.conf
	qmake/generators/unix/unixmake2.cpp
	src/gui/image/qimage_conversions.cpp

Change-Id: Ib76264b8c2d29a0228438ec02bd97d4b97545be0
2015-03-31 10:03:31 +02:00
Tobias Hunger
3f314e1607 Doc: Update URLs
Gitorious is closing down, so point to code.qt.io instead.

Change-Id: Ibc453f05e59cf227a7a7086201b008cf7b576a26
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-03-25 10:33:37 +00:00
Sergio Ahumada
642daa76e5 Doc: Update links to forum.qt.io
Change-Id: I10c1fd388b44c45412fad544604e51fbd2807f96
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-03-12 12:37:00 +00:00
Sergio Ahumada
f44db5e139 Doc: Remove link to old Nokia Wiki
The link does not work anymore and it is not referenced anywhere in Qt

Change-Id: I54dd7a40668c5a3963c8c1e95a9684385e5ac083
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-03-12 12:36:49 +00:00
Topi Reinio
2002103baa Doc: Update the online documentation template
This change fixes a number of issues in the online template:
    - Missing vertical line after the login icon in the header
    - Update header, footer links and appearance
    - Adjust alternate background color of table cells to improve
      readability
    - Fix style of cookie notification in the html header
    - Add The Qt Company logo in the footer
    - Adjust list item marker image
    - Improve responsiveness of footer

Change-Id: I77147b4b4161d6001c095a4b67e15552132100e6
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
2015-03-11 09:17:39 +00:00
Sergio Ahumada
a9bb1c63dc Adjust wiki links to the new redirect
it looks nicer this way

Change-Id: I872976bdef5f581187a758aa92b02e2f5f32b130
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com>
2015-03-04 15:36:12 +00:00
Oswald Buddenhagen
8ac63a3323 Merge remote-tracking branch 'origin/5.4' into 5.5
Change-Id: I556be99cc7ad3fc6f7177542b7444269616a7478
2015-03-04 13:44:29 +01:00
Dmitry Shachnev
30e3a2beb1 Remove unneeded exec permission from icomoon fonts
Change-Id: I47f111b4fa1278889689c28da762fabe94b95015
Reviewed-by: Lisandro Damián Nicanor Pérez Meyer <perezmeyer@gmail.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-03-02 10:39:24 +00:00
Oswald Buddenhagen
2b5982aac8 Merge remote-tracking branch 'origin/5.4' into 5.5
Change-Id: I95b3a87c5068c6b8068b30a35655b4c2419e7f9e
2015-03-02 09:23:07 +01:00
Sergio Ahumada
e78643dc0a Replace old qt-project.org wiki with wiki.qt.io
Change-Id: If6c05a5b1f60e97c64f3d6b64041a84c3af82964
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com>
2015-02-27 09:27:13 +00:00
Topi Reinio
ba5f93956b Doc: Update online documentation template
- Online CSS tweaks: Max-width, font-sizes,
      font-weights to improve readability, other
      minor fixes
    - Remove duplicate include statement and unnecessary
      definitions for online template

Change-Id: I713bddd0e175235668c4d9790d0df58b4131d19f
Reviewed-by: Martin Smith <martin.smith@digia.com>
2015-02-26 12:26:15 +00:00