summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Add a thumbnail for an example that has no UILeena Miettinen2016-07-201-0/+1
| | | | | | | | Without this change, Qt Creator tags this example as "broken" and hides it from the Examples tab in the Welcome mode. Change-Id: If1982495ec68f5cebb931f5e9498258af21f5aa7 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Fix URL to ANGLEFriedemann Kleint2016-06-301-1/+1
| | | | | | | | | Point to the README.md of the project; the old URL http://code.google.com/p/angleproject is now redirected to the bugtracker. Change-Id: I293fc150d5b6c08f16effe8921010050faa264b5 Reviewed-by: Maurice Kalinowski <maurice.kalinowski@qt.io>
* Doc: Remove obsolete QtWebKit entries from the example metadataTopi Reinio2016-06-241-27/+3
| | | | | Change-Id: I60caf454ae7e5f6e0c0bd2c2eb1934bc0f7e3fba Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Simple offline CSS: Remove font-size declarationsTopi Reinio2016-04-051-15/+1
| | | | | | | | | | | | | | | | | | | | Remove the font-size declarations from the CSS, rely on the default sizes for each element. This solves two issues: - The user-configured font size (both in Assistant and Qt Creator Help) is correctly taken into use. Previously, adjusting the font size resulted in resizing fonts only for some of the text elements. - QTextBrowser backend seems to assume a DPI of 96 for all platforms, and font-sizes in 'pt' units are scaled accordingly. However, on OS X this resulted in font sizes too small to read. Change-Id: Iaab3ad07e387912ad7391df982d4bfe7047f0b20 Task-number: QTBUG-51709 Task-number: QTBUG-51885 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@theqtcompany.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Merge remote-tracking branch 'origin/5.6.0' into 5.6Frederik Gladhorn2016-03-171-9/+9
|\ | | | | | | Change-Id: Iac8ff05cd76cbacf859138a73e8e2ed0a979c75a
| * Doc: Simple CSS style: Convert font-sizes from px to ptTopi Reinio2016-02-231-9/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Unlike other rendering backends, QTextBrowser treats px unit in stylesheets as physical pixels when printing, resulting in too small to read font sizes. Work around this by converting font-size px units to pt. Change-Id: I70c71d8bda0996f793bf1c4558775384fe6ec297 Task-number: QTBUG-51083 Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@theqtcompany.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@theqtcompany.com> Reviewed-by: Robert Loehning <robert.loehning@theqtcompany.com>
* | Remove WebEngine examples metadataKai Koehne2016-03-071-3/+1
| | | | | | | | | | | | | | This is now maintained in qtwebengine module. Change-Id: Id468be297dfd0a28920fb92d4ba793ff3d3ceab2 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* | Doc: Evaluate QT_VERSION >= QT_VERSION_CHECK(6,0,0) to falseTopi Reinio2016-02-221-0/+4
|/ | | | | | | | | | | | | | 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>
* Bump copyright year to 2016Kai Koehne2016-01-294-4/+4
| | | | | | | | | | 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>
* Make documentation readable with dark color schemes.Volker Krause2016-01-281-0/+1
| | | | | | | | 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>
* Doc: Update Qt Account urlTopi Reinio2015-12-211-1/+1
| | | | | Change-Id: I123ce085032eeb323f7c60548a9651c5188bb337 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Doc: Online style: CSS fixes for image alignmentTopi Reinio2015-12-091-4/+4
| | | | | | | | | | | | - 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>
* Doc: Online template: dynamically load footer contentTopi Reinio2015-12-091-0/+1
| | | | | | | Add a line to load footer content from the global style folder. Change-Id: If57f13c2301e6145a26b3a4d04c7cb4695fe55fe Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Doc: Add the missing styles to get multi-column classes listVenugopal Shivashankar2015-12-072-0/+40
| | | | | | | | | 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>
* Doc: Update the list of highlighted examplesTopi Reinio2015-11-301-1/+6
| | | | | | | Change-Id: Id4459ca978e9f126f04224722565b97552dfa0ef Task-number: QTBUG-49458 Reviewed-by: Sami Makkonen <sami.makkonen@theqtcompany.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Doc: Add ordered list-specific stylesVenugopal Shivashankar2015-11-302-2/+27
| | | | | | | | | | 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>
* Ignore Q_SERIALBUS_EXPORT and Q_DECL_EQ_DEFAULT in qdocAlex Blasche2015-11-301-0/+2
| | | | | Change-Id: I3ec9170aba408e8c01c7940f2537a017dbeae065 Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
* Doc: add links to new topics in Qt Creator Manual 3.6Leena Miettinen2015-11-241-0/+8
| | | | | Change-Id: I4e317c8dad847c4b4be5e9a9d7c904abc2fa95c7 Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
* Doc: Online style: Decrease font size of enum tables' Value columnTopi Reinio2015-11-231-0/+3
| | | | | | | | | | | | | | | 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>
* Doc: Use a navigation separator in the simple offline templateTopi Reinio2015-10-283-4/+8
| | | | | | | | | | | | | 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>
* Doc: Improve selection of offline template typeTopi Reinio2015-10-213-13/+7
| | | | | | | | | | | | | | | 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>
* Doc: Add the Map Viewer example to the highlighted examples listVenugopal Shivashankar2015-10-201-1/+2
| | | | | | | | | 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>
* Doc: A simplified style for rendering docs with QTextBrowserTopi Reinio2015-10-193-1/+221
| | | | | | | | | | | | | | | 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>
* qdoc: Conditionally generate the navigation bar items as table cellsTopi Reinio2015-10-191-1/+18
| | | | | | | | | | | | | | | | | | | 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>
* Merge "Merge remote-tracking branch 'origin/5.5' into 5.6" into refs/staging/5.6Liang Qi2015-10-022-16/+28
|\
| * Merge remote-tracking branch 'origin/5.5' into 5.6Liang Qi2015-10-022-16/+28
| |\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
| | * Add shader files to examples documentation file listSamuel Gaist2015-09-221-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
| | * Doc: Update links to Qt Creator ManualLeena Miettinen2015-09-071-16/+28
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | Doc: Update obsolete URLs to external documentationTopi Reinio2015-10-021-4/+4
|/ / | | | | | | | | | | | | Change-Id: I199de83971701c14e903e712fcdcd29aaff95c6d Task-number: QTBUG-48420 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> Reviewed-by: Liang Qi <liang.qi@theqtcompany.com>
* | Doc: Update 'Creating a Mobile Application' external linkTopi Reinio2015-09-211-1/+1
| | | | | | | | | | Change-Id: I7fac2cd248aa367f0b34a63a011d4d007571ec13 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* | Doc: Update online documentation templateTopi Reinio2015-08-264-20/+108
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Merge remote-tracking branch 'origin/5.5' into devFrederik Gladhorn2015-08-061-1/+2
|\ \ | |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
| * Doc: Add Q_MV_IOS to ignored C++ directivesNico Vertriest2015-07-221-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Add recent file handling to SDI/MDI and remove the recentfiles example.Friedemann Kleint2015-07-311-0/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | The existing recentfiles example was basically a clone of the SDI example with a "Recent" menu added. Assuming it is better to have it all in one place, the functionality is merged into the existing SDI/MDI examples. - Implement recently opened files handling using a submenu and a QSettings array in the SDI/MDI examples. - Remove recentfiles example. Change-Id: Id5a1ab9fa1c2e6b9ec81309cfe74cf86f450392a Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* | Doc: Add Q_DECLARE_SHARED_NOT_MOVABLE_UNTIL_QT6 to ignored directivesTopi Reinio2015-07-291-0/+1
| | | | | | | | | | | | | | | | | | | | 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>
* | Merge remote-tracking branch 'origin/5.5' into HEADSimon Hausmann2015-07-173-33/+33
|\ \ | |/ | | | | | | | | | | Conflicts: src/plugins/platforms/windows/qwindowsopengltester.cpp Change-Id: Ia7abeba9395ccf84e2fa81b91a5725a86dedb9fe
| * Doc: Updated online template with the latest footerVenugopal Shivashankar2015-07-161-32/+31
| | | | | | | | | | | | Change-Id: Ib3d074b21012e6a7dcc8fba7ed5ce2bfefd31681 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
| * Doc: Updated the footer in the online templateVenugopal Shivashankar2015-07-013-2/+3
| | | | | | | | | | | | | | | | 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>
* | Merge remote-tracking branch 'origin/5.5' into devLiang Qi2015-07-011-7/+5
|\ \ | |/ | | | | | | | | | | | | | | | | | | | | | | 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
| * Doc: Update the list of highlighted examplesTopi Reinio2015-06-221-4/+5
| | | | | | | | | | | | | | | | | | | | | | 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>
| * Doc: Remove generic thumbnails for a number of examplesTopi Reinio2015-06-051-3/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | qdoc: Missing names from ignored tokens listMartin Smith2015-06-301-0/+2
| | | | | | | | | | | | | | | | | | | | 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>
* | qdoc: Missing name from ignored directivesMartin Smith2015-06-301-1/+2
| | | | | | | | | | | | | | | | | | | | 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>
* | doc: Added Q_NEVER_INLINE to ignored tokensMartin Smith2015-06-051-0/+1
|/ | | | | | | | This helps qdoc's parser. Change-Id: I4c7f2dff348b87659c93ddb14d012d5bf2e626f2 Task-number: QTBUG-46498 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Added the Qt Multimedia backends wiki linkVenugopal Shivashankar2015-05-131-0/+4
| | | | | | | | | | | 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>
* Merge remote-tracking branch 'origin/5.4' into 5.5Liang Qi2015-04-155-25/+27
|\ | | | | | | Change-Id: I004854a25ebbf12b1fda88900162fe7878716c58
| * Doc: Update online documentation templateTopi Reinio2015-04-145-25/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Merge remote-tracking branch 'origin/5.4' into 5.5Liang Qi2015-03-3110-57/+84
|\ \ | |/ | | | | | | | | | | | | | | Conflicts: mkspecs/android-g++/qmake.conf qmake/generators/unix/unixmake2.cpp src/gui/image/qimage_conversions.cpp Change-Id: Ib76264b8c2d29a0228438ec02bd97d4b97545be0
| * Doc: Update links to forum.qt.ioSergio Ahumada2015-03-122-2/+2
| | | | | | | | | | Change-Id: I10c1fd388b44c45412fad544604e51fbd2807f96 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
| * Doc: Remove link to old Nokia WikiSergio Ahumada2015-03-121-5/+0
| | | | | | | | | | | | | | 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>