From 4bf4460521201785129b903ef91af10e2f3ae971 Mon Sep 17 00:00:00 2001
From: Tobias Frisch <tfrisch@uni-koblenz.de>
Date: Sun, 22 Aug 2021 15:21:47 +0200
Subject: [PATCH] [#79] Added doxygen documentation about return values
Signed-off-by: Tobias Frisch <tfrisch@uni-koblenz.de>
---
modules/asset_loader/include/vkcv/asset/asset_loader.hpp | 3 +++
1 file changed, 3 insertions(+)
diff --git a/modules/asset_loader/include/vkcv/asset/asset_loader.hpp b/modules/asset_loader/include/vkcv/asset/asset_loader.hpp
index a94d9572..51ebb3b6 100644
--- a/modules/asset_loader/include/vkcv/asset/asset_loader.hpp
+++ b/modules/asset_loader/include/vkcv/asset/asset_loader.hpp
@@ -276,6 +276,7 @@ struct Scene {
* @param path must be the path to a glTF- or glb-file.
* @param scene is a reference to a Scene struct that will be filled with the
* meta-data of all objects described in the glTF file.
+ * @return ASSET_ERROR on failure, otherwise ASSET_SUCCESS
*/
int probeScene(const std::filesystem::path &path, Scene &scene);
@@ -290,6 +291,7 @@ int probeScene(const std::filesystem::path &path, Scene &scene);
*
* @param path must be the path to a glTF- or glb-file.
* @param scene is the scene struct to which the results will be written.
+ * @return ASSET_ERROR on failure, otherwise ASSET_SUCCESS
*/
int loadMesh(Scene &scene, int mesh_index);
@@ -300,6 +302,7 @@ int loadMesh(Scene &scene, int mesh_index);
* @param path must be the path to a glTF- or glb-file.
* @param scene is a reference to a Scene struct that will be filled with the
* content of the glTF file being loaded.
+ * @return ASSET_ERROR on failure, otherwise ASSET_SUCCESS
*/
int loadScene(const std::filesystem::path &path, Scene &scene);
--
GitLab