summaryrefslogtreecommitdiffstats
path: root/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
Commit message (Collapse)AuthorAgeFilesLines
* QDoc: Add warning to use of \contentspage commandv5.15.0-beta2Paul Wicking2020-03-111-10/+0
| | | | | | | | | | | The \contentspage command doesn't produce nav links to the contents page between the next and previous pages. QDoc hasn't generated these links in html output since Qt 5.3. Remove the documentation that refers to the command and add a warning that it should not be used.. Task-number: QTBUG-75170 Change-Id: Ib16fc1cbb1e661a7519ba650e655e209c3b45b68 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Merge remote-tracking branch 'origin/5.14' into 5.15Qt Forward Merge Bot2020-02-181-8/+24
| | | | | Change-Id: I98eaf748fdfb34f32d187718459327b8eef9c54b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* QDoc: Remove references to DITA in documentationPaul Wicking2020-02-121-115/+4
| | | | | | | | As most of the code related to generating DITA has been pulled out, remove also the references to it in the documentation. Change-Id: I420242f236faf3b89baea1547421a1f50d91762f Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Bump copyright yearJani Heikkinen2020-01-081-2/+2
| | | | | Change-Id: I81c229523e0d896f25d6d961c9857b615218ecbb Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
* qdoc: Add support for CMake commentsKai Koehne2019-04-021-0/+5
| | | | | | | | | | | | | | | | | CMake uses # as a line comment marker. To detect CMake files we check for the suffix .cmake, or check whether the filename is "CMakeLists.txt". See also https://cmake.org/cmake/help/latest/manual/cmake-language.7.html [ChangeLog][qdoc] qdoc now uses #! as a snippet marker in .cmake, CMakeLists.txt files. Task-number: QTBUG-73058 Change-Id: I230b113f0d49dd487b0f1926c815295a8a660a27 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: QDoc Manual: Clarify the use of \printuntil without an argumentTopi Reinio2018-11-161-0/+3
| | | | | | Change-Id: I204884f38b7993991469c51bc45a3a6087bb49e9 Reviewed-by: Kai Koehne <kai.koehne@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* qdoc: Allow parameters for \code, \qml, \js, and \badcode commandsTopi Reinio2018-09-091-1/+31
| | | | | | | | | | | | | | | | | | | | | | | Allow optional parameters for commands that enclose code snippets. This is intended for replacing simple strings within the snippet, typically using a macro that extends to certain parameter(s). Within the snippet, the parameter locations are marked similarly to .qdocconf macro parameters: \code foo bar \1+\2=\1\2 \encode Renders "foo+bar=foobar" A code snippet parameter cannot contain spaces, as space is used as a delimiter. If no parameters are passed, the snippet is rendered as-is. Task-number: QTBUG-67818 Change-Id: I500e6b1a9095c9c55f47c8d75951792f31745545 Reviewed-by: Martin Smith <martin.smith@qt.io>
* Merge remote-tracking branch 'origin/5.11' into devLiang Qi2018-06-301-2/+2
|\ | | | | | | | | | | | | Conflicts: src/androiddeployqt/main.cpp Change-Id: I3df907e197b1b976f74562f1a9cce10261f166f3
| * 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>
* | qdoc: Remove support for \compat commandMartin Smith2018-06-011-117/+3
|/ | | | | | | | | The \compat command is no longer needed in QDoc, and the code that supports it makes some parts of QDoc needlessly complex. This update removes it, along with the documentation for it in the QDoc manual. Change-Id: I249b571e24ff8c3530d1ae5dbb4fff9186dba49d Reviewed-by: Martin Smith <martin.smith@qt.io>
* Merge remote-tracking branch 'origin/5.9' into 5.11Liang Qi2018-02-181-1/+1
|\ | | | | | | | | | | | | Conflicts: .qmake.conf Change-Id: I83e2382427eb4a8ee0d52d3c4f379242ef80e09e
| * Bump copyright yearJani Heikkinen2018-02-061-1/+1
| | | | | | | | | | | | Task-number: QTBUG-65810 Change-Id: I3d9befbc56e1c7a63c383e872977e10d1eaa3734 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@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-131-77/+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-101-77/+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: Allow defining example tags with the \meta commandTopi Reinio2017-10-111-2/+24
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: 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-271-1/+1
| | | | | | Task-number: QTBUG-59648 Change-Id: I4aba86e684ca6073228e556000599781303b74bd Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Doc: QDoc manual: Document \badcodeTopi Reinio2017-01-051-4/+21
| | | | | | 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-051-13/+13
| | | | | | | | | | | 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-051-6/+6
|\| | | | | | | | | | | Change-Id: I29e1f5d7d146cc77f8cf92bfbe2e41ffad50a041
| * | Merge remote-tracking branch 'origin/5.6' into 5.7Liang Qi2016-09-051-6/+6
| |\| | | | | | | | | | | | | | | | | | | Conflicts: src/qdoc/doc/qdoc-manual-markupcmds.qdoc Change-Id: I43e2d334a848397a2e619ad19aab66daff53d9b7
| | * Doc: Change instances of 'OS X' to 'macOS'Topi Reinio2016-08-151-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | 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-291-3/+3
|\| | | | | | | | | | | | | Conflicts: src/assistant/assistant/doc/src/assistant-manual.qdoc Change-Id: I136caf5f26eff4d1c2574459b8dff9937c2c372d
| * Use \note commandKai Koehne2016-06-211-3/+3
| | | | | | | | | | Change-Id: Icf7b356ea04989525313e53c883cb8d4dec28762 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | Unify license header usageAntti Kokko2016-06-101-5/+5
| | | | | | | | | | | | | | Updated FDL license. Change-Id: I726ee109b17070d79e19c9edcdba7780aa54b1f1 Reviewed-by: Jani Heikkinen <jani.heikkinen@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-051-14/+21
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-271-1/+1
| | | | | | Task-number: QTBUG-50578 Change-Id: Ief1031dd179b9a22314f48c550aa234a3d143eb0 Reviewed-by: Lars Knoll <lars.knoll@theqtcompany.com>
* Doc: Fix issues in QDoc Manual documentationTopi Reinio2016-01-191-7/+11
| | | | | | | | | | | | | | | | 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-doc: Combine code snippets into a single block.Edward Welbourne2016-01-041-10/+6
| | | | | | | | | | Having a \dots before the \code rendered the dots in a separate code display box, rather than as the start of the rest of the block. The same didn't happen at the end, but adjust it symmetrically anyway. Also fixed an over-escaped \snippet. Change-Id: I42253260745547c88c44a7ecaf937bb8303030a6 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* qdoc-doc: Adjust some wordings so they're actually true.Edward Welbourne2016-01-041-2/+2
| | | | | | | | | They claimed all the formatting commands were for C++, despite \qml being for QML not C++ and many of the commands being *not only* for C++ but also for (at least) QML. Change-Id: I942f7b597d6abad364caf5d7eda340cbce8c272b Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* qdoc: Add support for listing all examples from all modulesTopi Reinio2015-12-121-0/+12
| | | | | | | | | | | | | | | | | | | | | This commit adds a new argument for \generatelist command, which enables the generation of an 'example index' page: \generatelist annotatedexamples This will generate a set of tables; one for each module, prefixed by a header titled with the module name. The table is an annotated list (title + brief description) for each documented example. A human-readable name for each module is read from the navigation.landingpage .qdocconf variable. This name is written to / read back from the index files as 'indexTitle' attribute. Examples for modules that do not define a landing page title are listed in a single table with no accompanying header. Change-Id: Icb7fa6fb40ec9a0dfce1bf8282c8782a69ec0028 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
* move qdoc back to qttoolsOswald Buddenhagen2015-10-231-0/+4081
we can do that now, as the bootstrap lib is now a properly exported module, and qmldevtools is now bootstrapped as well. this removes the abomination of a copy of the qml parser in qtbase. unfortunately qtbase/2422251ee5025a067b14b989153764ab36e43f10 is reverted, as qtdeclarative is still missing the respective change. this introduces no regression in discoverability or usability, as a full doc build already needed qttools - for qhelpgenerator. Change-Id: Ic9c4c9732ddf5998637b9e42e27939ba50b31479 Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@theqtcompany.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Lars Knoll <lars.knoll@theqtcompany.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-08 10:04:17 +0000