From cdbfbcc1e48f5e951ec64eb5989efec627b08773 Mon Sep 17 00:00:00 2001 From: Mathias Agopian Date: Wed, 27 Feb 2019 12:59:21 -0800 Subject: [PATCH] docs: fix a few warnings when invoking doxygen --- README.md | 3 ++- filament/docs/doxygen/filament.doxygen | 2 +- filament/include/filament/Engine.h | 6 ++++-- filament/include/filament/LightManager.h | 6 +++--- filament/include/filament/Material.h | 21 +++++++++++-------- filament/include/filament/RenderableManager.h | 6 +++--- 6 files changed, 25 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index d0314acac8..72c956c746 100644 --- a/README.md +++ b/README.md @@ -826,7 +826,8 @@ MoltenVK. ## Generating C++ documentation -To generate the documentation you must first install `doxygen`, then run the following commands: +To generate the documentation you must first install `doxygen` and `graphviz`, then run the +following commands: ``` $ cd filament/filament diff --git a/filament/docs/doxygen/filament.doxygen b/filament/docs/doxygen/filament.doxygen index b80ccf2f27..9e5cf752a6 100644 --- a/filament/docs/doxygen/filament.doxygen +++ b/filament/docs/doxygen/filament.doxygen @@ -112,7 +112,7 @@ WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = include +INPUT = include ../libs/filabridge/include/filament INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.inl \ *.h \ diff --git a/filament/include/filament/Engine.h b/filament/include/filament/Engine.h index b0e73b9fc5..449e45a77d 100644 --- a/filament/include/filament/Engine.h +++ b/filament/include/filament/Engine.h @@ -148,6 +148,8 @@ public: /** * Creates an instance of Engine * + * @param backend Which driver backend to use. + * * @param platform A pointer to an object that implements Platform. If this is * provided, then this object is used to create the hardware context * and expose platform features to it. @@ -169,7 +171,7 @@ public: * * @return A pointer to the newly created Engine, or nullptr if the Engine couldn't be created. * - * @error nullptr if the GPU driver couldn't be initialized, for instance if it doesn't + * nullptr if the GPU driver couldn't be initialized, for instance if it doesn't * support the right version of OpenGL or OpenGL ES. * * @exception utils::PostConditionPanic can be thrown if there isn't enough memory to @@ -280,7 +282,7 @@ public: * @attention All MaterialInstance of the specified material must be destroyed before * destroying a Material. * @exception utils::PreConditionPanic is thrown if some MaterialInstances remain. - * @error no-op if exceptions are disabled and some MaterialInstances remain. + * no-op if exceptions are disabled and some MaterialInstances remain. */ void destroy(const Material* p); void destroy(const MaterialInstance* p); //!< Destroys a MaterialInstance object. diff --git a/filament/include/filament/LightManager.h b/filament/include/filament/LightManager.h index 54b984c66f..22c685fa3a 100644 --- a/filament/include/filament/LightManager.h +++ b/filament/include/filament/LightManager.h @@ -410,15 +410,15 @@ public: * @param entity Entity to add the light component to. * @return Success if the component was created successfully, Error otherwise. * + * If exceptions are disabled and an error occurs, this function is a no-op. + * Success can be checked by looking at the return value. + * * If this component already exists on the given entity, it is first destroyed as if * destroy(utils::Entity e) was called. * * @warning * Currently, only 2048 lights can be created on a given Engine. * - * @error if exceptions are disabled and an error occurs, this function is a no-op. - * Success can be checked by looking at the return value. - * * @exception utils::PostConditionPanic if a runtime error occurred, such as running out of * memory or other resources. * @exception utils::PreConditionPanic if a parameter to a builder function was invalid. diff --git a/filament/include/filament/Material.h b/filament/include/filament/Material.h index 318fa46d6c..031612ecc6 100644 --- a/filament/include/filament/Material.h +++ b/filament/include/filament/Material.h @@ -208,10 +208,11 @@ public: } /** - * Sets the value of the given parameter on this material's default instance. + * Sets a texture and sampler parameters on this material's default instance. * - * @param name The name of the material parameter - * @param texture The value of the material parameter + * @param name The name of the material texture parameter + * @param texture The texture to set as parameter + * @param sampler The sampler to be used with this texture * * @see getDefaultInstance() */ @@ -221,10 +222,11 @@ public: } /** - * Sets the value of the given parameter on this material's default instance. + * Sets the color of the given parameter on this material's default instance. * - * @param name The name of the material parameter - * @param color The value of the material parameter + * @param name The name of the material color parameter + * @param type Whether the color is specified in the linear or sRGB space + * @param color The color as a floating point red, green, blue tuple * * @see getDefaultInstance() */ @@ -233,10 +235,11 @@ public: } /** - * Sets the value of the given parameter on this material's default instance. + * Sets the color of the given parameter on this material's default instance. * - * @param name The name of the material parameter - * @param color The value of the material parameter + * @param name The name of the material color parameter + * @param type Whether the color is specified in the linear or sRGB space + * @param color The color as a floating point red, green, blue, alpha tuple * * @see getDefaultInstance() */ diff --git a/filament/include/filament/RenderableManager.h b/filament/include/filament/RenderableManager.h index 18986356ff..6cd5b1f391 100644 --- a/filament/include/filament/RenderableManager.h +++ b/filament/include/filament/RenderableManager.h @@ -96,13 +96,13 @@ public: * @param entity Entity to add the Renderable component to. * @return Success if the component was created successfully, Error otherwise. * + * If exceptions are disabled and an error occurs, this function is a no-op. + * Success can be checked by looking at the return value. + * * If this component already exists on the given entity and the construction is successful, * it is first destroyed as if destroy(utils::Entity e) was called. In case of error, * the existing component is unmodified. * - * @error if exceptions are disabled and an error occurs, this function is a no-op. - * Success can be checked by looking at the return value. - * * @exception utils::PostConditionPanic if a runtime error occurred, such as running out of * memory or other resources. * @exception utils::PreConditionPanic if a parameter to a builder function was invalid.