Uploaded image for project: 'Qt 3D Studio'
  1. Qt 3D Studio
  2. QT3DS-4050

Documentation warnings

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: P2: Important
    • Resolution: Fixed
    • Affects Version/s: Qt 3D Studio 2.6
    • Fix Version/s: Qt 3D Studio 2.7
    • Component/s: Documentation
    • Labels:
      None
    • Commits:
      8b9521e38bcb7419aefa97689fdb172718823d16, cf47221dbd7ea2d0c3aeae3a3e5c8ea51ee9cfb6

      Description

      2.6 documentation produces the following warnings:

      /tmp/snapshot-qt3dstudio/qt3dstudio/doc/qt3dstudio-project.qdocconf:11: (qdoc) warning: Cannot find file or directory: ../src/Viewer
      /tmp/snapshot-qt3dstudio/qt3dstudio/doc/qt3dstudio-project.qdocconf:8: (qdoc) warning: Cannot find file or directory: ../src/Viewer
      /tmp/snapshot-qt3dstudio/qt3dstudio/doc/src/glossary.qdoc:28: (qdoc) warning: Can't link to 'Animations#Interpolation'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dsdatainput.cpp:115: (qdoc) warning: Unknown command '\dontdocument'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dsdatainput.cpp:114: (qdoc) warning: Cannot tie this documentation to anything [qdoc found a /*! ... */ comment, but there was no topic command (e.g., '\fn', '\page') in the comment and no function definition following the comment.]
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dsdatainput.cpp:412: (qdoc) warning: QML property documented multiple times: 'string DataInput::name'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dsdatainput.cpp:420: (qdoc) warning: QML property documented multiple times: 'variant DataInput::value'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dsdatainput.h:51: (qdoc) warning: No documentation for 'Q3DSDataInput::metadataKeys'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dsgeometry.cpp:289: (qdoc) warning: Undocumented parameter 'att' in Q3DSGeometry::addAttribute()
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dspresentation.cpp:734: (qdoc) warning: Undocumented parameter 'shaderCache' in Q3DSPresentation::setShaderCacheData()
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dssurfaceviewer.h:54: (qdoc) warning: No documentation for 'Q3DSSurfaceViewer::error'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dssurfaceviewer.cpp:99: (qdoc) warning: Undocumented parameter 'parent' in Q3DSSurfaceViewer::Q3DSSurfaceViewer()
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dssurfaceviewer.h:103: (qdoc) warning: No documentation for 'Q3DSSurfaceViewer::afterRendering()'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dsviewersettings.h:57: (qdoc) warning: No documentation for 'Q3DSViewerSettings::ShadeMode'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dsviewersettings.h:68: (qdoc) warning: No documentation for 'Q3DSViewerSettings::StereoMode'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dsviewersettings.h:103: (qdoc) warning: No documentation for 'Q3DSViewerSettings::shadeModeChanged(Q3DSViewerSettings::ShadeMode mode)'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/doc/src/examples.qdoc:28: (qdoc) warning: Can't link to 'Qt 3D Studio Runtime: Dynamic Loading Example'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dspresentation.cpp:1217: (qdoc) warning: Can't link to 'createElement()'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dspresentation.cpp:1217: (qdoc) warning: Can't link to 'createElements()'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dspresentation.cpp:1354: (qdoc) warning: Can't link to 'createMaterial()'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dspresentation.cpp:1354: (qdoc) warning: Can't link to 'createMaterials()'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dspresentation.cpp:1469: (qdoc) warning: Can't link to 'createMesh()'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dspresentation.cpp:1469: (qdoc) warning: Can't link to 'createMeshes()'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dspresentation.cpp:1685: (qdoc) warning: Can't link to 'createElement()'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dspresentation.cpp:1685: (qdoc) warning: Can't link to 'createElements()'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dspresentation.cpp:1709: (qdoc) warning: Can't link to 'createMaterial()'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dspresentation.cpp:1709: (qdoc) warning: Can't link to 'createMaterials()'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dspresentation.cpp:1736: (qdoc) warning: Can't link to 'createMesh()'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/api/studio3d/q3dspresentation.cpp:1736: (qdoc) warning: Can't link to 'createMeshes()'
      /tmp/snapshot-qt3dstudio/qt3dstudio/src/Runtime/ogl-runtime/src/qmlstreamer/q3dsqmlstream.cpp:32: (qdoc) warning: Can't link to 'SubPresentation' 

        Attachments

          Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

            Activity

              People

              Assignee:
              jakangas Janne Kangas
              Reporter:
              tokorpip Tomi Korpipää
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Gerrit Reviews

                  There are no open Gerrit changes