diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2017-02-17 16:30:02 +0100 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2017-02-23 09:47:09 +0000 |
commit | 2c6b1bb0ab189a6cf1d655204b1ea88da916a573 (patch) | |
tree | 5b4bb6a638a49d50ce03c90617cb495b11e6ba47 /src | |
parent | e707a3396493aa6a18e6acfd7c24988cdd9c5189 (diff) |
Doc: Add \brief commands for property docs (QHeightMapSurfaceDataProxy)
Separate setter function docs to from property docs, to be able
to describe the arguments for the setter functions.
Change-Id: I60bd1a31cd1424260070c231af48c9603916d132
Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Diffstat (limited to 'src')
-rw-r--r-- | src/datavisualization/data/qheightmapsurfacedataproxy.cpp | 43 |
1 files changed, 33 insertions, 10 deletions
diff --git a/src/datavisualization/data/qheightmapsurfacedataproxy.cpp b/src/datavisualization/data/qheightmapsurfacedataproxy.cpp index 8d8142aa..1d762f88 100644 --- a/src/datavisualization/data/qheightmapsurfacedataproxy.cpp +++ b/src/datavisualization/data/qheightmapsurfacedataproxy.cpp @@ -76,7 +76,9 @@ const float defaultMaxValue = 10.0f; * with height map data. * * There are several formats the image file can be given in, but if it is not in a directly usable - * format, a conversion is made. \note If the result seems wrong, the automatic conversion failed + * format, a conversion is made. + * + * \note If the result seems wrong, the automatic conversion failed * and you should try converting the image yourself before setting it. Preferred format is * QImage::Format_RGB32 in grayscale. * @@ -175,11 +177,16 @@ QHeightMapSurfaceDataProxy::~QHeightMapSurfaceDataProxy() /*! * \property QHeightMapSurfaceDataProxy::heightMap * - * A height map \a image to be visualized. Setting this property replaces current data with height - * map data. + * \brief The height map image to be visualized. + */ + +/*! + * Replaces current data with the height map data specified by \a image. * * There are several formats the \a image can be given in, but if it is not in a directly usable - * format, a conversion is made. \note If the result seems wrong, the automatic conversion failed + * format, a conversion is made. + * + * \note If the result seems wrong, the automatic conversion failed * and you should try converting the \a image yourself before setting it. Preferred format is * QImage::Format_RGB32 in grayscale. * @@ -209,8 +216,12 @@ QImage QHeightMapSurfaceDataProxy::heightMap() const /*! * \property QHeightMapSurfaceDataProxy::heightMapFile * - * A file with a height map image to be visualized. Setting this property replaces current data - * with height map data. + * \brief The name of the file with a height map image to be visualized. + */ + +/*! + * Replaces current data with height map data from the file specified by + * \a filename. * * \sa heightMap */ @@ -239,7 +250,10 @@ void QHeightMapSurfaceDataProxy::setValueRanges(float minX, float maxX, float mi /*! * \property QHeightMapSurfaceDataProxy::minXValue * - * The minimum X value for the generated surface points. Defaults to \c{0.0}. + * \brief The minimum X value for the generated surface points. + * + * Defaults to \c{0.0}. + * * When setting this property the corresponding maximum value is adjusted if necessary, * to ensure that the range remains valid. */ @@ -256,7 +270,10 @@ float QHeightMapSurfaceDataProxy::minXValue() const /*! * \property QHeightMapSurfaceDataProxy::maxXValue * - * The maximum X value for the generated surface points. Defaults to \c{10.0}. + * \brief The maximum X value for the generated surface points. + * + * Defaults to \c{10.0}. + * * When setting this property the corresponding minimum value is adjusted if necessary, * to ensure that the range remains valid. */ @@ -273,7 +290,10 @@ float QHeightMapSurfaceDataProxy::maxXValue() const /*! * \property QHeightMapSurfaceDataProxy::minZValue * - * The minimum Z value for the generated surface points. Defaults to \c{0.0}. + * \brief The minimum Z value for the generated surface points. + * + * Defaults to \c{0.0}. + * * When setting this property the corresponding maximum value is adjusted if necessary, * to ensure that the range remains valid. */ @@ -290,7 +310,10 @@ float QHeightMapSurfaceDataProxy::minZValue() const /*! * \property QHeightMapSurfaceDataProxy::maxZValue * - * The maximum Z value for the generated surface points. Defaults to \c{10.0}. + * \brief The maximum Z value for the generated surface points. + * + * Defaults to \c{10.0}. + * * When setting this property the corresponding minimum value is adjusted if necessary, * to ensure that the range remains valid. */ |