Browse Source

Doc++

Fixed mainly unwanted Doxygen autolinks.
vectorfields
Vladimír Vondruš 14 years ago
parent
commit
aedc90e712
  1. 2
      src/BufferedImage.h
  2. 4
      src/Math/Matrix.h
  3. 6
      src/Math/Vector.h
  4. 4
      src/Mesh.h
  5. 2
      src/Object.h
  6. 20
      src/Shader.h
  7. 51
      src/Trade/AbstractImporter.h
  8. 2
      src/Trade/AbstractMaterialData.h
  9. 2
      src/Trade/CameraData.h
  10. 2
      src/Trade/ImageData.h
  11. 2
      src/Trade/LightData.h
  12. 2
      src/Trade/MeshData.h
  13. 2
      src/Trade/ObjectData.h
  14. 2
      src/Trade/PhongMaterialData.h
  15. 2
      src/Trade/SceneData.h
  16. 2
      src/Trade/TextureData.h

2
src/BufferedImage.h

@ -75,7 +75,7 @@ template<size_t imageDimensions> class BufferedImage {
/**
* @brief Data
*
* Binds the buffer to @ref Buffer::Target::PixelUnpack "pixel unpack
* Binds the buffer to @ref Buffer::Target "pixel unpack
* target" and returns nullptr, so it can be used for texture updating
* functions the same way as Image::data().
*/

4
src/Math/Matrix.h

@ -80,7 +80,7 @@ template<class T, size_t size> class Matrix {
return _data[col*size+row];
}
/** @brief Matrix column */
/** @brief %Matrix column */
inline Vector<T, size> at(size_t col) const {
return _data+col*size;
}
@ -153,7 +153,7 @@ template<class T, size_t size> class Matrix {
return out;
}
/** @brief Matrix without given row and column */
/** @brief %Matrix without given row and column */
Matrix<T, size-1> ij(size_t skipRow, size_t skipCol) const {
Matrix<T, size-1> out(false);

6
src/Math/Vector.h

@ -30,8 +30,8 @@ namespace Magnum { namespace Math {
/** @brief %Vector */
template<class T, size_t size> class Vector {
public:
typedef T Type; /**< @brief Vector data type */
const static size_t Size = size; /**< @brief Vector size */
typedef T Type; /**< @brief %Vector data type */
const static size_t Size = size; /**< @brief %Vector size */
/** @brief Angle between vectors */
inline static T angle(const Vector<T, size>& a, const Vector<T, size>& b) {
@ -162,7 +162,7 @@ template<class T, size_t size> class Vector {
return out;
}
/** @brief Vector length */
/** @brief %Vector length */
inline T length() const {
return sqrt(operator*(*this));
}

4
src/Mesh.h

@ -186,9 +186,9 @@ class MAGNUM_EXPORT Mesh {
protected:
/** @brief Vertex attribute */
struct Attribute {
GLuint attribute; /**< @brief Attribute ID */
GLuint attribute; /**< @brief %Attribute ID */
GLint size; /**< @brief How many items of @c type are in the attribute */
Type type; /**< @brief Attribute item type */
Type type; /**< @brief %Attribute item type */
GLsizei stride; /**< @brief Distance of two adjacent attributes of this type in interleaved buffer */
const GLvoid* pointer; /**< @brief Pointer to first attribute of this type in the buffer */
};

2
src/Object.h

@ -62,7 +62,7 @@ class MAGNUM_EXPORT Object {
virtual ~Object();
/**
* @brief Scene
* @brief %Scene
* @return If the object is not assigned to any scene, returns nullptr.
*/
Scene* scene() const;

20
src/Shader.h

@ -40,24 +40,24 @@ class MAGNUM_EXPORT Shader {
Shader& operator=(Shader&& other) = delete;
public:
/** @brief Shader type */
/** @brief %Shader type */
enum Type {
Vertex = GL_VERTEX_SHADER, /**< @brief Vertex shader */
Geometry = GL_GEOMETRY_SHADER, /**< @brief Geometry shader */
Fragment = GL_FRAGMENT_SHADER /**< @brief Fragment shader */
};
/** @brief Shader state */
/** @brief %Shader state */
enum State {
Initialized, /**< @brief Shader sloaded */
Compiled, /**< @brief Shader is compiled */
Initialized, /**< @brief %Shader is loaded */
Compiled, /**< @brief %Shader is compiled */
Failed /**< @brief Compilation failed */
};
/**
* @brief Load shader from source
* @param type Shader type
* @param source Shader source
* @param type %Shader type
* @param source %Shader source
* @return Pointer to compiled shader
*
* Loads the shader from one source. Shorthand for
@ -76,8 +76,8 @@ class MAGNUM_EXPORT Shader {
/**
* @brief Load shader from file
* @param type Shader type
* @param filename Source filename
* @param type %Shader type
* @param filename %Source filename
* @return Pointer to compiled shader or zero, if file cannot be opened.
*
* Loads the shader from from one file. Shorthand for
@ -114,7 +114,7 @@ class MAGNUM_EXPORT Shader {
inline ~Shader() { if(shader) glDeleteShader(shader); }
/**
* @brief Shader type
* @brief %Shader type
*
* Set in constructor.
*/
@ -157,7 +157,7 @@ class MAGNUM_EXPORT Shader {
* before, it tries to compile it. If compilation fails or no sources
* are present, returns 0. If the shader was compiled already, returns
* already existing shader.
* @see logLevel(), state()
* @see state()
*/
GLuint compile();

51
src/Trade/AbstractImporter.h

@ -80,8 +80,8 @@ class MAGNUM_EXPORT AbstractImporter: public Corrade::PluginManager::Plugin {
* @return Whether the file was successfully opened
*
* Closes previous file, if it was opened, and tries to open given
* file. See also Feature::OpenFile. Default implementation prints
* message to error output and returns false.
* file. See also @ref Feature "Feature::OpenFile". Default
* implementation prints message to error output and returns false.
*/
virtual bool open(const std::string& filename);
@ -90,8 +90,9 @@ class MAGNUM_EXPORT AbstractImporter: public Corrade::PluginManager::Plugin {
* @param in Input stream
* @return Whether the file was successfully opened
*
* See also open(const std::string&), Feature::OpenStream. Default
* implementation prints message to error output and returns false.
* See also open(const std::string&), @ref Feature
* "Feature::OpenStream". Default implementation prints message to
* error output and returns false.
*/
virtual bool open(std::istream& in);
@ -102,58 +103,58 @@ class MAGNUM_EXPORT AbstractImporter: public Corrade::PluginManager::Plugin {
* Each function pair provides access to the data.
*/
/** @brief Scene count */
/** @brief %Scene count */
virtual inline size_t sceneCount() const { return 0; }
/**
* @brief Scene
* @param id Scene ID, from range [0, sceneCount()).
* @brief %Scene
* @param id %Scene ID, from range [0, sceneCount()).
*
* Returns pointer to given scene or nullptr, if no such scene exists.
*/
virtual inline SceneData* scene(size_t id) { return nullptr; }
/** @brief Light count */
/** @brief %Light count */
virtual inline size_t lightCount() const { return 0; }
/**
* @brief Light
* @param id Light ID, from range [0, lightCount()).
* @brief %Light
* @param id %Light ID, from range [0, lightCount()).
*
* Returns pointer to given light or nullptr, if no such light exists.
*/
virtual inline LightData* light(size_t id) { return nullptr; }
/** @brief Camera count */
/** @brief %Camera count */
virtual inline size_t cameraCount() const { return 0; }
/**
* @brief Camera
* @param id Camera ID, from range [0, cameraCount()).
* @brief %Camera
* @param id %Camera ID, from range [0, cameraCount()).
*
* Returns pointer to given camera or nullptr, if no such camera
* exists.
*/
virtual inline CameraData* camera(size_t id) { return nullptr; }
/** @brief Object count (without lights and cameras) */
/** @brief %Object count */
virtual inline size_t objectCount() const { return 0; }
/**
* @brief Object
* @param id Object ID, from range [0, objectCount()).
* @brief %Object
* @param id %Object ID, from range [0, objectCount()).
*
* Returns pointer to given object or nullptr, if no such object
* exists.
*/
virtual inline ObjectData* object(size_t id) { return nullptr; }
/** @brief Mesh count */
/** @brief %Mesh count */
virtual inline size_t meshCount() const { return 0; }
/**
* @brief Mesh
* @param id Mesh ID, from range [0, meshCount()).
* @brief %Mesh
* @param id %Mesh ID, from range [0, meshCount()).
*
* Returns pointer to given mesh or nullptr, if no such mesh exists.
*/
@ -171,12 +172,12 @@ class MAGNUM_EXPORT AbstractImporter: public Corrade::PluginManager::Plugin {
*/
virtual inline AbstractMaterialData* material(size_t id) { return nullptr; }
/** @brief Texture count */
/** @brief %Texture count */
virtual inline size_t textureCount() const { return 0; }
/**
* @brief Texture
* @param id Texture ID, from range [0, textureCount()).
* @brief %Texture
* @param id %Texture ID, from range [0, textureCount()).
*
* Returns pointer to given texture or nullptr, if no such texture
* exists.
@ -188,7 +189,7 @@ class MAGNUM_EXPORT AbstractImporter: public Corrade::PluginManager::Plugin {
/**
* @brief One-dimensional image
* @param id Image ID, from range [0, image1DCount()).
* @param id %Image ID, from range [0, image1DCount()).
*
* Returns pointer to given image or nullptr, if no such image exists.
*/
@ -199,7 +200,7 @@ class MAGNUM_EXPORT AbstractImporter: public Corrade::PluginManager::Plugin {
/**
* @brief Two-dimensional image
* @param id Image ID, from range [0, image2DCount()).
* @param id %Image ID, from range [0, image2DCount()).
*
* Returns pointer to given image or nullptr, if no such image exists.
*/
@ -210,7 +211,7 @@ class MAGNUM_EXPORT AbstractImporter: public Corrade::PluginManager::Plugin {
/**
* @brief Three-dimensional image
* @param id Image ID, from range [0, image3DCount()).
* @param id %Image ID, from range [0, image3DCount()).
*
* Returns pointer to given image or nullptr, if no such image exists.
*/

2
src/Trade/AbstractMaterialData.h

@ -22,7 +22,7 @@
namespace Magnum { namespace Trade {
/**
@brief Base class for materials
@brief Base class for material data
Subclasses provide access to parameters for given material type.
*/

2
src/Trade/CameraData.h

@ -22,7 +22,7 @@
namespace Magnum { namespace Trade {
/**
@brief %Camera
@brief %Camera data
*/
class MAGNUM_EXPORT CameraData {
CameraData(const CameraData& other) = delete;

2
src/Trade/ImageData.h

@ -24,7 +24,7 @@
namespace Magnum { namespace Trade {
/**
@brief %Image
@brief %Image data
Provides access to image data and additional information about data type and
dimensions. Can be used in the same situations as Image and BufferedImage.

2
src/Trade/LightData.h

@ -22,7 +22,7 @@
namespace Magnum { namespace Trade {
/**
@brief %Light
@brief %Light data
*/
class MAGNUM_EXPORT LightData {
LightData(const LightData& other) = delete;

2
src/Trade/MeshData.h

@ -24,7 +24,7 @@
namespace Magnum { namespace Trade {
/**
@brief %Mesh
@brief %Mesh data
Provides access to mesh data and additional information, such as primitive
type.

2
src/Trade/ObjectData.h

@ -24,7 +24,7 @@
namespace Magnum { namespace Trade {
/**
@brief Object
@brief %Object data
Provides access to object transformation and hierarchy.
*/

2
src/Trade/PhongMaterialData.h

@ -25,7 +25,7 @@
namespace Magnum { namespace Trade {
/**
@brief Phong material
@brief Phong material data
*/
class PhongMaterialData: public AbstractMaterialData {
public:

2
src/Trade/SceneData.h

@ -22,7 +22,7 @@
namespace Magnum { namespace Trade {
/**
@brief %Scene
@brief %Scene data
*/
class MAGNUM_EXPORT SceneData {
SceneData(const SceneData& other) = delete;

2
src/Trade/TextureData.h

@ -22,7 +22,7 @@
namespace Magnum { namespace Trade {
/**
@brief %Texture
@brief %Texture data
*/
class MAGNUM_EXPORT TextureData {
TextureData(const TextureData& other) = delete;

Loading…
Cancel
Save