summaryrefslogtreecommitdiffstats
path: root/doc/global
Commit message (Collapse)AuthorAgeFilesLines
* qdoc: Prepare QDoc for the new style on qt.ioTopi Reinio2014-11-111-2/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The new template and CSS have some requirements that need changes in the generated .html: - Generate a new div 'sidebar' and place the TOC (if one exists) inside it, allowing the template to extend the sidebar contents dynamically. Do this for all pages except index.html. - Change the DOCTYPE declaration to be html5-compliant - Replace <tt> tags with <code> to be html5-compliant - Add a new config variable HTML.prologue - this allows the template to insert custom html into beginning of the page, before the page title but after any navigation or table-of-contents items. - Wrap tables inside <div> elements. This allows for better-working CSS design for small-screen devices. - Write out extra parameters first when outputting function synopsis to have better styling. - Inject zero-width-space characters into function names to allow the browser break up long function signatures in a nice manner. - Edit the CSS for the offline style to adapt to above changes. Task-number: QTBUG-42086 Change-Id: I3075cdc11bcb07a66150388519263fd721c8002b Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: add new Qt Creator Manual topics to externalpagesLeena Miettinen2014-11-051-0/+12
| | | | | | | | | | | New in some earlier version: - Parsing C++ Files New in Qt Creator 3.3: - Qt Quick UI Forms - Using Clang Static Analyzer Change-Id: I2821b31f4c67b79e6a178018a6acba5b828edb3e Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Documentation CSS: remove body text colorShawn Rutledge2014-11-051-1/+0
| | | | | | | | Help text should use the QPalette color. Task-number: QTBUG-42399 Change-Id: Ibc8658b4a7affc2481d895c13cfa673b50a872e0 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* New Qt logoAlessandro Portale2014-11-053-0/+0
| | | | | | | | | | | | | This patch replaces the old Qt logo with the new, flatter one. The PNGs were optimized via: optipng -o7 -strip "all" Task-number: QTBUG-41685 Change-Id: I51983a45144373bf7aee31a32990ecbb2582f488 Reviewed-by: Robert Loehning <robert.loehning@digia.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com> Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com> Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Move Qt Core examples under a common subdirectoryTopi Reinio2014-10-171-1/+6
| | | | | | | | | | | | | | | | | | Qt Core examples were scattered into several subdirectories under qtbase/examples. This caused an issue with the example manifest file generated by QDoc; it expects to find all examples under a common directory in order to produde correct paths to the example .pro files. Qt Creator will not find the examples without a valid manifest file. This change moves the examples and edits the documentation files accordingly. Task-number: QTBUG-41963 Change-Id: I51d86782e0ba21c5c9bae5f15401ec774abe5cf8 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Change documentation links to point to qt.io.Friedemann Kleint2014-10-081-3/+3
| | | | | | Task-number: QTBUG-41798 Change-Id: I3a9edc5798d67da60ed1ea55540e2fcdd2e87371 Reviewed-by: Jani Heikkinen <jani.heikkinen@digia.com>
* qdoc: Add an \externalpage for Qt Account Sign-upMartin Smith2014-09-111-0/+5
| | | | | | | | | Currently it is used by the Enginio module, but it will be useful in other modules as well. Change-Id: If8b458bfedb0da0d4b8c14484710c1a2ade502dc Task-number: QTBUG-41254 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Sync qtcreator.qdoc.Christian Kandeler2014-09-111-1/+1
| | | | | | | A topic URL has changed in the Qt Creator documentation. Change-Id: I3c6b5fbcb670d7a637a309b7a77a3da815a795ca Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* qdoc: Highlight selected section / entry in the documentationTopi Reinio2014-09-052-0/+32
| | | | | | | | | | | | | | | | This commit adds id tags with the anchor reference as the value to html entities for documentation section titles and function signatures, properties etc. for both C++ and QML documentation pages. Together with new CSS rules, we can dynamically highlight the title that the user clicked on. This helps to locate the item of interest on a crowded page or when the page cannot be scrolled down enough to place the selected item on top. Change-Id: I7d1db2ed4e12779e1a9e571996ee65c3befa4e7a Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Doc: Do not include the external sites by defaultTopi Reinio2014-09-032-2/+3
| | | | | | | | | | | | | | | Move the line that adds the external page definions into its own separate include file. This prevents the files from being included in every Qt documentation module by default, needlessly duplicating the information. Currently only the QtDoc module (and modules that depend on QtDoc) need it. Task-number: QTBUG-41003 Change-Id: Ie2ddd3a645ea731787daacfffb3068cb36c79c9a Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Doc: Add CSS rules for subtitlesTopi Reinio2014-08-261-0/+4
| | | | | | | | | | | | | | | In the offline template, the floating elements in the navigation bar interfere with the layout of any elements displayed next to it. In particular, subtitles used for example files and nested class documentation have wrong horizontal position. This change adds CSS for the subtitles to be displayed as block elements, and disallows floating elements on the left side - TOC is still allowed to float on the right side. Task-number: QTBUG-40924 Change-Id: I89be3844985e6cf95263db575768034d9270d140 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: Fix output of \br commandTopi Reinio2014-08-261-2/+1
| | | | | | | | | | | | | | | | Since the \br was promoted from a macro to a QDoc command, its output has been enclosed in extra paragraph end/start tags, adding to the visible vertical space. This change fixes the issue by not closing the paragraph when QDoc encounters a \br command. Also removes the now-obsolete \br and \hr macros, as they are both proper commands. \BR and \HR substitute macros are kept. Task-number: QTBUG-37361 Change-Id: Iabbefb6e79268419792ccba42386f6342ccd175d Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Removed minor version from the doc URL.Jerome Pasion2014-08-151-1/+1
| | | | | | | | | | | -The online URL doesn't use the minor version anymore and this makes the non-Qt projects depend on the existence of redirects. Change-Id: I5b2bef16957ca307060600b7bf25eb1d55f2c998 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Add Qt 5 URL in qtbase/doc/globalJerome Pasion2014-07-041-0/+2
| | | | | | | | -individual Qt 5 modules have the same URL and it can be inherited from doc/global Change-Id: Ie53fe7509a4f906740512e290e263d34ba3f2ee6 Reviewed-by: Martin Smith <martin.smith@digia.com>
* QDoc: Introduce a variable to set table of contents depth.Jerome Pasion2014-06-111-0/+2
| | | | | | | | | | | | | | | | | | | | -"HTML.tocdepth" variable controls depth value. -setting to "0" disables table of contents. -sections 3 and 4 usually don't have descriptive titles to warrant their listing in the table of contents. -table width and CSS (online and offline) don't support wide entries. -Config class' getInt() function now returns -1 if a variable is not set. -for Qt 5 and projects which use html-config.qdocconf, tocdepth is set to "2". -added variable documentation. Task-number: QTBUG-38967 Change-Id: Ibd612f5b846ecb9c4b575e7ac11605c6efd2b77c Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2014-05-131-5/+8
|\ | | | | | | | | | | | | Conflicts: src/gui/kernel/qguiapplication.cpp Change-Id: Ibe75603dc8a51769db6550ea3f07bc8d19b0be85
| * Doc: Update the list of highlighted examplesTopi Reinio2014-05-091-5/+8
| | | | | | | | | | | | | | | | | | | | | | Remove highlighting for examples with known problems, and examples that don't work on all platforms. Add highlighting for improved ones and prominent examples that demonstrate new features. Task-number: QTBUG-37203 Change-Id: Ida7fd28573dfebe6e4e3320ef83782654632219e Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2014-05-061-0/+1
|\| | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: mkspecs/qnx-x86-qcc/qplatformdefs.h src/corelib/global/qglobal.h src/opengl/gl2paintengineex/qpaintengineex_opengl2.cpp src/opengl/qgl.cpp src/opengl/qglpixelbuffer.cpp src/opengl/qglshaderprogram.cpp tests/auto/opengl/qglthreads/tst_qglthreads.cpp Change-Id: Iaba137884d3526a139000ca26fee02bb27b5cdb5
| * Doc: Adding Enginio's export macro to the list of excluded QDoc tokens.Jerome Pasion2014-04-161-0/+1
| | | | | | | | | | | | | | | | | | | | -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>
* | Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2014-04-115-4/+11
|\| | | | | | | | | | | | | | | | | | | Conflicts: mkspecs/qnx-armv7le-qcc/qplatformdefs.h src/printsupport/kernel/qcups.cpp src/widgets/styles/qstyle.h tests/auto/widgets/itemviews/qlistwidget/tst_qlistwidget.cpp Change-Id: Ia41e13051169a6d4a8a1267548e7d47b859bb267
| * Doc: Fix template code for unordered listsTopi Reinio2014-04-092-2/+2
| | | | | | | | | | | | | | | | | | | | 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>
| * Doc: Add a section all modules can use for example documentation.Jerome Pasion2014-04-092-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | -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>
| * Doc: fix link to changed topic title in Qt Creator ManualLeena Miettinen2014-04-041-2/+2
| | | | | | | | | | | | | | | | | | | | | | 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>
* | qdoc: Links to Q_DECL_FINAL not createdMartin Smith2014-04-091-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | This update fixes part of QTBUG-37719. Q_DECL_FINAL is a macro that is documented, but links to the documentation for it were not created. The problem was that Q_DECL_FINAL is actually used in the Qt sources, but it was not listed in the Cpp.ignoretokens clause in the qdocconf file. This update just adds it to Cpp.ignoretokens. Task-number: QTBUG-37719 Change-Id: I62945df4976b21b67084e6de25e25bbc4c92f89f Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Merge remote-tracking branch 'origin/stable' into devIikka Eklund2014-04-012-2/+2
|\| | | | | | | Change-Id: I2a6eb9dd7724931bc89f28bcc156e77c4e26d069
| * Doc: Update year to 2014Kai Koehne2014-03-272-2/+2
| | | | | | | | | | | | Change-Id: Iae2f31232fb364b26aa4da99048d92c262b4fdec Reviewed-by: Sergio Ahumada <sahumada@blackberry.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2014-03-241-0/+2
|\| | | | | | | | | | | | | Conflicts: src/gui/image/qjpeghandler.cpp Change-Id: I9db3acea7d5c82f5da679c8eaeb29431136665f0
| * Doc: ignore Q_DECL_NOEXCEPT_EXPR and QT_DEPRECATED_XMarc Mutz2014-03-171-0/+2
| | | | | | | | | | | | | | | | 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>
* | Merge remote-tracking branch 'origin/stable' into devSergio Ahumada2014-03-131-0/+8
|\| | | | | | | Change-Id: Idec54e19963e8d88c711cb179cffc81596323899
| * Doc: Add links to new Qt Creator Manual topicsLeena Miettinen2014-03-131-0/+8
| | | | | | | | | | | | | | Beautifier and Windows Runtime plugins were added for 3.1. Change-Id: I6ad16aa004e4ea2c468d2dc07e3d6142e63ff396 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Introduce Q_DECL_CONST_FUNCTION and Q_DECL_PURE_FUNCTIONGiuseppe D'Angelo2014-03-031-0/+2
|/ | | | | | | | | | | That expand to __attribute__((const)) and ((pure)). A "const" function is a function allowed to examine only its arguments, without modifying them. A "pure" function is also allowed to read memory. Currently working only on GCC/ICC/Clang, MSVC lacks these. Change-Id: Ie60a0847b193fb88e116f61611dc571296a3df1c Reviewed-by: Marc Mutz <marc.mutz@kdab.com>
* Doc: Updated CSS used by the offline documentation.Jerome Pasion2014-02-201-85/+51
| | | | | | | | | | | | -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>
* Doc: Adding a new page to Qt Creator's external page file.Jerome Pasion2014-02-141-0/+8
| | | | | | | -new page called "Creating an Android Applicaion" Change-Id: Ibe17f7c96aee3fe6c549a27d3b0f2b93cc0a5453 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Merge remote-tracking branch 'origin/release' into stableFrederik Gladhorn2014-01-271-28/+7
|\ | | | | | | Change-Id: I4680723bef393a15d5aa63b9dd7d5fbb599bd9fa
| * Updated the list of examples tagged for AndroidVenu2014-01-231-28/+7
| | | | | | | | | | | | | | | | | | | | 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>
* | Doc: Remove unused defines from global template.Jerome Pasion2014-01-271-6/+0
| | | | | | | | | | | | | | | | -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>
* | Ask qdoc not to parse Q_DECL_UNUSEDThiago Macieira2014-01-141-0/+1
|/ | | | | | | | 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>
* Update the list of examples that work on Android.Christian Strømme2013-11-211-3/+8
| | | | | | | | | | | 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>
* qcompilerdetection.h: add Q_COMPILER_UNIFORM_INITMarc Mutz2013-11-151-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* Doc: Added some Qt Quick examples to manifest-meta.qdocconfGeir Vattekar2013-11-081-1/+14
| | | | | | Change-Id: Ie199b48faf885d9a50b7dfd8a73cc99e69998102 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: update Qt Creator external pagesLeena Miettinen2013-11-061-37/+9
| | | | | | | | 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>
* Doc: Fixed footer style and information for offline builds.Jerome Pasion2013-11-012-47/+33
| | | | | | | | | | | | -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>
* Doc: Added a new Qt Creator \externalpageGeir Vattekar2013-10-281-0/+6
| | | | | | Change-Id: I9408e4e2c78b6e734b1478d570a5fc3d382fe124 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Doc: Added iOS examples to manifest-meta.qdocconfGeir Vattekar2013-10-241-1/+84
| | | | | | | Task-number: QTBUG-33593 Change-Id: I7aaa1230d7ed6294ddd5a3db6466894522136393 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Remove Plug & Paint plugins from the list of examplesTopi Reinio2013-10-091-2/+0
| | | | | | | | | | | 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>
* Doc: Added external page link to "The LLDB Debugger".Jerome Pasion2013-10-081-0/+5
| | | | | | | -needed by an overview in qtdoc Change-Id: I25a9b1a68de60d2ba155dbba667f4ef8054e728f Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* qdoc: ignore Q_WINEXTRAS_EXPORTJ-P Nurmi2013-10-031-0/+1
| | | | | | | | 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>
* Doc: Fix module names of multimedia examples in manifest-metaTopi Reinio2013-09-251-3/+3
| | | | | | | | These examples are not in Qt Multimedia, but in Qt Multimedia Widgets module. Change-Id: I44fe0f10aa3229068646ff226551398a0cb3e27e Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Merge branch 'stable' into devSergio Ahumada2013-09-212-1/+27
|\ | | | | | | Change-Id: I37d85631ab1165ab91457d8880c4da907a9df73b
| * Doc: Define a generic thumbnail for a number of examplesTopi Reinio2013-09-171-1/+26
| | | | | | | | | | | | | | | | | | | | 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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-25 07:44:33 +0000