Scarfski/filament
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix a few warnings when invoking doxygen

Browse Source
This commit is contained in:
Mathias Agopian
2019-02-27 12:59:21 -08:00
committed by Mathias Agopian
parent ced19bde17
commit cdbfbcc1e4
6 changed files with 25 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -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

2
filament/docs/doxygen/filament.doxygen
View File

@@ -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 \

6
filament/include/filament/Engine.h
View File

@@ -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.

6
filament/include/filament/LightManager.h
View File

@@ -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.

21
filament/include/filament/Material.h
View File

@@ -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()
*/

6
filament/include/filament/RenderableManager.h
View File

@@ -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.