summaryrefslogtreecommitdiffstats
path: root/src/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Fix documentation macro and other issuesTopi Reinio2016-01-261-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | QDoc doesn't allow a macro that expands into an empty string: src/core/nodes/qcomponent.cpp:189: warning: Unknown command '\TODO' Linking issues that are fixed by adding a dependency to Qt GUI: src/input/frontend/qkeyevent.cpp:121: warning: Can't link to 'QKeyEvent::nativeScanCode()' src/input/frontend/qkeyevent.cpp:141: warning: Can't link to 'QKeySequence::StandardKey' src/quick3d/quick3d/qquaternionanimation.cpp:42: warning: Can't link to 'QQuaternion' Other fixed warnings: src/input/frontend/qmousecontroller.cpp:54: warning: Unknown command '\intantiates' src/quick3d/quick3d/qquaternionanimation.cpp:42: warning: C++ class Qt3DCore::Quick::QQuaternionAnimation not found src/render/materialsystem/qparametermapping.cpp:85: warning: Undocumented enum item 'UniformBufferObject' Undocumented enum item 'ShaderStorageBufferObject' examples/qt3d/wireframe/doc/src/wireframe.qdoc:28: warning: Can't link to 'BasicCamera' Change-Id: Iea8f591bd09f0b8895dc568a48f2bfe80f2fe73d Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Doc: Mark QCircularBuffer as \internalTopi Reinio2016-01-251-159/+159
| | | | | | | | | | As the class was made private, mark it \internal. Because its private header file is not included in the documentation build, also replace the qdoc comments '/*!' with standard C comments to avoid documentation warnings. Change-Id: I896d13e4192830976d8f24c5b98fdef2b127bf1c Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* Doc: Exclude private header files from the documentation buildTopi Reinio2016-01-251-0/+2
| | | | | | | | | | | | In the documentation configuration, exclude all '_p.h' files from the documentation build. This prevents QDoc from generating documentation for private classes, and also allows removal of documentation that explicitly set the private classes \internal. Change-Id: I8fcf5c99a2a0b75e9ee5dcd928fa4a2b4b8cf34f Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* Doc: Use 'Qt 3D' instead of Qt3D consistentlyTopi Reinio2016-01-253-8/+9
| | | | | Change-Id: I91c0d00c0116a05209239da399f4076316a51fc7 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* Doc: Add skeletal doc structure for the QML types of Qt3D Input moduleVenugopal Shivashankar2016-01-221-3/+2
| | | | | | | Also marked a few private C++ classes as \internal. Change-Id: I32a7da498c97e132f6b6e60d551cc0b7feb52b01 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* Added Audio Visualizer exampleTitta Heikkala2016-01-221-1/+2
| | | | | | | | | | | | Example visualizes the magnitude of music played as animated bars. The music is played using media player. Implementation combines the use of Qt 3D rendering with Qt Quick 2D elements. Change-Id: I945d50d0dbd26151f274269649cca793a5ad4d27 Reviewed-by: Tomi Korpipää <tomi.korpipaa@theqtcompany.com> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@theqtcompany.com> Reviewed-by: Pasi Keränen <pasi.keranen@theqtcompany.com> Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* Doc: Removed Qt3DCollision namespace and module docsVenugopal Shivashankar2016-01-214-85/+4
| | | | | | | | Besides that, fixed a few qdoc warnings. Change-Id: Ibaf8fd6ffbb93f3f2bd73fa5fedf06e94f6ac2eb Reviewed-by: Paul Lemire <paul.lemire@kdab.com> Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Fixed some documentation warningsTomi Korpipää2016-01-194-5/+11
| | | | | | | Change-Id: I5055043641a1916dde47ad614d8ab7a5788fd93b Task-number: QTBUG-46037 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@theqtcompany.com> Reviewed-by: Pasi Keränen <pasi.keranen@theqtcompany.com>
* Doc: Remove duplicated examplesinstallpathTopi Reinio2015-12-071-2/+0
| | | | | | | | The first one is correct, remove the redefinition. Task-number: QTBUG-49777 Change-Id: Ic2d4edb0b8ef2b596fdac1eb417c7cf20a61af5c Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Doc: Fix QDoc warnings and do further cleanupTopi Reinio2015-11-234-76/+75
| | | | | | | | | Fix the documentation issues that still remained broken after renaming the namespaces/QML modules. Do further cleanup and minor doc editing. Change-Id: Iff38c8c1b99e7f712dc3f9ad07ecd37a747b3a26 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Doc: Documentation clean upVenugopal Shivashankar2015-11-0610-274/+275
| | | | | | | | | | - 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-2826-0/+3446
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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-03 08:49:59 +0000