summaryrefslogtreecommitdiffstats
path: root/src/doc/src/qt3drender-module.qdoc
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-201-0/+103
| | | | | | | | | | | 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>
* Doc: Divide documentation into submodulesTopi Reinio2018-02-091-100/+0
| | | | | | | | | | | | | | | | | 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>
* Merge remote-tracking branch 'origin/5.6' into devLiang Qi2016-01-261-3/+4
|\ | | | | | | | | | | | | | | | | Conflicts: src/doc/src/qt3dcollision-module.qdoc src/render/frontend/qcamera.cpp src/render/frontend/qcameralens.cpp Change-Id: I8a0ae250a6b8e065a1ef3c817968ebb7ef23b20d
| * Doc: Use 'Qt 3D' instead of Qt3D consistentlyTopi Reinio2016-01-251-2/+3
| | | | | | | | | | Change-Id: I91c0d00c0116a05209239da399f4076316a51fc7 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
| * Fixed some documentation warningsTomi Korpipää2016-01-191-1/+1
| | | | | | | | | | | | | | Change-Id: I5055043641a1916dde47ad614d8ab7a5788fd93b Task-number: QTBUG-46037 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@theqtcompany.com> Reviewed-by: Pasi Keränen <pasi.keranen@theqtcompany.com>
* | Unify license header usageAntti Kokko2016-01-261-11/+14
|/ | | | | | | Update old header.LGPL3 to header.LGPL Change-Id: I8eac0cd6bbc276a56df487249cc459c0d4fab165 Reviewed-by: Jani Heikkinen <jani.heikkinen@theqtcompany.com>
* Doc: Documentation clean upVenugopal Shivashankar2015-11-061-8/+8
| | | | | | | | | | - Changed 'Qt3D' references to 'Qt 3D'. - Fixed incorrect \inqmlmodule instances. - Fixed broken \printuntil instances in the example docs. - Updated the namespace qualifier for a few class references. Change-Id: I250afe6843b10ed520f9ce5d7465203cc5c212c1 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Move the doc artifacts outside of the submodule directoryVenugopal Shivashankar2015-10-281-0/+96
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>