diff options
author | Topi Reinio <topi.reinio@digia.com> | 2015-04-13 12:55:34 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@digia.com> | 2015-04-14 07:41:11 +0000 |
commit | f03dc3a2599a0f05cded8b984489b89113c7f037 (patch) | |
tree | 306902e9865550448dcf035ffa18c0be45834e62 /src/render/frontend/qtextureimage.cpp | |
parent | 075c0298d1c75dd2d61849b559edcb357d638689 (diff) |
Doc: Fix multiple C++ documentation issues
- Remove multiple \namespace commands for namespace Qt3D. QDoc in 5.5
is now able to collate namespace members from multiple modules.
- Mark 'Q...Private' classes and functions taking private arguments as
\internal
- Use correct \qtvariable for Qt 3D Core and Render
- Add src/plugins directory to Qt 3D Core documentation build to
correctly generate Assimp-related documentation.
- Ensure documentation for C++ properties is visible by
using the \property command instead of documenting the
setter/getter functions.
- Add export and logging macros to qdoc ignore directives
- Remove unnecessary use of \fn command
- Language and styling fixes
Change-Id: I2481fa30ad2f6869b85c038c20ff1730b8522d46
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
Diffstat (limited to 'src/render/frontend/qtextureimage.cpp')
-rw-r--r-- | src/render/frontend/qtextureimage.cpp | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/render/frontend/qtextureimage.cpp b/src/render/frontend/qtextureimage.cpp index 92b69797f..6a46f8b68 100644 --- a/src/render/frontend/qtextureimage.cpp +++ b/src/render/frontend/qtextureimage.cpp @@ -114,7 +114,7 @@ QTextureImage::~QTextureImage() } /*! - \return the source url from which data will be loaded of the texture image. + Returns the source url from which data for the texture image will be loaded. */ QUrl QTextureImage::source() const { @@ -124,7 +124,7 @@ QUrl QTextureImage::source() const /*! Sets the source url of the texture image to \a source. - \note: this triggers a call to update() + \note This triggers a call to update() */ void QTextureImage::setSource(const QUrl &source) { @@ -137,7 +137,7 @@ void QTextureImage::setSource(const QUrl &source) } /*! - \returns the a Qt3D::QTextureDataFunctorPtr functor to be used by the + Returns the Qt3D::QTextureDataFunctorPtr functor to be used by the backend to load the texture image data into an OpenGL texture object. */ QTextureDataFunctorPtr QTextureImage::dataFunctor() const |