Details
-
Task
-
Resolution: Done
-
P1: Critical
-
None
Description
Add documentation structure and qdoc comments for \class,
\qmltype, \property, and \qmlproperty, etc, for the Qt3DRender
C++ and QML modules.
The actual documentation (descriptions) are still missing, but this
allows the QML type documentation to be generated and reduces the
qdoc error count.
Attachments
| For Gerrit Dashboard: QTBUG-46037 | ||||||
|---|---|---|---|---|---|---|
| # | Subject | Branch | Project | Status | CR | V |
| 112080,7 | Doc: Add Qt3D QML and C++ skeleton comments for qdoc | 5.5 | qt/qt3d | Status: MERGED | +2 | 0 |
| 146480,3 | Fixed some documentation warnings | 5.6 | qt/qt3d | Status: MERGED | +2 | 0 |
| 146633,2 | Added skeleton docs to geometry classes | 5.6 | qt/qt3d | Status: MERGED | +2 | 0 |
| 159631,5 | Adding QDoc to QConeGeometry | 5.7 | qt/qt3d | Status: ABANDONED | -2 | 0 |
| 159710,3 | Adding QDoc to QAlphaTest | 5.7 | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 159735,4 | Adding QDoc to QBlendEquation | 5.7 | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 159754,3 | Adding QDoc to QCullFace | 5.7 | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 159760,2 | Adding QDoc to QDepthTest | 5.7 | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 159764,2 | Adding QDoc to QFrontFace | 5.7 | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 159767,2 | Adding QDoc to QPolygonOffset | 5.7 | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 159797,2 | Adding QDoc to QScissorTest | 5.7 | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 159816,2 | Adding QDoc to QStencilMask | 5.7 | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 159824,2 | Adding QDoc to QStencilOperation | 5.7 | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 159830,3 | Adding QDoc to QStencilOperationArguments | 5.7 | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 159985,5 | Adding QDoc to QAlphaCoverage | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 159987,5 | Adding QDoc to QDithering | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 159993,4 | Adding QDoc to QMultiSampleAntiAliasing | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160006,3 | Adding QDoc to QNoDepthMask | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160018,4 | Adding QDoc to QStencilTest | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160019,7 | Adding QDoc to QStencilTestArguments | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160061,7 | added skeleton doc to logic module | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160062,4 | doc for qtextureimagedata | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160072,4 | Start on skeleton doc for render-framegraph | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160102,3 | Adding QDoc to QAbstractTexture | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160103,3 | Adding QDoc to QAbstractTextureImage | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160104,3 | Adding QDoc to QTexture | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160105,15 | Adding QDoc to QTextureData | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160106,5 | Adding QDoc to QTextureImage | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160107,6 | Adding QDoc to QTextureImageData | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160109,9 | The rest of the doc for render-framegraph | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160112,2 | Skeletal Doc for QSceneLoader | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160179,10 | Adding QDoc to QCamera | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160180,6 | Adding QDoc to QComputeCommand | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160181,6 | Adding QDoc to QPickingSettings | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160182,6 | Adding QDoc to QRenderAspect | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160183,6 | Adding QDoc to QRenderSettings | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160184,6 | Adding QDoc to QRenderTarget | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160185,6 | Adding QDoc to QRenderTargetOutput | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160197,10 | Skeletal Doc for render-lights | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160198,7 | Start of Skeletal Doc for render-materialsystem | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160232,9 | The rest of skeletal doc for render-materialsystem | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160256,9 | Skeletal Doc for render-picking | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160266,9 | Transfer previously written doc for input module | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160336,4 | Added breif to QSceneLoader Doc | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160361,3 | Missing Signal Doc for QFrameAction | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160368,8 | More doc for render-framegraph | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160377,6 | More doc for render-materialsystem | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160386,6 | More doc for render-picking | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160401,3 | Documentation for render-geometry | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160499,6 | More doc for input Module | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 160560,4 | Doc for core module | 5.7.0 | qt/qt3d | Status: MERGED | +2 | 0 |
| 163152,1 | Skeletal Doc for render-picking | dev | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 163153,1 | More doc for render-picking | dev | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 163154,1 | Transfer previously written doc for input module | dev | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 163155,1 | More doc for input Module | dev | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 163156,1 | The rest of the doc for render-framegraph | dev | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 163157,1 | Doc for core module | dev | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 163158,1 | The rest of skeletal doc for render-materialsystem | dev | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 163159,1 | More doc for render-materialsystem | dev | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 163160,1 | Adding QDoc to QStencilTestArguments | dev | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 163162,1 | More doc for render-framegraph | dev | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 163164,1 | Adding QDoc to QCamera | dev | qt/qt3d | Status: ABANDONED | 0 | 0 |
| 163165,1 | Adding QDoc to QTextureData | dev | qt/qt3d | Status: ABANDONED | 0 | 0 |