summaryrefslogtreecommitdiff
path: root/src/qdoc/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Extend description of Clang dependency for QDocPaul Wicking2018-08-301-10/+16
| | | | | | | | | * Bump Clang version to 6.0. * Include description of setting environment variable on Windows Task-number: QTBUG-65762 Change-Id: Ib0ee615f852580a75033eb8d188da0270def7b3e Reviewed-by: Martin Smith <martin.smith@qt.io>
* Doc: Update Installing clang for QDoc pagePaul Wicking2018-08-021-12/+15
| | | | | | | | | | | | | * Remove temporal phrases (e.g. 'at this time', 'at the time of writing') * Remove references to Qt Creator's libclang and questions about static/ dynamic linking in the text. * Describe LLVM and LLVM_INSTALL_DIR environment variable as procedural prerequisites for building QDoc from source. Task-number: QTBUG-69707 Change-Id: I688714b37721ed1180d500674ca4b271ed257799 Reviewed-by: Martin Smith <martin.smith@qt.io>
* Doc: Add trailing dot in QDoc examplesPaul Wicking2018-06-191-2/+2
| | | | | | Task-number: QTBUG-68933 Change-Id: I7fecb2970cbf47bbc7eca8b5ecf817773cd7fd67 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Add missing dotsPaul Wicking2018-06-193-3/+3
| | | | | | Task-number: QTBUG-68933 Change-Id: I32122f9c771b12f1ea4cb3c8e405c30bf2bf4d41 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Merge remote-tracking branch 'origin/5.9' into 5.11Liang Qi2018-02-182-2/+2
|\ | | | | | | | | | | | | Conflicts: .qmake.conf Change-Id: I83e2382427eb4a8ee0d52d3c4f379242ef80e09e
| * Bump copyright yearJani Heikkinen2018-02-062-2/+2
| | | | | | | | | | | | Task-number: QTBUG-65810 Change-Id: I3d9befbc56e1c7a63c383e872977e10d1eaa3734 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
| * Fix typo in qdoc manualKai Koehne2017-09-121-1/+1
| | | | | | | | | | Change-Id: I699a997237f90a2f9d202953692162481be8844a Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | doc: Add short page users about qdoc's clang dependencyMartin Smith2018-02-161-2/+27
| | | | | | | | | | | | | | | | | | | | | | | | From Qt 5.11, QDoc requires clang from LLVM 3.9 or later. This new dependency must be listed in the Qt documentation. This update adds a short page to the QDoc User Guide that provides basic (preliminary) information for users intending to build and/or run QDoc. Change-Id: I7e86d6515d05b4d993fb91889e6f060c6aa0706e Task-number: QTBUG-65762 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* | Merge remote-tracking branch 'origin/5.10' into devLiang Qi2018-01-111-0/+58
|\ \ | | | | | | | | | | | | | | | | | | Conflicts: .qmake.conf Change-Id: Ieef1b05234ee67bef28f2dc9abaa65f10840d21b
| * | qdoc: Allow defining titles for navigation.homepage and landingpageTopi Reinio2017-12-061-0/+58
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 'navigation' sub-variables 'cppclassespage' and 'qmltypespage' already have associated variables that allow defining a user-visible title, shown in the navigation. This commit does the same for 'homepage' and 'landingpage'. This makes it possible to avoid situations where the homepage title clashes with another (e.g. section) title: navigation.homepage = index.html navigation.hometitle = "Qt $QT_VER" Add documentation for the navigation variables. Change-Id: Ie4ff5f906b2ee6be01db65562025df7da2a9dff8 Reviewed-by: Martin Smith <martin.smith@qt.io>
* | | qdoc: Add optional since clause to \value commandMartin Smith2017-11-151-4/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This update adds the capability to include a since clause in a \value command. Without the since clause, a \value command might look like this: \value QtInfoMsg A message generated by the qInfo() function. The same command with a since clause would look like this: \value [since 5.5] QtInfoMsg A message generated by the qInfo() function. The since clause must be encosed in square brackets and must appear before the value name. Task-number: QTBUG-40782 Change-Id: If6cbb831c6f355eabcb0ddfdc284d2c9453f6245 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* | | Merge remote-tracking branch 'origin/wip/qdoc-clang' into devLiang Qi2017-11-132-79/+50
|\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: src/qdoc/cppcodeparser.h src/qdoc/location.cpp src/qdoc/qmlcodeparser.h Change-Id: I2e579ca5d83cd1c4b42acc9a07066d800cbc02cb
| * | | qdoc: Remove chapter and part commandsMartin Smith2017-08-102-79/+50
| |/ / | | | | | | | | | | | | | | | | | | | | | These commands are not used anywhere, and they cause qdoc to generate illegal html code, so they are removed. Change-Id: I39b670a9691221854a78ea5c332c67ea758199ee Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* | | qdoc: Add file extensions to minimum.qdocconfMartin Smith2017-11-111-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | minimum.qdocconf is changed to include fileextensions.qdocconf. Task-number: QTBUG-62060 Change-Id: If50f7f87813fae0c2d52ffc0a812bfadda1a203b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* | | qdoc: Introduce 'warninglimit' configuration variableTopi Reinio2017-10-241-0/+26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This variable is primarily meant for testing the documentation builds in the CI system; if the warning count exceeds the set limit, QDoc uses the total number of warnings as exit code. The warning limit is enforced when either warninglimit.enabled = true, or QDOC_ENABLE_WARNINGLIMIT environment variable is set. This also provides a method to override the CI failing a documentation build; the author can increase the warning limit to let the build pass, hopefully with a good excuse in the code review. Change-Id: If455a9636f2c63b41798523dd4acb3183a00229c Reviewed-by: Martin Smith <martin.smith@qt.io> Reviewed-by: Frederik Gladhorn <frederik.gladhorn@qt.io>
* | | qdoc: Update docs on format-specific config variablesTopi Reinio2017-10-173-35/+76
| | | | | | | | | | | | | | | | | | | | | | | | | | | 'outputformats' can now include also WebXML, and 'outputsubdir', 'nosubdirs' and 'quotinginformation' can be set to a format- specific configuration. Change-Id: I6444fac94f4cca7be281e2af7dcfd85c52e79c14 Reviewed-by: Martin Smith <martin.smith@qt.io>
* | | qdoc: Allow defining example tags with the \meta commandTopi Reinio2017-10-112-3/+26
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | QDoc collects example metadata that includes tags, accessible in Qt Creator's Welcome mode. These tags are automatically generated from the example title and module name. To allow writers to define additional tags to an example, \meta command can be used within \example topic: \example foo \meta {tag} {QFoo,QBar} //! Demonstrates the use of these classes Change-Id: I8f18d612567fc8e035d84663d9e2cdb953db11c6 Reviewed-by: Martin Smith <martin.smith@qt.io>
* | Merge remote-tracking branch 'origin/5.9' into devLiang Qi2017-07-061-1/+1
|\ \ | |/ | | | | | | | | | | Conflicts: .qmake.conf Change-Id: I10c51b1983bcc48043b89b9aac9780da311ff802
| * Fix qdoc documentation about \eKai Koehne2017-06-221-1/+1
| | | | | | | | | | | | | | | | | | | | The \e command was actually applied, which showed "Used for italics". Anyhow, I find the sentence redundant ... Change-Id: I31e8e10d7ee2f00b77ca174b498d5dac029f71be Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Martin Smith <martin.smith@qt.io>
* | qdoc: Further improve example file listingTopi Reinio2017-07-041-6/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fix a bug where '\generatelist examplefiles' with no second parameter produced an empty list, instead of listing all files. Also, no longer restrict the searching of example image files to the images/ subdirectory. All images under a project directory are now listed, except those under doc/images. Minor fixes to related QDoc documentation. Change-Id: Id4516ba2feb98466a0e893a85f85118e3d21eae2 Reviewed-by: Martin Smith <martin.smith@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* | qdoc: Improve example file listingTopi Reinio2017-06-261-0/+28
|/ | | | | | | | | | | | | | | | At the end of \example documentation page, qdoc lists all the files that are part of the example project. This commit does the following improvements: - Sort the example files based on path name - Introduce '\generatelist examplefiles [regexp]', which lists the files (optionally, only those that match regexp) at the specified location. - Enable \noautolist for example pages, to skip generating the the file list at the end. Change-Id: Ic9ae70f9f7de166d314ae489a7bab9a935949fc3 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Bump copyright yearFriedemann Kleint2017-03-272-2/+2
| | | | | | Task-number: QTBUG-59648 Change-Id: I4aba86e684ca6073228e556000599781303b74bd Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Doc: QDoc manual: Document \badcodeTopi Reinio2017-01-052-4/+22
| | | | | | Change-Id: Iffbf809261a2ac572aa83ca5aaddb3d6258221ac Reviewed-by: Martin Smith <martin.smith@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: QDoc manual: clean up command indexTopi Reinio2017-01-053-20/+21
| | | | | | | | | | | Fix typos and formatting, remove unused \span commands and remarks of items introduced 5 years ago as being 'New'. Also list the \qml command in the command index, and remove a couple of obsolete statements. Change-Id: Iaa7a81889f30e08ea8299bc0e1848c8472efa7e1 Reviewed-by: Martin Smith <martin.smith@qt.io>
* Merge remote-tracking branch 'origin/5.7' into 5.8Liang Qi2016-11-081-35/+11
|\ | | | | | | Change-Id: Ib403ca6ac5edf4c75e7fbdcd467601bdfe348e6d
| * Merge remote-tracking branch 'origin/5.6' into 5.7Liang Qi2016-11-041-35/+11
| |\ | | | | | | | | | Change-Id: I4ee208f69bed72c480c636cb18f22fd88c02d1e5
| | * Doc: Update documentation on \legalese QDoc commandTopi Reinio2016-10-251-35/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The \legalese command is not used in Qt 5 documentation, because it does not support collating license texts across modules. Update the documentation accordingly, and remove the obsolete example on how it's being used in Qt docs. Change-Id: Id3505ccf5b44bd2c2e236b8464dea18d4c7b8a89 Reviewed-by: Martin Smith <martin.smith@theqtcompany.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | | Merge remote-tracking branch 'origin/5.7' into 5.8Liang Qi2016-09-053-7/+7
|\ \ \ | |/ / | | | | | | Change-Id: I29e1f5d7d146cc77f8cf92bfbe2e41ffad50a041
| * | Merge remote-tracking branch 'origin/5.6' into 5.7Liang Qi2016-09-053-7/+7
| |\ \ | | |/ | | | | | | | | | | | | | | | Conflicts: src/qdoc/doc/qdoc-manual-markupcmds.qdoc Change-Id: I43e2d334a848397a2e619ad19aab66daff53d9b7
| | * Doc: Change instances of 'OS X' to 'macOS'Topi Reinio2016-08-152-7/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | As of version 10.12 (Sierra), the name of Apple's desktop operating system will be macOS. Change all occurrences where the Mac platform is discussed to use the macro \macos (defined in the documentation configuration in qtbase), except within \code blocks in QDoc manual, where macros are not expanded. Change-Id: Ic742163948f3970d2acaa179eb02d4e0c1593bf8 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
| | * Update Qt logo in qdoc manualFriedemann Kleint2016-08-051-0/+0
| | | | | | | | | | | | | | | | | | Task-number: QTBUG-55137 Change-Id: I60e25790eda55db78d2a474b1d269db33439f83b Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* | | qdoc: Add support for attribution pagesKai Koehne2016-08-081-0/+17
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | "\page xx attribution" now marks a page as describing a code attribution, and \generatelist{attributions} generates an overview of all attribution pages. Originally code attributions were meant to be handled by \legalese ... \endlegalese and \generatelist{legalese}. Anyhow, this fails giving more details than the pure license text. Change-Id: I3543f077051b361ce59fe27e50f9719dfa52ced3 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* | Merge remote-tracking branch 'origin/5.6' into 5.7Liang Qi2016-06-292-4/+4
|\ \ | |/ | | | | | | | | | | Conflicts: src/assistant/assistant/doc/src/assistant-manual.qdoc Change-Id: I136caf5f26eff4d1c2574459b8dff9937c2c372d
| * Use \note commandKai Koehne2016-06-212-4/+4
| | | | | | | | | | Change-Id: Icf7b356ea04989525313e53c883cb8d4dec28762 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | Unify license header usagev5.7.05.7.0Antti Kokko2016-06-103-9/+39
| | | | | | | | | | | | | | Updated BSD license. Change-Id: Ie2521f94a2e8ed423f989e902e5eb88512814f71 Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
* | Unify license header usageAntti Kokko2016-06-1020-100/+100
| | | | | | | | | | | | | | Updated FDL license. Change-Id: I726ee109b17070d79e19c9edcdba7780aa54b1f1 Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
* | Updated license headers and license testsAntti Kokko2016-06-102-34/+24
| | | | | | | | | | | | | | | | | | | | | | | | | | From Qt 5.7 -> tools & applications are licensed under GPL v3 with some exceptions, see http://blog.qt.io/blog/2016/01/13/new-agreement-with-the-kde-free-qt-foundation/ Updated license headers to use new GPL-EXCEPT header instead of LGPL21 one (in those files which will be under GPL 3 with exceptions) License header tests also updated to match current headers. Change-Id: Ia6bdacaa3c5bbc9d31334e1a0cabfe502a484dc4 Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
* | Merge remote-tracking branch 'origin/5.6' into 5.7Liang Qi2016-05-191-1/+1
|\ \ | |/ | | | | | | | | | | Conflicts: .qmake.conf Change-Id: I5fde87a1ac22e933c926e0d86996791a38d92c4e
| * Doc: Remove repository name from examplesinstallpathTopi Reinio2016-05-121-1/+1
| | | | | | | | | | | | | | | | Examples in binary packages now directly match the install path. Change-Id: Icdb94fbde0c719722248c54e8d0e75b2877ab1d1 Task-number: QTBUG-52953 Reviewed-by: Antti Kokko <antti.kokko@qt.io>
* | Merge "Merge remote-tracking branch 'origin/5.6' into 5.7" into refs/staging/5.7Simon Hausmann2016-04-061-1/+1
|\ \
| * \ Merge remote-tracking branch 'origin/5.6' into 5.7Simon Hausmann2016-04-061-1/+1
| |\ \ | | |/ | | | | | | Change-Id: I06a1d65d1bcb0cdb0ae6e00e57283333aafbb673
| | * qdoc: Fix double backslash in link referenceOrgad Shaneh2016-04-061-1/+1
| | | | | | | | | | | | | | | Change-Id: I888354b968ad666d862871107b7eca69910d27a9 Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
* | | purge symbian vestigesOswald Buddenhagen2016-04-061-2/+0
|/ / | | | | | | | | Change-Id: I53373e8d6ef2c2f7b46945f6654b019d32d38a2c Reviewed-by: Friedemann Kleint <Friedemann.Kleint@theqtcompany.com>
* | qdoc: Use '//!' as a documentation commentTopi Reinio2016-04-052-15/+26
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit makes QDoc treat a string starting with '//!' as a single-line comment that is not included in the generated HTML output. It has several uses: Internal documentation remarks visible only in the source code, and a simpler alternative to \omit, \endomit commands. Most importantly, it allows \include command to pull in content from any file mentioned in the source directories, for example: /*! \fn foo() //! [foo-descr] ...long description... //! [foo-descr] */ /*/ \fn foo(int bar) \overload foo() \include foo.cpp foo-descr ... */ Above will work and the snippet identifies are omitted from the generated HTML output. Change-Id: I0777247dc00358682c307c356fb7d1d8a4514dac Task-number: QTBUG-52063 Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
* Bump copyright yearKai Koehne2016-01-272-2/+2
| | | | | | Task-number: QTBUG-50578 Change-Id: Ief1031dd179b9a22314f48c550aa234a3d143eb0 Reviewed-by: Lars Knoll <lars.knoll@theqtcompany.com>
* qdoc: Allow wildcards for excludefiles qdocconf variableTopi Reinio2016-01-221-2/+9
| | | | | | | | | | This commit allows the use of simple wildcards ('*' and '?') for excluding a set of files. A typical use case is to exclude all private header files with '*_p.h'. Task-number: QTBUG-50600 Change-Id: Ib50e9e85731d7506ea7299016f609e48ab3d277f Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
* Doc: Fix issues in QDoc Manual documentationTopi Reinio2016-01-192-21/+18
| | | | | | | | | | | | | | | | This commit partially reverts 23fc55c4bbf3cf334ff33f1b7816c35fdc67fd93 - adding example directories from outside the module boundaries caused multiple warnings. Instead, copy-paste the required code snippet directly into the source documentation. Additionally, in qdoc.qdocconf, - Remove obsolete 'imagedirs' path - Remove obsolete dependencies - Fix filter attributes - Use up-to-date selectors for QHP Change-Id: Ic2836e1e2e1da6b4aebcd0250af25e2b40cce196 Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
* qdoc: Allow specifying a module name as QHP selectorTopi Reinio2016-01-111-2/+4
| | | | | | | | | | | | | | | Previously, there was no machanism to list the members of a specific C++/QML module in a table of contents subsection. This allows the above, with following syntax: qhp.project.subprojects.name.title = Qt FooBar Classes qhp.project.subprojects.name.indexTitle = Qt FooBar C++ Classes qhp.project.subprojects.name.selectors = module:QtFooBar Change-Id: I1547df3618c2daf8d24987c67e337e9dc99835b5 Task-number: QTBUG-50334 Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
* Fix dead URLsFrank Meerkoetter2016-01-081-7/+7
| | | | | | | Link to doc.qt.io. Change-Id: I2fca0a457fad3564f0a2ce387482f922af38d4bc Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Fix broken link, dust off the \qmlsignal exampleFrank Meerkoetter2016-01-071-5/+4
| | | | | | | | This patch fixes a broken link (still pointing to Qt4.7) and also makes the example more consistent. Change-Id: I5705a367055013405c5015067567b830ab96201e Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
View Lorry Controller Status