diff options
author | Topi Reinio <topi.reinio@qt.io> | 2016-12-07 14:53:23 +0100 |
---|---|---|
committer | Sean Harmer <sean.harmer@kdab.com> | 2016-12-07 14:07:55 +0000 |
commit | f8ba0ee64abe614780324711c8b0b7274d38eb0a (patch) | |
tree | 87782731bd295677624bd9d4f12adb13dd66872f /src/render/framegraph | |
parent | 8e998d710844fe0fe1ce7e1c22e56f065d0f8b4d (diff) |
Doc: Specify #include path for each \class
QDoc tries to guess the correct #include statement, displayed in
the requisites table in the class reference. However, this often
produces incorrect information for a module as complex as Qt3D.
To fix this, manually specify the include path with the \inheaderfile
command.
Change-Id: I42929b92600d07d759f4f76e9051ff656785c652
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
Diffstat (limited to 'src/render/framegraph')
-rw-r--r-- | src/render/framegraph/qrendercapture.cpp | 2 | ||||
-rw-r--r-- | src/render/framegraph/qrenderstateset.cpp | 1 |
2 files changed, 3 insertions, 0 deletions
diff --git a/src/render/framegraph/qrendercapture.cpp b/src/render/framegraph/qrendercapture.cpp index c4a42ff8a..62164b3ce 100644 --- a/src/render/framegraph/qrendercapture.cpp +++ b/src/render/framegraph/qrendercapture.cpp @@ -45,6 +45,7 @@ namespace Qt3DRender { /*! * \class Qt3DRender::QRenderCapture + * \inheaderfile Qt3DRender/QRenderCapture * \inmodule Qt3DRender * * \brief Frame graph node for render capture @@ -68,6 +69,7 @@ namespace Qt3DRender { /*! * \class Qt3DRender::QRenderCaptureReply + * \inheaderfile Qt3DRender/QRenderCaptureReply * \inmodule Qt3DRender * * \brief Receives the result of render capture request. diff --git a/src/render/framegraph/qrenderstateset.cpp b/src/render/framegraph/qrenderstateset.cpp index 845fb5d91..35ac7fd04 100644 --- a/src/render/framegraph/qrenderstateset.cpp +++ b/src/render/framegraph/qrenderstateset.cpp @@ -58,6 +58,7 @@ QRenderStateSetPrivate::QRenderStateSetPrivate() /*! * \class Qt3DRender::QRenderStateSet + * \inheaderfile Qt3DRender/QRenderStateSet * \inmodule Qt3DRender * * \brief The QRenderStateSet \l {QFrameGraphNode}{FrameGraph} node offers a way of |