diff --git a/src/Magnum/Shapes/AbstractShape.h b/src/Magnum/Shapes/AbstractShape.h index 50c1c5303..e8cb510ef 100644 --- a/src/Magnum/Shapes/AbstractShape.h +++ b/src/Magnum/Shapes/AbstractShape.h @@ -58,7 +58,7 @@ template class MAGNUM_SHAPES_EXPORT AbstractShape: publi Dimensions = dimensions /**< Dimension count */ }; - /** @brief Shape type */ + /** @brief %Shape type */ #ifdef DOXYGEN_GENERATING_OUTPUT enum class Type { Point, /**< Point */ @@ -83,14 +83,14 @@ template class MAGNUM_SHAPES_EXPORT AbstractShape: publi explicit AbstractShape(SceneGraph::AbstractObject& object, ShapeGroup* group = nullptr); /** - * @brief Shape group containing this shape + * @brief %Shape group containing this shape * * If the shape doesn't belong to any group, returns `nullptr`. */ ShapeGroup* group(); const ShapeGroup* group() const; /**< @overload */ - /** @brief Shape type */ + /** @brief %Shape type */ Type type() const; /** @@ -101,7 +101,7 @@ template class MAGNUM_SHAPES_EXPORT AbstractShape: publi bool collides(const AbstractShape& other) const; /** - * @brief Collision with other shape + * @brief %Collision with other shape * * Default implementation returns empty collision. */ diff --git a/src/Magnum/Shapes/Collision.h b/src/Magnum/Shapes/Collision.h index 74f2f9d88..cba6175be 100644 --- a/src/Magnum/Shapes/Collision.h +++ b/src/Magnum/Shapes/Collision.h @@ -98,6 +98,7 @@ template class Collision { * @brief Separation distance * * @see @ref separationNormal(), operator bool() + * @todoc explicit reference when Doxygen can do it for operator bool */ Float separationDistance() const { return _separationDistance; diff --git a/src/Magnum/Shapes/Composition.h b/src/Magnum/Shapes/Composition.h index a81fa02ad..c22de86fc 100644 --- a/src/Magnum/Shapes/Composition.h +++ b/src/Magnum/Shapes/Composition.h @@ -52,7 +52,7 @@ namespace Implementation { } } -/** @brief Shape operation */ +/** @brief %Shape operation */ enum class CompositionOperation: UnsignedByte { Not, /**< Boolean NOT */ And, /**< Boolean AND */ @@ -60,7 +60,7 @@ enum class CompositionOperation: UnsignedByte { }; /** -@brief Composition of shapes +@brief %Composition of shapes Result of logical operations on shapes. See @ref shapes for brief introduction. */ @@ -74,7 +74,7 @@ template class MAGNUM_SHAPES_EXPORT Composition { Dimensions = dimensions /**< Dimension count */ }; - /** @brief Shape type */ + /** @brief %Shape type */ #ifdef DOXYGEN_GENERATING_OUTPUT enum class Type { Point, /**< Point */ @@ -137,10 +137,10 @@ template class MAGNUM_SHAPES_EXPORT Composition { /** @brief Type of shape at given position */ Type type(std::size_t i) const { return _shapes[i]->type(); } - /** @brief Shape at given position */ + /** @brief %Shape at given position */ template const T& get(std::size_t i) const; - /** @brief Collision with another shape */ + /** @brief %Collision with another shape */ #ifdef DOXYGEN_GENERATING_OUTPUT template bool operator%(const T& other) const { #else @@ -194,12 +194,12 @@ typedef Composition<2> Composition2D; typedef Composition<3> Composition3D; #ifdef DOXYGEN_GENERATING_OUTPUT -/** @debugoperator{Magnum::Shapes::Composition} */ +/** @debugoperatorclassenum{Magnum::Shapes::Composition,Magnum::Shapes::Composition::Type} */ template Debug operator<<(Debug debug, typename Composition::Type value); #endif /** @relates Composition -@brief Collision of shape with @ref Composition +@brief %Collision occurence of shape with %Composition */ #ifdef DOXYGEN_GENERATING_OUTPUT template inline bool operator%(const T& a, const Composition& b) { diff --git a/src/Magnum/Shapes/Line.h b/src/Magnum/Shapes/Line.h index 553beec0c..b000a14d5 100644 --- a/src/Magnum/Shapes/Line.h +++ b/src/Magnum/Shapes/Line.h @@ -40,7 +40,7 @@ namespace Magnum { namespace Shapes { See @ref shapes for brief introduction. @see @ref Line2D, @ref Line3D -@todo collision detection of two @ref Line2D +@todo collision detection of two Line2D */ template class MAGNUM_SHAPES_EXPORT Line { public: diff --git a/src/Magnum/Shapes/Shape.h b/src/Magnum/Shapes/Shape.h index dafa95226..bf86ee497 100644 --- a/src/Magnum/Shapes/Shape.h +++ b/src/Magnum/Shapes/Shape.h @@ -73,7 +73,7 @@ template class Shape: public AbstractShape { /** * @brief Constructor * @param object Object holding this feature - * @param shape Shape + * @param shape %Shape * @param group Group this shape belongs to */ explicit Shape(SceneGraph::AbstractObject& object, const T& shape, ShapeGroup* group = nullptr): AbstractShape(object, group) {