diff --git a/src/Magnum/Trade/AbstractImageConverter.h b/src/Magnum/Trade/AbstractImageConverter.h index 96376286e..6352b171f 100644 --- a/src/Magnum/Trade/AbstractImageConverter.h +++ b/src/Magnum/Trade/AbstractImageConverter.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class Magnum::Trade::AbstractImageConverter + * @brief Class @ref Magnum::Trade::AbstractImageConverter */ #include @@ -46,9 +46,9 @@ classes in @ref Trade namespace for available image converter plugins. @section AbstractImageConverter-subclassing Subclassing -Plugin implements function doFeatures() and one or more of doExportToImage(), -doExportToData() or doExportToFile() functions based on what features are -supported. +Plugin implements function @ref doFeatures() and one or more of +@ref doExportToImage(), @ref doExportToData() or @ref doExportToFile() +functions based on what features are supported. You don't need to do most of the redundant sanity checks, these things are checked by the implementation: @@ -63,20 +63,20 @@ class MAGNUM_EXPORT AbstractImageConverter: public PluginManager::AbstractPlugin /** * @brief Features supported by this converter * - * @see Features, features() + * @see @ref Features, @ref features() */ enum class Feature: UnsignedByte { - /** Conversion to image with different format with exportToImage() */ + /** Conversion to image with different format with @ref exportToImage() */ ConvertImage = 1 << 0, - /** Exporting to raw data with exportToData() */ + /** Exporting to raw data with @ref exportToData() */ ConvertData = 1 << 1 }; /** * @brief Features supported by this converter * - * @see features() + * @see @ref features() */ typedef Containers::EnumSet Features; @@ -111,7 +111,7 @@ class MAGNUM_EXPORT AbstractImageConverter: public PluginManager::AbstractPlugin * @brief Export image to file * * Returns `true` on success, `false` otherwise. - * @see features(), exportToImage(), exportToData() + * @see @ref features(), @ref exportToImage(), @ref exportToData() */ bool exportToFile(const ImageReference2D& image, const std::string& filename) const; @@ -120,17 +120,17 @@ class MAGNUM_EXPORT AbstractImageConverter: public PluginManager::AbstractPlugin #else protected: #endif - /** @brief Implementation of features() */ + /** @brief Implementation of @ref features() */ virtual Features doFeatures() const = 0; - /** @brief Implementation of exportToImage() */ + /** @brief Implementation of @ref exportToImage() */ virtual Image2D* doExportToImage(const ImageReference2D& image) const; - /** @brief Implementation of exportToData() */ + /** @brief Implementation of @ref exportToData() */ virtual Containers::Array doExportToData(const ImageReference2D& image) const; /** - * @brief Implementation of exportToFile() + * @brief Implementation of @ref exportToFile() * * If @ref Feature::ConvertData is supported, default implementation * calls @ref doExportToData() and saves the result to given file. diff --git a/src/Magnum/Trade/AbstractImporter.h b/src/Magnum/Trade/AbstractImporter.h index 4d7c78484..7bb3482c6 100644 --- a/src/Magnum/Trade/AbstractImporter.h +++ b/src/Magnum/Trade/AbstractImporter.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class Magnum::Trade::AbstractImporter + * @brief Class @ref Magnum::Trade::AbstractImporter */ #include @@ -49,10 +49,10 @@ data. See @ref plugins for more information and `*Importer` classes in @section AbstractImporter-subclassing Subclassing -Plugin implements function doFeatures(), doIsOpened(), one of or both -doOpenData() and doOpenFile() functions, function doClose() and one or more -tuples of data access functions, based on which features are supported in given -format. +Plugin implements function @ref doFeatures(), @ref doIsOpened(), one of or both +@ref doOpenData() and @ref doOpenFile() functions, function @ref doClose() and +one or more tuples of data access functions, based on which features are +supported in given format. For multi-data formats file opening shouldn't take long, all parsing should be done in data parsing functions, because the user might want to import only @@ -81,10 +81,10 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractPlugin { /** * @brief Features supported by this importer * - * @see Features, features() + * @see @ref Features, @ref features() */ enum class Feature: UnsignedByte { - /** Opening files from raw data using openData() */ + /** Opening files from raw data using @ref openData() */ OpenData = 1 << 0 }; @@ -109,7 +109,7 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractPlugin { * Closes previous file, if it was opened, and tries to open given * file. Available only if @ref Feature::OpenData is supported. Returns * `true` on success, `false` otherwise. - * @see features(), openFile() + * @see @ref features(), @ref openFile() */ bool openData(Containers::ArrayReference data); @@ -118,7 +118,7 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractPlugin { * * Closes previous file, if it was opened, and tries to open given * file. Returns `true` on success, `false` otherwise. - * @see features(), openData() + * @see @ref features(), @ref openData() */ bool openFile(const std::string& filename); @@ -147,21 +147,21 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractPlugin { * @brief %Scene ID for given name * * If no scene for given name exists, returns `-1`. - * @see sceneName() + * @see @ref sceneName() */ Int sceneForName(const std::string& name); /** * @brief %Scene name - * @param id %Scene ID, from range [0, sceneCount()). + * @param id %Scene ID, from range [0, @ref sceneCount()). * - * @see sceneForName() + * @see @ref sceneForName() */ std::string sceneName(UnsignedInt id); /** * @brief %Scene - * @param id %Scene ID, from range [0, sceneCount()). + * @param id %Scene ID, from range [0, @ref sceneCount()). * * Returns given scene or `std::nullopt` if import failed. */ @@ -174,21 +174,21 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractPlugin { * @brief %Light ID for given name * * If no light for given name exists, returns `-1`. - * @see lightName() + * @see @ref lightName() */ Int lightForName(const std::string& name); /** * @brief %Light name - * @param id %Light ID, from range [0, lightCount()). + * @param id %Light ID, from range [0, @ref lightCount()). * - * @see lightForName() + * @see @ref lightForName() */ std::string lightName(UnsignedInt id); /** * @brief %Light - * @param id %Light ID, from range [0, lightCount()). + * @param id %Light ID, from range [0, @ref lightCount()). * * Returns given light or `std::nullopt` if importing failed. */ @@ -201,21 +201,21 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractPlugin { * @brief Camera ID for given name * * If no camera for given name exists, returns `-1`. - * @see cameraName() + * @see @ref cameraName() */ Int cameraForName(const std::string& name); /** * @brief Camera name - * @param id Camera ID, from range [0, cameraCount()). + * @param id Camera ID, from range [0, @ref cameraCount()). * - * @see cameraForName() + * @see @ref cameraForName() */ std::string cameraName(UnsignedInt id); /** * @brief Camera - * @param id Camera ID, from range [0, cameraCount()). + * @param id Camera ID, from range [0, @ref cameraCount()). * * Returns given camera or `std::nullopt` if importing failed. */ @@ -228,21 +228,21 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractPlugin { * @brief Two-dimensional object ID for given name * * If no scene for given name exists, returns `-1`. - * @see object2DName() + * @see @ref object2DName() */ Int object2DForName(const std::string& name); /** * @brief Two-dimensional object name - * @param id Object ID, from range [0, object2DCount()). + * @param id Object ID, from range [0, @ref object2DCount()). * - * @see object2DForName() + * @see @ref object2DForName() */ std::string object2DName(UnsignedInt id); /** * @brief Two-dimensional object - * @param id Object ID, from range [0, object2DCount()). + * @param id Object ID, from range [0, @ref object2DCount()). * * Returns given object or `nullptr` if importing failed. */ @@ -255,21 +255,21 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractPlugin { * @brief Three-dimensional object ID for given name * * If no scene for given name exists, returns `-1`. - * @see object3DName() + * @see @ref object3DName() */ Int object3DForName(const std::string& name); /** * @brief Three-dimensional object name - * @param id Object ID, from range [0, object3DCount()). + * @param id Object ID, from range [0, @ref object3DCount()). * - * @see object3DForName() + * @see @ref object3DForName() */ std::string object3DName(UnsignedInt id); /** * @brief Three-dimensional object - * @param id Object ID, from range [0, object3DCount()). + * @param id Object ID, from range [0, @ref object3DCount()). * * Returns given object or `nullptr` if importing failed. */ @@ -282,21 +282,21 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractPlugin { * @brief Two-dimensional mesh ID for given name * * If no mesh for given name exists, returns `-1`. - * @see mesh2DName() + * @see @ref mesh2DName() */ Int mesh2DForName(const std::string& name); /** * @brief Two-dimensional mesh name - * @param id %Mesh ID, from range [0, mesh2DCount()). + * @param id %Mesh ID, from range [0, @ref mesh2DCount()). * - * @see mesh2DForName() + * @see @ref mesh2DForName() */ std::string mesh2DName(UnsignedInt id); /** * @brief Two-dimensional mesh - * @param id %Mesh ID, from range [0, mesh2DCount()). + * @param id %Mesh ID, from range [0, @ref mesh2DCount()). * * Returns given mesh or `std::nullopt` if importing failed. */ @@ -309,21 +309,21 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractPlugin { * @brief Three-dimensional mesh ID for given name * * If no mesh for given name exists, returns `-1`. - * @see mesh3DName() + * @see @ref mesh3DName() */ Int mesh3DForName(const std::string& name); /** * @brief Three-dimensional mesh name - * @param id %Mesh ID, from range [0, mesh3DCount()). + * @param id %Mesh ID, from range [0, @ref mesh3DCount()). * - * @see mesh3DForName() + * @see @ref mesh3DForName() */ std::string mesh3DName(UnsignedInt id); /** * @brief Three-dimensional mesh - * @param id %Mesh ID, from range [0, mesh3DCount()). + * @param id %Mesh ID, from range [0, @ref mesh3DCount()). * * Returns given mesh or `std::nullopt` if importing failed. */ @@ -336,21 +336,21 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractPlugin { * @brief Material ID for given name * * If no material for given name exists, returns `-1`. - * @see materialName() + * @see @ref materialName() */ Int materialForName(const std::string& name); /** * @brief Material name - * @param id Material ID, from range [0, materialCount()). + * @param id Material ID, from range [0, @ref materialCount()). * - * @see materialForName() + * @see @ref materialForName() */ std::string materialName(UnsignedInt id); /** * @brief Material - * @param id Material ID, from range [0, materialCount()). + * @param id Material ID, from range [0, @ref materialCount()). * * Returns given material or `nullptr` if importing failed. */ @@ -363,21 +363,21 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractPlugin { * @brief %Texture ID for given name * * If no texture for given name exists, returns `-1`. - * @see textureName() + * @see @ref textureName() */ Int textureForName(const std::string& name); /** * @brief %Texture name - * @param id %Texture ID, from range [0, textureCount()). + * @param id %Texture ID, from range [0, @ref textureCount()). * - * @see textureForName() + * @see @ref textureForName() */ std::string textureName(UnsignedInt id); /** * @brief %Texture - * @param id %Texture ID, from range [0, textureCount()). + * @param id %Texture ID, from range [0, @ref textureCount()). * * Returns given texture or `std::nullopt` if importing failed. */ @@ -390,21 +390,21 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractPlugin { * @brief One-dimensional image ID for given name * * If no image for given name exists, returns `-1`. - * @see image1Dname() + * @see @ref image1DName() */ Int image1DForName(const std::string& name); /** * @brief One-dimensional image name - * @param id %Image ID, from range [0, image1DCount()). + * @param id %Image ID, from range [0, @ref image1DCount()). * - * @see image1DForName() + * @see @ref image1DForName() */ std::string image1DName(UnsignedInt id); /** * @brief One-dimensional image - * @param id %Image ID, from range [0, image1DCount()). + * @param id %Image ID, from range [0, @ref image1DCount()). * * Returns given image or `std::nullopt` if importing failed. */ @@ -417,21 +417,21 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractPlugin { * @brief Two-dimensional image ID for given name * * If no image for given name exists, returns `-1`. - * @see image2DName() + * @see @ref image2DName() */ Int image2DForName(const std::string& name); /** * @brief Two-dimensional image name - * @param id %Image ID, from range [0, image2DCount()). + * @param id %Image ID, from range [0, @ref image2DCount()). * - * @see image2DForName() + * @see @ref image2DForName() */ std::string image2DName(UnsignedInt id); /** * @brief Two-dimensional image - * @param id %Image ID, from range [0, image2DCount()). + * @param id %Image ID, from range [0, @ref image2DCount()). * * Returns given image or `std::nullopt` if importing failed. */ @@ -444,21 +444,21 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractPlugin { * @brief Three-dimensional image ID for given name * * If no image for given name exists, returns `-1`. - * @see image3DName() + * @see @ref image3DName() */ Int image3DForName(const std::string& name); /** * @brief Three-dimensional image name - * @param id %Image ID, from range [0, image3DCount()). + * @param id %Image ID, from range [0, @ref image3DCount()). * - * @see image3DForName() + * @see @ref image3DForName() */ std::string image3DName(UnsignedInt id); /** * @brief Three-dimensional image - * @param id %Image ID, from range [0, image3DCount()). + * @param id %Image ID, from range [0, @ref image3DCount()). * * Returns given image or `std::nullopt` if importing failed. */ @@ -471,171 +471,171 @@ class MAGNUM_EXPORT AbstractImporter: public PluginManager::AbstractPlugin { #else protected: #endif - /** @brief Implementation for features() */ + /** @brief Implementation for @ref features() */ virtual Features doFeatures() const = 0; - /** @brief Implementation for isOpened() */ + /** @brief Implementation for @ref isOpened() */ virtual bool doIsOpened() const = 0; - /** @brief Implementation for openData() */ + /** @brief Implementation for @ref openData() */ virtual void doOpenData(Containers::ArrayReference data); /** - * @brief Implementation for openFile() + * @brief Implementation for @ref openFile() * * If @ref Feature::OpenData is supported, default implementation opens * the file and calls @ref doOpenData() with its contents. */ virtual void doOpenFile(const std::string& filename); - /** @brief Implementation for close() */ + /** @brief Implementation for @ref close() */ virtual void doClose() = 0; - /** @brief Implementation for defaultScene() */ + /** @brief Implementation for @ref defaultScene() */ virtual Int doDefaultScene(); - /** @brief Implementation for sceneCount() */ + /** @brief Implementation for @ref sceneCount() */ virtual UnsignedInt doSceneCount() const; - /** @brief Implementation for sceneForName() */ + /** @brief Implementation for @ref sceneForName() */ virtual Int doSceneForName(const std::string& name); - /** @brief Implementation for sceneName() */ + /** @brief Implementation for @ref sceneName() */ virtual std::string doSceneName(UnsignedInt id); - /** @brief Implementation for scene() */ + /** @brief Implementation for @ref scene() */ virtual std::optional doScene(UnsignedInt id); - /** @brief Implementation for lightCount() */ + /** @brief Implementation for @ref lightCount() */ virtual UnsignedInt doLightCount() const; - /** @brief Implementation for lightForName() */ + /** @brief Implementation for @ref lightForName() */ virtual Int doLightForName(const std::string& name); - /** @brief Implementation for lightName() */ + /** @brief Implementation for @ref lightName() */ virtual std::string doLightName(UnsignedInt id); - /** @brief Implementation for light() */ + /** @brief Implementation for @ref light() */ virtual std::optional doLight(UnsignedInt id); - /** @brief Implementation for cameraCount() */ + /** @brief Implementation for @ref cameraCount() */ virtual UnsignedInt doCameraCount() const; - /** @brief Implementation for cameraForName() */ + /** @brief Implementation for @ref cameraForName() */ virtual Int doCameraForName(const std::string& name); - /** @brief Implementation for cameraName() */ + /** @brief Implementation for @ref cameraName() */ virtual std::string doCameraName(UnsignedInt id); - /** @brief Implementation for camera() */ + /** @brief Implementation for @ref camera() */ virtual std::optional doCamera(UnsignedInt id); - /** @brief Implementation for object2DCount() */ + /** @brief Implementation for @ref object2DCount() */ virtual UnsignedInt doObject2DCount() const; - /** @brief Implementation for object2DForName() */ + /** @brief Implementation for @ref object2DForName() */ virtual Int doObject2DForName(const std::string& name); - /** @brief Implementation for object2DName() */ + /** @brief Implementation for @ref object2DName() */ virtual std::string doObject2DName(UnsignedInt id); - /** @brief Implementation for object2D() */ + /** @brief Implementation for @ref object2D() */ virtual std::unique_ptr doObject2D(UnsignedInt id); - /** @brief Implementation for object3DCount() */ + /** @brief Implementation for @ref object3DCount() */ virtual UnsignedInt doObject3DCount() const; - /** @brief Implementation for object3DForName() */ + /** @brief Implementation for @ref object3DForName() */ virtual Int doObject3DForName(const std::string& name); - /** @brief Implementation for object3DName() */ + /** @brief Implementation for @ref object3DName() */ virtual std::string doObject3DName(UnsignedInt id); - /** @brief Implementation for object3D() */ + /** @brief Implementation for @ref object3D() */ virtual std::unique_ptr doObject3D(UnsignedInt id); - /** @brief Implementation for mesh2DCount() */ + /** @brief Implementation for @ref mesh2DCount() */ virtual UnsignedInt doMesh2DCount() const; - /** @brief Implementation for mesh2DForName() */ + /** @brief Implementation for @ref mesh2DForName() */ virtual Int doMesh2DForName(const std::string& name); - /** @brief Implementation for mesh2DName() */ + /** @brief Implementation for @ref mesh2DName() */ virtual std::string doMesh2DName(UnsignedInt id); - /** @brief Implementation for mesh2D() */ + /** @brief Implementation for @ref mesh2D() */ virtual std::optional doMesh2D(UnsignedInt id); - /** @brief Implementation for mesh3DCount() */ + /** @brief Implementation for @ref mesh3DCount() */ virtual UnsignedInt doMesh3DCount() const; - /** @brief Implementation for mesh3DForName() */ + /** @brief Implementation for @ref mesh3DForName() */ virtual Int doMesh3DForName(const std::string& name); - /** @brief Implementation for mesh3DName() */ + /** @brief Implementation for @ref mesh3DName() */ virtual std::string doMesh3DName(UnsignedInt id); - /** @brief Implementation for mesh3D() */ + /** @brief Implementation for @ref mesh3D() */ virtual std::optional doMesh3D(UnsignedInt id); - /** @brief Implementation for materialCount() */ + /** @brief Implementation for @ref materialCount() */ virtual UnsignedInt doMaterialCount() const; - /** @brief Implementation for materialForName() */ + /** @brief Implementation for @ref materialForName() */ virtual Int doMaterialForName(const std::string& name); - /** @brief Implementation for materialName() */ + /** @brief Implementation for @ref materialName() */ virtual std::string doMaterialName(UnsignedInt id); - /** @brief Implementation for material() */ + /** @brief Implementation for @ref material() */ virtual std::unique_ptr doMaterial(UnsignedInt id); - /** @brief Implementation for textureCount() */ + /** @brief Implementation for @ref textureCount() */ virtual UnsignedInt doTextureCount() const; - /** @brief Implementation for textureForName() */ + /** @brief Implementation for @ref textureForName() */ virtual Int doTextureForName(const std::string& name); - /** @brief Implementation for textureName() */ + /** @brief Implementation for @ref textureName() */ virtual std::string doTextureName(UnsignedInt id); - /** @brief Implementation for texture() */ + /** @brief Implementation for @ref texture() */ virtual std::optional doTexture(UnsignedInt id); - /** @brief Implementation for image1DCount() */ + /** @brief Implementation for @ref image1DCount() */ virtual UnsignedInt doImage1DCount() const; - /** @brief Implementation for image1DForName() */ + /** @brief Implementation for @ref image1DForName() */ virtual Int doImage1DForName(const std::string& name); - /** @brief Implementation for image1DName() */ + /** @brief Implementation for @ref image1DName() */ virtual std::string doImage1DName(UnsignedInt id); - /** @brief Implementation for image1D() */ + /** @brief Implementation for @ref image1D() */ virtual std::optional doImage1D(UnsignedInt id); - /** @brief Implementation for image2DCount() */ + /** @brief Implementation for @ref image2DCount() */ virtual UnsignedInt doImage2DCount() const; - /** @brief Implementation for image2DForName() */ + /** @brief Implementation for @ref image2DForName() */ virtual Int doImage2DForName(const std::string& name); - /** @brief Implementation for image2DName() */ + /** @brief Implementation for @ref image2DName() */ virtual std::string doImage2DName(UnsignedInt id); - /** @brief Implementation for image2D() */ + /** @brief Implementation for @ref image2D() */ virtual std::optional doImage2D(UnsignedInt id); - /** @brief Implementation for image3DCount() */ + /** @brief Implementation for @ref image3DCount() */ virtual UnsignedInt doImage3DCount() const; - /** @brief Implementation for image3DForName() */ + /** @brief Implementation for @ref image3DForName() */ virtual Int doImage3DForName(const std::string& name); - /** @brief Implementation for image3DName() */ + /** @brief Implementation for @ref image3DName() */ virtual std::string doImage3DName(UnsignedInt id); - /** @brief Implementation for image3D() */ + /** @brief Implementation for @ref image3D() */ virtual std::optional doImage3D(UnsignedInt id); }; diff --git a/src/Magnum/Trade/AbstractMaterialData.h b/src/Magnum/Trade/AbstractMaterialData.h index 6b960e18e..9483cc637 100644 --- a/src/Magnum/Trade/AbstractMaterialData.h +++ b/src/Magnum/Trade/AbstractMaterialData.h @@ -78,7 +78,7 @@ class MAGNUM_EXPORT AbstractMaterialData { MaterialType _type; }; -/** @debugoperator{Magnum::Trade::AbstractMaterialData} */ +/** @debugoperatorenum{Magnum::Trade::MaterialType} */ Debug MAGNUM_EXPORT operator<<(Debug debug, MaterialType value); }} diff --git a/src/Magnum/Trade/CameraData.h b/src/Magnum/Trade/CameraData.h index c87119af1..f5267bfd5 100644 --- a/src/Magnum/Trade/CameraData.h +++ b/src/Magnum/Trade/CameraData.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class Magnum::Trade::CameraData + * @brief Class @ref Magnum::Trade::CameraData */ #include diff --git a/src/Magnum/Trade/LightData.h b/src/Magnum/Trade/LightData.h index 5f667c8cb..1220dae46 100644 --- a/src/Magnum/Trade/LightData.h +++ b/src/Magnum/Trade/LightData.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class Magnum::Trade::LightData + * @brief Class @ref Magnum::Trade::LightData */ #include diff --git a/src/Magnum/Trade/MeshData2D.h b/src/Magnum/Trade/MeshData2D.h index decadbba6..6017e1176 100644 --- a/src/Magnum/Trade/MeshData2D.h +++ b/src/Magnum/Trade/MeshData2D.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class Magnum::Trade::MeshData2D + * @brief Class @ref Magnum::Trade::MeshData2D */ #include @@ -41,7 +41,7 @@ namespace Magnum { namespace Trade { Provides access to mesh data and additional information, such as primitive type. -@see MeshData3D +@see @ref MeshData3D */ class MAGNUM_EXPORT MeshData2D { public: @@ -80,7 +80,7 @@ class MAGNUM_EXPORT MeshData2D { /** * @brief Indices * - * @see isIndexed() + * @see @ref isIndexed() */ std::vector& indices(); const std::vector& indices() const; /**< @overload */ @@ -96,7 +96,7 @@ class MAGNUM_EXPORT MeshData2D { * @brief Positions * @param id Position array ID * - * @see positionArrayCount() + * @see @ref positionArrayCount() */ std::vector& positions(UnsignedInt id); const std::vector& positions(UnsignedInt id) const; /**< @overload */ @@ -109,9 +109,9 @@ class MAGNUM_EXPORT MeshData2D { /** * @brief 2D texture coordinates - * @param id Texture coordinate array ID + * @param id %Texture coordinate array ID * - * @see textureCoords2DArrayCount() + * @see @ref textureCoords2DArrayCount() */ std::vector& textureCoords2D(UnsignedInt id); const std::vector& textureCoords2D(UnsignedInt id) const; /**< @overload */ diff --git a/src/Magnum/Trade/MeshData3D.h b/src/Magnum/Trade/MeshData3D.h index 86b69c989..11cf381d4 100644 --- a/src/Magnum/Trade/MeshData3D.h +++ b/src/Magnum/Trade/MeshData3D.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class Magnum::Trade::MeshData3D + * @brief Class @ref Magnum::Trade::MeshData3D */ #include @@ -41,7 +41,7 @@ namespace Magnum { namespace Trade { Provides access to mesh data and additional information, such as primitive type. -@see MeshData2D +@see @ref MeshData2D */ class MAGNUM_EXPORT MeshData3D { public: @@ -81,7 +81,7 @@ class MAGNUM_EXPORT MeshData3D { /** * @brief Indices * - * @see isIndexed() + * @see @ref isIndexed() */ std::vector& indices(); const std::vector& indices() const; /**< @overload */ @@ -97,7 +97,7 @@ class MAGNUM_EXPORT MeshData3D { * @brief Positions * @param id Position array ID * - * @see positionArrayCount() + * @see @ref positionArrayCount() */ std::vector& positions(UnsignedInt id); const std::vector& positions(UnsignedInt id) const; /**< @overload */ @@ -112,7 +112,7 @@ class MAGNUM_EXPORT MeshData3D { * @brief Normals * @param id Normal array ID * - * @see normalArrayCount() + * @see @ref normalArrayCount() */ std::vector& normals(UnsignedInt id); const std::vector& normals(UnsignedInt id) const; /**< @overload */ @@ -125,9 +125,9 @@ class MAGNUM_EXPORT MeshData3D { /** * @brief 2D texture coordinates - * @param id Texture coordinate array ID + * @param id %Texture coordinate array ID * - * @see textureCoords2DArrayCount() + * @see @ref textureCoords2DArrayCount() */ std::vector& textureCoords2D(UnsignedInt id); const std::vector& textureCoords2D(UnsignedInt id) const; /**< @overload */ diff --git a/src/Magnum/Trade/MeshObjectData2D.h b/src/Magnum/Trade/MeshObjectData2D.h index 4a59eee30..11b7f1004 100644 --- a/src/Magnum/Trade/MeshObjectData2D.h +++ b/src/Magnum/Trade/MeshObjectData2D.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class Magnum::Trade::MeshObjectData2D + * @brief Class @ref Magnum::Trade::MeshObjectData2D */ #include "Magnum/Trade/ObjectData2D.h" @@ -37,7 +37,7 @@ namespace Magnum { namespace Trade { @brief Two-dimensional mesh object data Provides access to material information for given mesh instance. -@see MeshObjectData3D +@see @ref MeshObjectData3D */ class MAGNUM_EXPORT MeshObjectData2D: public ObjectData2D { public: diff --git a/src/Magnum/Trade/MeshObjectData3D.h b/src/Magnum/Trade/MeshObjectData3D.h index dafe97632..2f5bf99cc 100644 --- a/src/Magnum/Trade/MeshObjectData3D.h +++ b/src/Magnum/Trade/MeshObjectData3D.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class Magnum::Trade::MeshObjectData3D + * @brief Class @ref Magnum::Trade::MeshObjectData3D */ #include "Magnum/Trade/ObjectData3D.h" @@ -37,7 +37,7 @@ namespace Magnum { namespace Trade { @brief Three-dimensional mesh object data Provides access to material information for given mesh instance. -@see MeshObjectData2D +@see @ref MeshObjectData2D */ class MAGNUM_EXPORT MeshObjectData3D: public ObjectData3D { public: diff --git a/src/Magnum/Trade/ObjectData2D.h b/src/Magnum/Trade/ObjectData2D.h index 779da5c93..0dd7a9798 100644 --- a/src/Magnum/Trade/ObjectData2D.h +++ b/src/Magnum/Trade/ObjectData2D.h @@ -57,7 +57,7 @@ enum class ObjectInstanceType2D: UnsignedByte { @brief Two-dimensional object data Provides access to object transformation and hierarchy. -@see MeshObjectData2D, ObjectData3D +@see @ref MeshObjectData2D, @ref ObjectData3D */ class MAGNUM_EXPORT ObjectData2D { public: @@ -101,14 +101,14 @@ class MAGNUM_EXPORT ObjectData2D { /** * @brief Instance type * - * @see instance() + * @see @ref instance() */ ObjectInstanceType2D instanceType() const { return _instanceType; } /** * @brief Instance ID * @return ID of given camera / light / mesh etc., specified by - * instanceType() + * @ref instanceType() */ Int instance() const { return _instance; } @@ -119,7 +119,7 @@ class MAGNUM_EXPORT ObjectData2D { Int _instance; }; -/** @debugoperator{Magnum::Trade::ObjectData2D} */ +/** @debugoperatorenum{Magnum::Trade::ObjectInstanceType2D} */ Debug MAGNUM_EXPORT operator<<(Debug debug, ObjectInstanceType2D value); }} diff --git a/src/Magnum/Trade/ObjectData3D.h b/src/Magnum/Trade/ObjectData3D.h index 1eafa6c50..61ef895cb 100644 --- a/src/Magnum/Trade/ObjectData3D.h +++ b/src/Magnum/Trade/ObjectData3D.h @@ -59,7 +59,7 @@ enum class ObjectInstanceType3D: UnsignedByte { @brief Three-dimensional object data Provides access to object transformation and hierarchy. -@see MeshObjectData3D, ObjectData2D +@see @ref MeshObjectData3D, @ref ObjectData2D */ class MAGNUM_EXPORT ObjectData3D { public: @@ -103,14 +103,14 @@ class MAGNUM_EXPORT ObjectData3D { /** * @brief Instance type * - * @see instance() + * @see @ref instance() */ ObjectInstanceType3D instanceType() const { return _instanceType; } /** * @brief Instance ID * @return ID of given camera / light / mesh etc., specified by - * instanceType() + * @ref instanceType() */ Int instance() const { return _instance; } @@ -121,7 +121,7 @@ class MAGNUM_EXPORT ObjectData3D { Int _instance; }; -/** @debugoperator{Magnum::Trade::ObjectData3D} */ +/** @debugoperatorenum{Magnum::Trade::ObjectInstanceType3D} */ Debug MAGNUM_EXPORT operator<<(Debug debug, ObjectInstanceType3D value); }} diff --git a/src/Magnum/Trade/PhongMaterialData.h b/src/Magnum/Trade/PhongMaterialData.h index 15443d1a0..6cce3a13b 100644 --- a/src/Magnum/Trade/PhongMaterialData.h +++ b/src/Magnum/Trade/PhongMaterialData.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class Magnum::Trade::PhongMaterialData + * @brief Class @ref Magnum::Trade::PhongMaterialData */ #include "Magnum/Magnum.h" diff --git a/src/Magnum/Trade/SceneData.h b/src/Magnum/Trade/SceneData.h index 6d7c686aa..bfe23a10b 100644 --- a/src/Magnum/Trade/SceneData.h +++ b/src/Magnum/Trade/SceneData.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class Magnum::Trade::SceneData + * @brief Class @ref Magnum::Trade::SceneData */ #include diff --git a/src/Magnum/Trade/TextureData.cpp b/src/Magnum/Trade/TextureData.cpp index 08beb8e99..ae69ab885 100644 --- a/src/Magnum/Trade/TextureData.cpp +++ b/src/Magnum/Trade/TextureData.cpp @@ -27,6 +27,7 @@ namespace Magnum { namespace Trade { +#ifndef DOXYGEN_GENERATING_OUTPUT Debug operator<<(Debug debug, const TextureData::Type value) { switch(value) { #define _c(value) case TextureData::Type::value: return debug << "Trade::TextureData::Type::" #value; @@ -39,5 +40,6 @@ Debug operator<<(Debug debug, const TextureData::Type value) { return debug << "Trade::TextureData::Type::(unknown)"; } +#endif }} diff --git a/src/Magnum/Trade/TextureData.h b/src/Magnum/Trade/TextureData.h index 808be38a4..ca8301c05 100644 --- a/src/Magnum/Trade/TextureData.h +++ b/src/Magnum/Trade/TextureData.h @@ -26,7 +26,7 @@ */ /** @file - * @brief Class Magnum::Trade::TextureData + * @brief Class @ref Magnum::Trade::TextureData */ #include "Magnum/Array.h" @@ -41,9 +41,9 @@ namespace Magnum { namespace Trade { class TextureData { public: /** - * @brief Texture type + * @brief %Texture type * - * @see type() + * @see @ref type() */ enum class Type: UnsignedByte { Texture1D, /**< One-dimensional texture */ @@ -54,12 +54,12 @@ class TextureData { /** * @brief Constructor - * @param type Texture type + * @param type %Texture type * @param minificationFilter Minification filter * @param magnificationFilter Magnification filter * @param mipmapFilter Mipmap filter * @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 wrapping, UnsignedInt image): _type(type), _minificationFilter(minificationFilter), _magnificationFilter(magnificationFilter), _mipmapFilter(mipmapFilter), _wrapping(wrapping), _image(image) {} @@ -75,7 +75,7 @@ class TextureData { /** @brief Move assignment */ TextureData& operator=(TextureData&&) = default; - /** @brief Texture type */ + /** @brief %Texture type */ Type type() const { return _type; } /** @brief Minification filter */ @@ -91,7 +91,7 @@ class TextureData { Array3D wrapping() const { return _wrapping; } /** - * @brief Image ID + * @brief %Image ID * * ID of 1D, 2D or 3D image based on texture type. If type is * @ref Type::Cube the function returns first of six consecutive @@ -109,7 +109,7 @@ class TextureData { UnsignedInt _image; }; -/** @debugoperator{Magnum::Trade::TextureData} */ +/** @debugoperatorclassenum{Magnum::Trade::TextureData,Magnum::Trade::TextureData::Type} */ Debug MAGNUM_EXPORT operator<<(Debug debug, TextureData::Type value); }}