From f41df6552b8717f340c5b8ce4fea1923d317bd06 Mon Sep 17 00:00:00 2001 From: Nate Koenig Date: Mon, 8 Feb 2021 16:58:26 -0800 Subject: [PATCH] added documentation Signed-off-by: Nate Koenig --- include/ignition/rendering/GpuRays.hh | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/include/ignition/rendering/GpuRays.hh b/include/ignition/rendering/GpuRays.hh index df1fd1d94..de435d72a 100644 --- a/include/ignition/rendering/GpuRays.hh +++ b/include/ignition/rendering/GpuRays.hh @@ -159,24 +159,36 @@ namespace ignition /// \return Channel count. public: virtual unsigned int Channels() const = 0; - /// \brief Set the horizontal resolution. + /// \brief Set the horizontal resolution. This number is multiplied by + /// RayCount to calculate RangeCount, which is the the number range data + /// points. + /// \sa RayCount() /// \param[in] _resolution The new horizontal resolution. The /// absolute value of this parameter is used to prevent a /// negative resolution value. public: virtual void SetHorizontalResolution(double _resolution) = 0; - /// \brief Get the horizontal resolution. + /// \brief Get the horizontal resolution. This number is multiplied by + /// RayCount to calculate RangeCount, which is the the number range data + /// points. + /// \sa RayCount() /// \return The horizontal resolution public: virtual double HorizontalResolution() const = 0; - /// \brief Set the vertical resolution. + /// \brief Set the vertical resolution. This number is multiplied by + /// VerticalRayCount to calculate VerticalRangeCount, which is the the + /// number vertical range data points. /// \param[in] _resolution The new vertical resolution. The /// absolute value of this parameter is used to prevent a /// negative resolution value. + /// \sa VerticalRayCount() public: virtual void SetVerticalResolution(double _resolution) = 0; - /// \brief Get the vertical resolution. - /// \return The vertical resolution + /// \brief Get the vertical resolution. This number is multiplied by + /// VerticalRayCount to calculate VerticalRangeCount, which is the the + /// number vertical range data points. + /// \return The vertical resolution. + /// \sa VerticalRayCount() public: virtual double VerticalResolution() const = 0; }; }