summaryrefslogtreecommitdiffstats
path: root/src/core/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Use a macro to resolve QML import versionsTopi Reinio2018-09-261-4/+4
| | | | | | | | | | | QDoc now supports macros for its command parameters, as well as passing parameters to \code and \qml commands. Use these together with the new \QtMinorVersion macro to automate bumping the QML import versions within documentation. Task-number: QTBUG-67818 Change-Id: Ia09a5cc06bd6e7ccd41305cecbdac90318402d00 Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Use FDL license for all .qdoc filesKai Koehne2018-05-281-21/+9
| | | | | Change-Id: Ib777cb5c17939e618e51ceeb701de973d564014a Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Revert "Doc: Divide documentation into submodules"Topi Reinio2018-04-202-1637/+0
| | | | | | | | | | | This reverts commit c8964b8f1cf56718a189b0f57bad446cec30a8b8. QDoc now supports documentation-specific custom module headers and include headers that allow us to keep using a single documentation project that covers multiple modules. Change-Id: I84706a7149097a6b03f0f266e55d6f712a6c773e Reviewed-by: Martin Smith <martin.smith@qt.io>
* Document state of the Qt 3D modulesKai Koehne2018-03-121-0/+2
| | | | | | | | | | | | | Do make it explicit which ones are still in development also in the landing page, and add \preliminary and \since tags (for released and TP modules, respectively). Note that the \preliminary, \since tags currently do not work for \qmlmodule, which hopefully gets fixed at one point: QTBUG-65963. Change-Id: I6648311c38f331286be37eefa60794984cd239b7 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Divide documentation into submodulesTopi Reinio2018-02-093-0/+1718
| | | | | | | | | | | | | | | | | QDoc in Qt 5.11 will use Clang (libclang) to parse C++ documentation. In order to do that, Clang needs to have the include paths available when parsing source; qmake provides that information to QDoc but only when the documentation project is located under the correct module (source) path. By having dedicated doc projects for Qt 3D Core, Render, Input, etc. the number of documentation warnings is signicantly reduced. A top-level 'Qt 3D' project is still kept, and contains the landing page, overview, examples, and top-level 'C++ classes' and 'QML types' pages that list all types documented across all Qt 3D submodules. Change-Id: Id5936de36f31c2a8764a64e1e9d7ae0d10e8ab14 Reviewed-by: Martin Smith <martin.smith@qt.io>
* Doc: Move the doc artifacts outside of the submodule directoryVenugopal Shivashankar2015-10-2812-1010/+0
| | | | | | | | | | | | The qdocconf now lives in 'src/doc' because the documentation project defined by it covers the whole Qt 3D module. This change enables qmake to use 'qt3d' as the output directory for doc make targets. The new 'doc' directory also includes the relevant images, snippets, and the qdoc files. Change-Id: Ibc6d0912f8b1e665767e97630b3e5509e10c5710 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Updated the docs for the namespace changesVenugopal Shivashankar2015-10-274-10/+20
| | | | | | | | | | | | | | | | Each of the submodules now have there own namespace so the following changes are required to adapt: - Added \namespace docs for the new namespaces. - Updated all the \class and \instantiates entries to use the appropriate namespace qualifier. - Changed the \module and \qmlmodule names for Qt 3D Core and Qt 3D Render modules. - Added the missing \module and \qmlmodule pages for the Qt 3D Collision module. Change-Id: Ibc5bf30e4f50aecb6a3b24bc8536f17ed19d681d Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Update examplesinstallpath to include the repository nameTopi Reinio2015-10-211-1/+1
| | | | | | | | | | | | The examplesinstallpath variable in .qdocconf files defines the path under QT_INSTALL_EXAMPLES where examples are found. To match the way examples are packaged in Qt 5.6, prefix the install path with the repository name. Task-number: QTBUG-48736 Change-Id: I499f71a4009b806e023ca67eab11713713d6421b Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Doc: Use a single a doc project for all the submodule docsVenugopal Shivashankar2015-10-054-77/+155
| | | | | | | | | | Although there are different headers and import statements to use for these submodules, it's still convenient for the reader with one doc project. Task-number: QTBUG-48502 Change-Id: I3103501fd272739a0fb8bfd8e0aa7d3f48e5df82 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Add some docs for the shadow map exampleSean Harmer2015-06-252-4/+85
| | | | | | Change-Id: Iea29c9f654fc57518bf3d428b30fa5955aa1230d Reviewed-by: Sean Harmer <sean.harmer@kdab.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Doc: Add documentation for the Wireframe QML ExampleSean Harmer2015-06-241-2/+29
| | | | | | | | | | | Add information about materials and shaders in the overview topic. Add file extensions to the configuration file to have all the example files listed in the example docs. Change-Id: I709f91fb854ca18fb3a56caf656c191fa15e99ef Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* Add some documentation about the framegraph conceptsSean Harmer2015-06-192-5/+7
| | | | | | Change-Id: I9f2e21d3277d69a396a564ffd58c53ee91b37d45 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* Doc: Fix multiple documentation issuesv5.5.0-rc1Topi Reinio2015-06-153-8/+16
| | | | | | | | | | | | | | | | - Restore qt3d-index.html as the main landing page. Needed for external linking. - Fix \inmodule commands for Renderer classes - Add proper group so that all three modules are listed on the landing page, both C++ and QML modules - Remove qt3drenderer-index.html (to be consistent with Qt3DCore), copy contents over to the module page and to a new file, qt3d-examples.qdoc. - Fix indexTitles in qdocconf files, and subprojects for Renderer QML types and Qt3D examples Change-Id: I0e2497771d0525d120ffa9d7d6338b01fdfa6963 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Doc: Add skeleton docs for Qt3D Input classes and QML typesTopi Reinio2015-06-152-2/+72
| | | | | | | | | Not fully documented yet, but enables the classes and QML types to be visible in the documentation. Change-Id: I557aeae9ff6314b697bcc9313c1061543363b645 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* Add an overview of Qt3D and its motivation and architectureLeena Miettinen2015-06-124-0/+273
| | | | | | Change-Id: I29c3b972cc9847ecd28a22e9de484aef0f3ac185 Reviewed-by: Paul Lemire <paul.lemire@kdab.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Use Qt3DRenderer consistently for documentation configurationSean Harmer2015-06-111-1/+1
| | | | | | Change-Id: Ibea422bfe658c89dad919f98b7269bc801c9c295 Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com> Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* Add list of platform support levelsSean Harmer2015-06-111-0/+15
| | | | | | | To help adjust expectations. Change-Id: I5a2363c04ed6272d304f55ba7a3e5de3f3920088 Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* Move Qt3D generic index to Qt3DCore indexSean Harmer2015-06-112-90/+38
| | | | | | | | There is no Qt3D library, there is only Qt3DCore, Qt3DRenderer and Qt3DInput so we put the global stuff into the Qt3DCore docs. Change-Id: I31077581ba159d828d0f64968a83920308676007 Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* Doc: Add Qt3D QML module and QML type documentation skeletonv5.5.0-beta1Topi Reinio2015-04-293-3/+29
| | | | | | | | | | | Add documentation structure and comment blocks containing \qmltype, \qmlproperty, etc. commands for Qt3D QML module. The actual documentation (descriptions) are still missing, but this allows the QML type documentation to be generated. Change-Id: Id0e1afc89c13d963c950c142a3407aa70702562f Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* Doc: Fix multiple C++ documentation issuesTopi Reinio2015-04-142-4/+12
| | | | | | | | | | | | | | | | | | | - Remove multiple \namespace commands for namespace Qt3D. QDoc in 5.5 is now able to collate namespace members from multiple modules. - Mark 'Q...Private' classes and functions taking private arguments as \internal - Use correct \qtvariable for Qt 3D Core and Render - Add src/plugins directory to Qt 3D Core documentation build to correctly generate Assimp-related documentation. - Ensure documentation for C++ properties is visible by using the \property command instead of documenting the setter/getter functions. - Add export and logging macros to qdoc ignore directives - Remove unnecessary use of \fn command - Language and styling fixes Change-Id: I2481fa30ad2f6869b85c038c20ff1730b8522d46 Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* Doc: Add Qt3D landing pageTopi Reinio2015-03-172-1/+76
| | | | | | | | | | | | Add a top-level landing (index) page for Qt3D that links to information about the Qt3D modules, overviews, reference pages and examples. Add the Core and Render modules into a 'qt3d-modules' group so they will be listed on the index page. Change-Id: I18f0ec82a676f24e89c5eb068463482a6bd9e59d Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* Doc: Add skeleton documentation for the examplesTopi Reinio2015-03-172-1/+2
| | | | | | | | | | | | Add a skeleton version of the example documentation for each example, create a group page for them and link to it from the module landing pages. This allows browsing the example code from the docs and also enables listing them in Qt Creator's Welcome mode. Change-Id: I1ba16399b115bb8c5503bc91d2a8dee46417cd01 Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* Doc: Review doc Qt3DNico Vertriest2015-03-162-4/+21
| | | | | | Task-number: QTBUG-44180 Change-Id: Ia5ce031397f9b03c5ba692aa30b6097dc60e59e3 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Copyright header change.Mika Salmela2015-02-093-57/+42
| | | | | | | | As for preparation for Qt5.5 release the copyright header is updated to correspond the current license requirements. Change-Id: I36632918b66f455539453b42c369689fb11298ec Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* Add missing images for QCircularBuffer documentationSean Harmer2014-12-313-0/+0
| | | | | Change-Id: I1e6fe0d660b8dcd75b81cf736db5f7a97a730730 Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* Document the namespace to ensure classes in it get docs generatedSean Harmer2014-12-222-3/+11
| | | | | | | Also add the qml and quick dependencies. Change-Id: I1a9b9202bc4b2292bb26f92fcd8a9b8593d283e6 Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* Add index and module pages for Qt3DCoreSean Harmer2014-12-222-0/+103
| | | | | Change-Id: Iddc7703d874a65c36d2fa1b083f890fa23733400 Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* Add qdocconf file for Qt3DCoreSean Harmer2014-12-221-0/+40
| | | | | Change-Id: I5407b486a5a7d5a1eacc654c2c227b8114959b65 Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
* Add QCircularBuffer and testSean Harmer2014-04-171-0/+235
This is different to QtCore's QRingBuffer. QRingBuffer deals with raw bytes with a non-contiguous list of QByteArrays. QCircularBuffer is strongly typed and the data is guaranteed to be stored in a contiguous block of memory. Although the start/end of the buffer may not correspond to the start/end of the block of memory once it has reached capacity and wraps around. Done-with: Andreas Hartmetz and Marc Mutz Change-Id: Id03ad308b13fb359604d19474d892ff22c1e9b93 Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-10 09:55:56 +0000