diff options
author | Martin Smith <martin.smith@qt.io> | 2017-03-30 12:54:48 +0200 |
---|---|---|
committer | Martin Smith <martin.smith@qt.io> | 2017-03-31 11:29:44 +0000 |
commit | 6505062f58f6fe508267cc9fad7d0f87cc01847d (patch) | |
tree | 6a4b7ac376c23d605210115cc43bbc58d340d549 /src/gui/vulkan/qvulkaninstance.cpp | |
parent | 28d286dc96f4628aa5bba5631ce563cb979b1bfb (diff) |
doc: Fix several qdoc warnings in new software
This change fixes several common qdoc warnings in this new software.
However, because vulkan/vulkan.h is not always available, a few typedefs
were also added to define some standard vulkan types for clang to see
when vulkan.h is not available.
Change-Id: Id3db8c0a59b0c415829c1873a868aba0e84fe21c
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
Diffstat (limited to 'src/gui/vulkan/qvulkaninstance.cpp')
-rw-r--r-- | src/gui/vulkan/qvulkaninstance.cpp | 30 |
1 files changed, 22 insertions, 8 deletions
diff --git a/src/gui/vulkan/qvulkaninstance.cpp b/src/gui/vulkan/qvulkaninstance.cpp index 89ca3de3f9..f6137a3664 100644 --- a/src/gui/vulkan/qvulkaninstance.cpp +++ b/src/gui/vulkan/qvulkaninstance.cpp @@ -403,48 +403,62 @@ QVulkanInstance::~QVulkanInstance() } /*! - \struct QVulkanLayer + \class QVulkanLayer \brief Represents information about a Vulkan layer. */ /*! - \value QVulkanLayer::name + \variable QVulkanLayer::name \brief The name of the layer. */ /*! - \value QVulkanLayer::version + \variable QVulkanLayer::version \brief The version of the layer. This is an integer, increasing with each backward compatible change. */ /*! - \value QVulkanLayer::specVersion + \variable QVulkanLayer::specVersion \brief The Vulkan version the layer was written against. */ /*! - \value QVulkanLayer::description + \variable QVulkanLayer::description \brief The description of the layer. */ /*! - \struct QVulkanExtension + \fn bool QVulkanLayer::operator==(const QVulkanLayer &other) const + + Returns true if this vulkan layer and the \a other vulkan layer have + the same name, version, and spec version. + */ + +/*! + \class QVulkanExtension \brief Represents information about a Vulkan extension. */ /*! - \value QVulkanExtension::name + \variable QVulkanExtension::name \brief The name of the extension. */ /*! - \value QVulkanExtension::version + \variable QVulkanExtension::version \brief The version of the extension. This is an integer, increasing with each backward compatible change. */ /*! + \fn bool QVulkanExtension::operator==(const QVulkanExtension &other) const + + Returns true if the name and version of this vulkan extension are the same + as the name and version of the \a other vulkan extension. + */ + +/*! \class QVulkanInfoVector \brief A specialized QVector for QVulkanLayer and QVulkanExtension. */ |