Browse Source

Doc++

pull/279/head
Vladimír Vondruš 14 years ago
parent
commit
db105839c5
  1. 2
      src/BufferedImage.h
  2. 2
      src/Image.h
  3. 2
      src/SceneGraph/Camera.h
  4. 2
      src/SceneGraph/Object.h
  5. 4
      src/SceneGraph/Scene.h
  6. 6
      src/Swizzle.h
  7. 2
      src/Texture.h

2
src/BufferedImage.h

@ -16,7 +16,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::BufferedImage * @brief Class Magnum::BufferedImage, typedef Magnum::BufferedImage1D, Magnum::BufferedImage2D, Magnum::BufferedImage3D
*/ */
#include "AbstractImage.h" #include "AbstractImage.h"

2
src/Image.h

@ -16,7 +16,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::Image * @brief Class Magnum::Image, typedef Magnum::Image1D, Magnum::Image2D, Magnum::Image3D
*/ */
#include "AbstractImage.h" #include "AbstractImage.h"

2
src/SceneGraph/Camera.h

@ -16,7 +16,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::SceneGraph::Camera * @brief Class Magnum::SceneGraph::Camera, Magnum::SceneGraph::Camera2D, Magnum::SceneGraph::Camera3D
*/ */
#include "Object.h" #include "Object.h"

2
src/SceneGraph/Object.h

@ -16,7 +16,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::SceneGraph::Object * @brief Class Magnum::SceneGraph::Object, Magnum::SceneGraph::Object2D, Magnum::SceneGraph::Object3D
*/ */
#include <Containers/LinkedList.h> #include <Containers/LinkedList.h>

4
src/SceneGraph/Scene.h

@ -16,7 +16,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::SceneGraph::Scene * @brief Class Magnum::SceneGraph::Scene, typedef Magnum::SceneGraph::Scene2D, Magnum::SceneGraph::Scene3D
*/ */
#include "Object.h" #include "Object.h"
@ -26,8 +26,10 @@ namespace Magnum { namespace SceneGraph {
/** @brief %Scene */ /** @brief %Scene */
template<class MatrixType, class VectorType, class ObjectType, class CameraType> class SCENEGRAPH_EXPORT Scene: public ObjectType { template<class MatrixType, class VectorType, class ObjectType, class CameraType> class SCENEGRAPH_EXPORT Scene: public ObjectType {
public: public:
/** @copydoc Object::isScene() */
inline bool isScene() const { return true; } inline bool isScene() const { return true; }
/** @todo Some deleted functions belong only to Scene2D, some only to Scene3D - what to do? */
#ifndef DOXYGEN_GENERATING_OUTPUT #ifndef DOXYGEN_GENERATING_OUTPUT
void setParent(ObjectType* parent) = delete; void setParent(ObjectType* parent) = delete;
void setTransformation(const MatrixType& transformation) = delete; void setTransformation(const MatrixType& transformation) = delete;

6
src/Swizzle.h

@ -16,7 +16,7 @@
*/ */
/** @file /** @file
* @brief Function Magnum::Math::swizzle() * @brief Functions Magnum::swizzle(const T&), Magnum::swizzle(const T&, const char(&)[])
*/ */
#include "Color.h" #include "Color.h"
@ -93,7 +93,7 @@ two, three or four-component, corresponding Vector2, Vector3 or Vector4
specialization is returned. specialization is returned.
@attention This function is less convenient to write than @attention This function is less convenient to write than
swizzle(const Vector<size, T>&, const char(&)[newSize]), but the evaluation of swizzle(const T&, const char(&)[newSize]), but the evaluation of
the swizzling operation is guaranteed to be always done at compile time the swizzling operation is guaranteed to be always done at compile time
instead of at runtime. instead of at runtime.
@ -119,7 +119,7 @@ two, three or four-component, corresponding Vector2, Vector3 or Vector4
specialization is returned. specialization is returned.
@attention This function is more convenient to write than @attention This function is more convenient to write than
swizzle(const Vector<size, T>&), but unless the result is marked with swizzle(const T&), but unless the result is marked with
`constexpr`, the evaluation of the swizzling operation probably won't be `constexpr`, the evaluation of the swizzling operation probably won't be
evaluated at compile time, but at runtime. evaluated at compile time, but at runtime.

2
src/Texture.h

@ -16,7 +16,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::Texture * @brief Class Magnum::Texture, typedef Magnum::Texture1D, Magnum::Texture2D, Magnum::Texture3D
*/ */
#include "AbstractTexture.h" #include "AbstractTexture.h"

Loading…
Cancel
Save