aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/reference.qdoc
Commit message (Collapse)AuthorAgeFilesLines
* Implement eager pkg-config providerIvan Komissarov2021-10-141-0/+6
| | | | | | | | | | This implements provider that generates modules based on all .pc files present in system. This allows to get rid of the multi-shot providers such as fallback provider. Fixes: QBS-1614 Change-Id: Icf87ac609bc34bd26e8ed94ae547a7e649835a3a Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* Fix documentation warningsRichard Weickelt2020-10-251-7/+0
| | | | | | | | | | | The \contentspage command is obsolet without replacement. It has not been working since Qt5.2. The link to the Qt resource system does not work locally and should point to the online page instead. Change-Id: Ib065cfd26c90b60d3cd3d72820b16c6601e80ad4 Reviewed-by: Ivan Komissarov <ABBAPOH@gmail.com>
* doc: use \qmlmodule for ProbesIvan Komissarov2020-06-031-1/+1
| | | | | | | | This fixes qdoc warnings like that: "Could not resolve QML import statement for type 'PathProbe'" Change-Id: I839ddd2c702b1d56d2209c0eba4e3e44f2178364 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* Doc: Add a bit more info on the Probes pageIvan Komissarov2019-02-131-1/+4
| | | | | | | Task-number: QBS-1187 Change-Id: Ic504a8391c0e238e5fe946cb70041e3463a0f4db Reviewed-by: Christian Kandeler <christian.kandeler@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Add information about PathProbeIvan Komissarov2019-01-071-3/+13
| | | | | | | | | Also adds new section to the Reference Task-number: QBS-1187 Change-Id: I0798ec1791cdcb2177ee28bb8c180d1bd6375d30 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Use QML commands to document modulesLeena Miettinen2017-12-211-1/+5
| | | | | | Task-number: QBS-1245 Change-Id: I996bb44a1db9aae71ef42bca87265371de951272 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* Doc: Use QML commands to document Qbs convenience itemsLeena Miettinen2017-11-301-1/+1
| | | | | | Task-number: QBS-1245 Change-Id: I158e4c91b9306e74919901935f7d8eb546623d41 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* Doc: Use QDoc QML commands to document Qbs language itemsLeena Miettinen2017-11-301-2/+2
| | | | | | Task-number: QBS-1245 Change-Id: I470a629312b1c65ea9e51c603607c486115a304c Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* Doc: Create a CLI referenceLeena Miettinen2017-10-041-1/+1
| | | | | | | | | | | | | Each command is described on a separate page. Option and parameter descriptions are fetched from include files. \group and \ingroup commands are used to create a table that shows the CLI commands and short descriptions (from \brief commands). Task-number: QBS-947 Change-Id: I956c0e029f87e98162e03206a79baef604f1d55e Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* Document how to get binaries for QbsKai Koehne2017-07-241-0/+1
| | | | | | | | | | Move the section on how to build Qbs from sources to the end, and instead start with how to get precompiled Qbs binaries. This is arguably what most people prefer. Change-Id: Ibbfc7e3fcb9994840ab5d647a4846b88278deac5 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io> Reviewed-by: Jake Petroules <jake.petroules@qt.io>
* Documentation: Add "How-to" pageChristian Kandeler2017-06-061-1/+1
| | | | | | | | | | | | This fills a void in our documentation: Concrete, hands-on advice that is easily located. New items should be added based on feedback from our users. [ChangeLog] Added "How-to" section to documentation Change-Id: If959c9d979e18d44f6ef42810a8b0280bce64bda Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* Deprecate loadFile and loadExtension in favor of requireJake Petroules2017-02-151-1/+1
| | | | | | | | | | | | This is more in line with mainstream JavaScript (especially node.js) which uses the CommonJS/RequireJS scheme for loading external modules. [ChangeLog] The loadFile and loadExtension functions are deprecated in favor of the new require function, which accepts arguments of either form accepted by the deprecated functions. Change-Id: Icc00aa3eb7c136a5be787f28ef38435e4ce261bb Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* Documentation: split list of items into language and convenience itemsJake Petroules2016-12-071-1/+24
| | | | | Change-Id: Ia2f48518a4a78070a05a494c46debc8903308fa2 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
* Update license headersIikka Eklund2016-08-291-17/+14
| | | | | | | | | | Patch-set 3 includes rest of the files. Every source file needs to have up-to-date license headers in order to pass ci. Change-Id: I55ed96910b5cb13513f80eb118feafcdaa32e8b0 Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
* Replace 'the Qt build suite' with 'Qbs' in copyright notices.Jake Petroules2016-06-061-1/+1
| | | | | | Change-Id: I885d94bb14b325dc36767a840ebdb0be1fb59dd2 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* update license headersJoerg Bornemann2015-03-021-2/+2
| | | | | Change-Id: I36d825db3a5ef32c162c3063aab1e8a1f2696f4f Reviewed-by: Christian Kandeler <christian.kandeler@theqtcompany.com>
* Merge branch '1.3' into 'master'Christian Kandeler2015-01-281-6/+6
|\ | | | | | | | | | | | | | | | | Conflicts: doc/reference/jsextensions/jsextensions-general.qdoc src/lib/corelib/language/evaluatorscriptclass.cpp src/lib/corelib/language/evaluatorscriptclass.h Change-Id: Ic9b77b56e8fc8bf93e0a553930757de8c93fed22
| * Update LicenseEike Ziller2015-01-261-6/+6
| | | | | | | | | | Change-Id: I092fca9f950de1ba38826c33b155f86feae2770b Reviewed-by: Christian Kandeler <christian.kandeler@theqtcompany.com>
* | Add documentation for command-line tools.Christian Kandeler2014-12-161-0/+1
| | | | | | | | | | Change-Id: I6fee12bc51913f69853478f056e1cfc401d92997 Reviewed-by: Joerg Bornemann <joerg.bornemann@theqtcompany.com>
* | Merge remote-tracking branch 'origin/1.3'Joerg Bornemann2014-10-161-7/+8
|\| | | | | | | | | | | | | | | Conflicts: qbs_version.pri version.js Change-Id: I645b2f37bae9d36d4bca54b267d57df8b0b7fd21
| * complete license header updateJoerg Bornemann2014-10-161-7/+8
| | | | | | | | | | Change-Id: I2c7ea3242e5ce244e8feee01c0f8a0b0651fa0d4 Reviewed-by: Christian Kandeler <christian.kandeler@digia.com>
* | Annotate parameter and return types in Service documentation.Jake Petroules2014-09-231-0/+12
|/ | | | | | | This uses a declaration style similar to what is used by TypeScript. Change-Id: I5fb7ace4bb778e294b43eae72bff7c2b672795c3 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Merge remote-tracking branch 'origin/1.1'Joerg Bornemann2014-01-091-1/+1
|\ | | | | | | Change-Id: Iccf01f1dad3fca4a78c7d9b795fdef6df0181e9b
| * Incremented year in copyright infoRobert Loehning2014-01-081-1/+1
| | | | | | | | | | | | Change-Id: Ib7f9a00bb891fa39c5bc1f891ddbfba1e4d23227 Reviewed-by: Jake Petroules <jake.petroules@petroules.com> Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
* | Docs: Add documentation for Command and JavaScriptCommand.Christian Kandeler2013-12-111-0/+1
| | | | | | | | | | | | Change-Id: I21093165f92e96badf7a71eb631caab40e71ed9a Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
* | Doc: Use the \QBS macro for the product nameLeena Miettinen2013-11-111-3/+3
|/ | | | | | | | | | | | | | | This ensures that the name is always written in the same way and makes it easy to change, as only the value of the macro needs to be changed. Removed the product name from most titles as macros cannot be used in titles. It would break linking to titles. Please always use the macro in the future. Change-Id: I116abffc316edbb861034f5e431ca8e27b5a5d03 Reviewed-by: Jake Petroules <jake.petroules@petroules.com> Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
* Document JavaScript extensions.Christian Kandeler2013-09-191-1/+9
| | | | | Change-Id: I093f753285af2e9a9d6f3b521e23f8c24b8ac3cf Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
* Restructure the reference part of the documentation.Christian Kandeler2013-09-191-0/+55
It does not scale to repeat the whole contents of the reference manually in several tables of contents. Instead, make it opaque at the top-level and use the \group feature to get at least an automatic table of contents for the lowest level (items and modules at the moment). Change-Id: I80a3334a43f62481f74c21ad9d68e913c8b3098a Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-10 14:14:59 +0000