ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Trade: removed autolink-preventing % noise.

pull/77/head
Vladimír Vondruš 12 years ago
parent
1e160d3216
commit
ae56f1be72
8 changed files with 44 additions and 44 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 56
      src/Magnum/Trade/AbstractImporter.h
  2. 2
      src/Magnum/Trade/CameraData.h
  3. 10
      src/Magnum/Trade/ImageData.h
  4. 2
      src/Magnum/Trade/LightData.h
  5. 2
      src/Magnum/Trade/MeshData2D.h
  6. 2
      src/Magnum/Trade/MeshData3D.h
  7. 2
      src/Magnum/Trade/SceneData.h
  8. 12
      src/Magnum/Trade/TextureData.h

56
src/Magnum/Trade/AbstractImporter.h
Unescape View File

@ -145,11 +145,11 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlug
*/ */
Int defaultScene(); Int defaultScene();
/** @brief %Scene count */ /** @brief Scene count */
UnsignedInt sceneCount() const; UnsignedInt sceneCount() const;
/** /**
* @brief %Scene ID for given name * @brief Scene ID for given name
* *
* If no scene for given name exists, returns `-1`. * If no scene for given name exists, returns `-1`.
* @see @ref sceneName() * @see @ref sceneName()
@ -157,26 +157,26 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlug
Int sceneForName(const std::string& name); Int sceneForName(const std::string& name);
/** /**
* @brief %Scene name * @brief Scene name
* @param id %Scene ID, from range [0, @ref sceneCount()). * @param id Scene ID, from range [0, @ref sceneCount()).
* *
* @see @ref sceneForName() * @see @ref sceneForName()
*/ */
std::string sceneName(UnsignedInt id); std::string sceneName(UnsignedInt id);
/** /**
* @brief %Scene * @brief Scene
* @param id %Scene ID, from range [0, @ref sceneCount()). * @param id Scene ID, from range [0, @ref sceneCount()).
* *
* Returns given scene or `std::nullopt` if import failed. * Returns given scene or `std::nullopt` if import failed.
*/ */
std::optional<SceneData> scene(UnsignedInt id); std::optional<SceneData> scene(UnsignedInt id);
/** @brief %Light count */ /** @brief Light count */
UnsignedInt lightCount() const; UnsignedInt lightCount() const;
/** /**
* @brief %Light ID for given name * @brief Light ID for given name
* *
* If no light for given name exists, returns `-1`. * If no light for given name exists, returns `-1`.
* @see @ref lightName() * @see @ref lightName()
@ -184,16 +184,16 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlug
Int lightForName(const std::string& name); Int lightForName(const std::string& name);
/** /**
* @brief %Light name * @brief Light name
* @param id %Light ID, from range [0, @ref lightCount()). * @param id Light ID, from range [0, @ref lightCount()).
* *
* @see @ref lightForName() * @see @ref lightForName()
*/ */
std::string lightName(UnsignedInt id); std::string lightName(UnsignedInt id);
/** /**
* @brief %Light * @brief Light
* @param id %Light ID, from range [0, @ref lightCount()). * @param id Light ID, from range [0, @ref lightCount()).
* *
* Returns given light or `std::nullopt` if importing failed. * Returns given light or `std::nullopt` if importing failed.
*/ */
@ -293,7 +293,7 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlug
/** /**
* @brief Two-dimensional mesh name * @brief Two-dimensional mesh name
* @param id %Mesh ID, from range [0, @ref mesh2DCount()). * @param id Mesh ID, from range [0, @ref mesh2DCount()).
* *
* @see @ref mesh2DForName() * @see @ref mesh2DForName()
*/ */
@ -301,7 +301,7 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlug
/** /**
* @brief Two-dimensional mesh * @brief Two-dimensional mesh
* @param id %Mesh ID, from range [0, @ref mesh2DCount()). * @param id Mesh ID, from range [0, @ref mesh2DCount()).
* *
* Returns given mesh or `std::nullopt` if importing failed. * Returns given mesh or `std::nullopt` if importing failed.
*/ */
@ -320,7 +320,7 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlug
/** /**
* @brief Three-dimensional mesh name * @brief Three-dimensional mesh name
* @param id %Mesh ID, from range [0, @ref mesh3DCount()). * @param id Mesh ID, from range [0, @ref mesh3DCount()).
* *
* @see @ref mesh3DForName() * @see @ref mesh3DForName()
*/ */
@ -328,7 +328,7 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlug
/** /**
* @brief Three-dimensional mesh * @brief Three-dimensional mesh
* @param id %Mesh ID, from range [0, @ref mesh3DCount()). * @param id Mesh ID, from range [0, @ref mesh3DCount()).
* *
* Returns given mesh or `std::nullopt` if importing failed. * Returns given mesh or `std::nullopt` if importing failed.
*/ */
@ -361,11 +361,11 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlug
*/ */
std::unique_ptr<AbstractMaterialData> material(UnsignedInt id); std::unique_ptr<AbstractMaterialData> material(UnsignedInt id);
/** @brief %Texture count */ /** @brief Texture count */
UnsignedInt textureCount() const; UnsignedInt textureCount() const;
/** /**
* @brief %Texture ID for given name * @brief Texture ID for given name
* *
* If no texture for given name exists, returns `-1`. * If no texture for given name exists, returns `-1`.
* @see @ref textureName() * @see @ref textureName()
@ -373,16 +373,16 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlug
Int textureForName(const std::string& name); Int textureForName(const std::string& name);
/** /**
* @brief %Texture name * @brief Texture name
* @param id %Texture ID, from range [0, @ref textureCount()). * @param id Texture ID, from range [0, @ref textureCount()).
* *
* @see @ref textureForName() * @see @ref textureForName()
*/ */
std::string textureName(UnsignedInt id); std::string textureName(UnsignedInt id);
/** /**
* @brief %Texture * @brief Texture
* @param id %Texture ID, from range [0, @ref textureCount()). * @param id Texture ID, from range [0, @ref textureCount()).
* *
* Returns given texture or `std::nullopt` if importing failed. * Returns given texture or `std::nullopt` if importing failed.
*/ */
@ -401,7 +401,7 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlug
/** /**
* @brief One-dimensional image name * @brief One-dimensional image name
* @param id %Image ID, from range [0, @ref image1DCount()). * @param id Image ID, from range [0, @ref image1DCount()).
* *
* @see @ref image1DForName() * @see @ref image1DForName()
*/ */
@ -409,7 +409,7 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlug
/** /**
* @brief One-dimensional image * @brief One-dimensional image
* @param id %Image ID, from range [0, @ref image1DCount()). * @param id Image ID, from range [0, @ref image1DCount()).
* *
* Returns given image or `std::nullopt` if importing failed. * Returns given image or `std::nullopt` if importing failed.
*/ */
@ -428,7 +428,7 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlug
/** /**
* @brief Two-dimensional image name * @brief Two-dimensional image name
* @param id %Image ID, from range [0, @ref image2DCount()). * @param id Image ID, from range [0, @ref image2DCount()).
* *
* @see @ref image2DForName() * @see @ref image2DForName()
*/ */
@ -436,7 +436,7 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlug
/** /**
* @brief Two-dimensional image * @brief Two-dimensional image
* @param id %Image ID, from range [0, @ref image2DCount()). * @param id Image ID, from range [0, @ref image2DCount()).
* *
* Returns given image or `std::nullopt` if importing failed. * Returns given image or `std::nullopt` if importing failed.
*/ */
@ -455,7 +455,7 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlug
/** /**
* @brief Three-dimensional image name * @brief Three-dimensional image name
* @param id %Image ID, from range [0, @ref image3DCount()). * @param id Image ID, from range [0, @ref image3DCount()).
* *
* @see @ref image3DForName() * @see @ref image3DForName()
*/ */
@ -463,7 +463,7 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractManagingPlug
/** /**
* @brief Three-dimensional image * @brief Three-dimensional image
* @param id %Image ID, from range [0, @ref image3DCount()). * @param id Image ID, from range [0, @ref image3DCount()).
* *
* Returns given image or `std::nullopt` if importing failed. * Returns given image or `std::nullopt` if importing failed.
*/ */

2
src/Magnum/Trade/CameraData.h
Unescape View File

@ -34,7 +34,7 @@
namespace Magnum { namespace Trade { namespace Magnum { namespace Trade {
/** /**
@brief %Camera data @brief Camera data
*/ */
class MAGNUM_EXPORT CameraData {}; class MAGNUM_EXPORT CameraData {};

10
src/Magnum/Trade/ImageData.h
Unescape View File

@ -34,7 +34,7 @@
namespace Magnum { namespace Trade { namespace Magnum { namespace Trade {
/** /**
@brief %Image data @brief Image data
Access to image data provided by @ref AbstractImporter subclasses. Access to image data provided by @ref AbstractImporter subclasses.
Interchangeable with @ref Image, @ref ImageReference or @ref BufferImage. Interchangeable with @ref Image, @ref ImageReference or @ref BufferImage.
@ -42,14 +42,14 @@ Interchangeable with @ref Image, @ref ImageReference or @ref BufferImage.
*/ */
template<UnsignedInt dimensions> class ImageData: public AbstractImage { template<UnsignedInt dimensions> class ImageData: public AbstractImage {
public: public:
const static UnsignedInt Dimensions = dimensions; /**< @brief %Image dimension count */ const static UnsignedInt Dimensions = dimensions; /**< @brief Image dimension count */
/** /**
* @brief Constructor * @brief Constructor
* @param format Format of pixel data * @param format Format of pixel data
* @param type Data type of pixel data * @param type Data type of pixel data
* @param size %Image size * @param size Image size
* @param data %Image data * @param data Image data
* *
* Note that the image data are not copied on construction, but they * Note that the image data are not copied on construction, but they
* are deleted on class destruction. * are deleted on class destruction.
@ -84,7 +84,7 @@ template<UnsignedInt dimensions> class ImageData: public AbstractImage {
/*implicit*/ operator ImageReference<dimensions>() const && = delete; /*implicit*/ operator ImageReference<dimensions>() const && = delete;
#endif #endif
/** @brief %Image size */ /** @brief Image size */
VectorTypeFor<dimensions, Int> size() const { return _size; } VectorTypeFor<dimensions, Int> size() const { return _size; }
/** @copydoc Image::dataSize() */ /** @copydoc Image::dataSize() */

2
src/Magnum/Trade/LightData.h
Unescape View File

@ -34,7 +34,7 @@
namespace Magnum { namespace Trade { namespace Magnum { namespace Trade {
/** /**
@brief %Light data @brief Light data
*/ */
class MAGNUM_EXPORT LightData {}; class MAGNUM_EXPORT LightData {};

2
src/Magnum/Trade/MeshData2D.h
Unescape View File

@ -109,7 +109,7 @@ class MAGNUM_EXPORT MeshData2D {
/** /**
* @brief 2D texture coordinates * @brief 2D texture coordinates
* @param id %Texture coordinate array ID * @param id Texture coordinate array ID
* *
* @see @ref textureCoords2DArrayCount() * @see @ref textureCoords2DArrayCount()
*/ */

2
src/Magnum/Trade/MeshData3D.h
Unescape View File

@ -125,7 +125,7 @@ class MAGNUM_EXPORT MeshData3D {
/** /**
* @brief 2D texture coordinates * @brief 2D texture coordinates
* @param id %Texture coordinate array ID * @param id Texture coordinate array ID
* *
* @see @ref textureCoords2DArrayCount() * @see @ref textureCoords2DArrayCount()
*/ */

2
src/Magnum/Trade/SceneData.h
Unescape View File

@ -38,7 +38,7 @@
namespace Magnum { namespace Trade { namespace Magnum { namespace Trade {
/** /**
@brief %Scene data @brief Scene data
*/ */
class MAGNUM_EXPORT SceneData { class MAGNUM_EXPORT SceneData {
public: public:

12
src/Magnum/Trade/TextureData.h
Unescape View File

@ -36,12 +36,12 @@
namespace Magnum { namespace Trade { namespace Magnum { namespace Trade {
/** /**
@brief %Texture data @brief Texture data
*/ */
class TextureData { class TextureData {
public: public:
/** /**
* @brief %Texture type * @brief Texture type
* *
* @see @ref type() * @see @ref type()
*/ */
@ -54,12 +54,12 @@ class TextureData {
/** /**
* @brief Constructor * @brief Constructor
* @param type %Texture type * @param type Texture type
* @param minificationFilter Minification filter * @param minificationFilter Minification filter
* @param magnificationFilter Magnification filter * @param magnificationFilter Magnification filter
* @param mipmapFilter Mipmap filter * @param mipmapFilter Mipmap filter
* @param wrapping Wrapping * @param wrapping Wrapping
* @param image %Texture image ID * @param image Texture image ID
*/ */
TextureData(Type type, Sampler::Filter minificationFilter, Sampler::Filter magnificationFilter, Sampler::Mipmap mipmapFilter, Array3D<Sampler::Wrapping> wrapping, UnsignedInt image): _type(type), _minificationFilter(minificationFilter), _magnificationFilter(magnificationFilter), _mipmapFilter(mipmapFilter), _wrapping(wrapping), _image(image) {} TextureData(Type type, Sampler::Filter minificationFilter, Sampler::Filter magnificationFilter, Sampler::Mipmap mipmapFilter, Array3D<Sampler::Wrapping> wrapping, UnsignedInt image): _type(type), _minificationFilter(minificationFilter), _magnificationFilter(magnificationFilter), _mipmapFilter(mipmapFilter), _wrapping(wrapping), _image(image) {}
@ -75,7 +75,7 @@ class TextureData {
/** @brief Move assignment */ /** @brief Move assignment */
TextureData& operator=(TextureData&&) = default; TextureData& operator=(TextureData&&) = default;
/** @brief %Texture type */ /** @brief Texture type */
Type type() const { return _type; } Type type() const { return _type; }
/** @brief Minification filter */ /** @brief Minification filter */
@ -91,7 +91,7 @@ class TextureData {
Array3D<Sampler::Wrapping> wrapping() const { return _wrapping; } Array3D<Sampler::Wrapping> wrapping() const { return _wrapping; }
/** /**
* @brief %Image ID * @brief Image ID
* *
* ID of 1D, 2D or 3D image based on texture type. If type is * ID of 1D, 2D or 3D image based on texture type. If type is
* @ref Type::Cube the function returns first of six consecutive * @ref Type::Cube the function returns first of six consecutive

Write Preview
Loading…
Cancel
Save