Minor improvements to the API documentation

This commit is contained in:
Laurent Gomila 2011-12-28 22:36:09 +01:00
parent aa633f6f12
commit 8de7fca241
5 changed files with 21 additions and 6 deletions

View file

@ -80,7 +80,9 @@ public :
////////////////////////////////////////////////////////////
/// \brief Get a point of the shape
///
/// \param index Index of the point to get
/// The result is undefined if \a index is out of the valid range.
///
/// \param index Index of the point to get, in range [0 .. GetPointCount() - 1]
///
/// \return Index-th point of the shape
///