summaryrefslogtreecommitdiffstats
path: root/src/runtime/doc/src/module.qdoc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Fix documentation issuesTopi Reinio2019-04-101-7/+16
| | | | | | | | | | | | | | | | | | This commit fixes multiple documentation warnings and problems: - Add missing documentation for Presentation. - Add missing 'QT += 3dstudioruntime2' class info by introducing a \module page. - Add missing import statements info for QML types by introducing a \qmlmodule page. - Make the documented QML import statements follow module versioning. - Add missing documentation dependencies. - Omit internal classes/orphaned doc comments from the build. - Fix minor language issues. Change-Id: I854fc0646bfed9282c9a4159890b5fa6f40d46d0 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Bump doc version numbers to 2.1Laszlo Agocs2018-08-201-1/+1
| | | | | Change-Id: I1063234174e5db3c6b518d8e7461d6628286857f Reviewed-by: Christian Stromme <christian.stromme@qt.io>
* doc: Add a page for profileui and expand the common api oneLaszlo Agocs2018-05-231-4/+52
| | | | | Change-Id: I74a40b3ba177e73ca4b424311797a86bd745a735 Reviewed-by: Andy Nichols <andy.nichols@qt.io>
* more API docsLaszlo Agocs2018-05-141-0/+73
Also pull in the property name table (the up-to-dateness of which is questionable). The version number in the generated docs should be 2.0, not the Qt version. Will need to figure out later how to maintain this. Not everything is documented yet. Less important functions will get covered later. Many bits here and there are revised compared to the 1.1 docs. There are however chunks that have been taken as-is. These need to be cleaned up later on. Most importantly, an initial Getting Started page has been added. This, like the mobile/embedded page needs to be extended signficiantly later on. A set of unused constructors (the ones taking no presentation) are removed from Q3DSElement/SceneElement/DataInput. This is because the QML API does not use them while it is impossible to utilize these in a meaningful way from C++ (where are require setting the presentation up-front with no setter afterwards). There were a few qdoc warnings from the internal implementations due to useless /*! or backslashes that confused qdoc. These are removed. Task-number: QT3DS-1606 Change-Id: I141bdc774e5be3e4fed5c1d729cac9b68a02be3b Reviewed-by: Andy Nichols <andy.nichols@qt.io>