Browse Source

Doc++

pull/454/head
Vladimír Vondruš 6 years ago
parent
commit
a5722f175a
  1. 2
      doc/credits.dox
  2. 4
      doc/getting-started.dox
  3. 4
      doc/platforms-html5.dox
  4. 4
      src/Magnum/Math/Half.h
  5. 4
      src/Magnum/Trade/PhongMaterialData.h

2
doc/credits.dox

@ -92,7 +92,7 @@ Are the below lists missing your name or something's wrong?
--- Multi-channel support in the @ref Audio library, standard conformance; --- Multi-channel support in the @ref Audio library, standard conformance;
float, double, A-Law and μ-Law format support in the float, double, A-Law and μ-Law format support in the
@ref Audio::WavImporter "WavAudioImporter" plugin @ref Audio::WavImporter "WavAudioImporter" plugin
- **Andrew ([\@sheerluck](https://github.com/sheerluck)) --- Gentoo package - **Andrew ([\@sheerluck](https://github.com/sheerluck))** --- Gentoo package
fixes fixes
- **Andy Somogyi** ([\@andysomogyi](https://github.com/andysomogyi)) --- - **Andy Somogyi** ([\@andysomogyi](https://github.com/andysomogyi)) ---
bugreports, API design improvement suggestions bugreports, API design improvement suggestions

4
doc/getting-started.dox

@ -143,8 +143,8 @@ using CMake.
Compared to @ref getting-started-setup-subproject "Option A", you don't need to Compared to @ref getting-started-setup-subproject "Option A", you don't need to
clone the subprojects and modify the `CMakeLists.txt` file, however you'll need clone the subprojects and modify the `CMakeLists.txt` file, however you'll need
to set `CMAKE_PREFIX_PATH` if you installed Corrade and Magnum to a to set `CMAKE_PREFIX_PATH` if you installed Corrade and Magnum to a
non-standard location (i.e., anything else than `/usr` or `/usr/local`, and non-standard location (i.e., anything else than `/usr` or `/usr/local` on Unix
always on Windows). systems, and outside of the standard prefix if using MinGW on Windows).
@section getting-started-review 2. Review project structure @section getting-started-review 2. Review project structure

4
doc/platforms-html5.dox

@ -342,8 +342,8 @@ to bundle the files explicitly. One possibility is via
@ref Corrade::Utility::Resource (basically the same way as you probably already @ref Corrade::Utility::Resource (basically the same way as you probably already
bundle shader code etc., as shown in the @ref examples-textured-triangle bundle shader code etc., as shown in the @ref examples-textured-triangle
example). In this case the file is compiled directly into the `*.wasm` binary, example). In this case the file is compiled directly into the `*.wasm` binary,
which is the most optimal way, but accessing the files needs extra effort which is the most optimal way, but it means you need to port your code away
compared to a desktop application. Another possibility is via the from the usual filesystem APIs. Another possibility is via the
@cmake emscripten_embed_file() @ce CMake macro, which is implicitly available @cmake emscripten_embed_file() @ce CMake macro, which is implicitly available
when you build for Emscripten, coming from the [UseEmscripten.cmake](https://github.com/mosra/toolchains/blob/master/modules/UseEmscripten.cmake) when you build for Emscripten, coming from the [UseEmscripten.cmake](https://github.com/mosra/toolchains/blob/master/modules/UseEmscripten.cmake)
module: module:

4
src/Magnum/Math/Half.h

@ -57,8 +57,8 @@ for more information about half floats.
The class provides explicit conversion from and to @ref Magnum::Float "Float", The class provides explicit conversion from and to @ref Magnum::Float "Float",
equality comparison with correct treatment of NaN values, promotion and equality comparison with correct treatment of NaN values, promotion and
negation operator, an @link Literals::operator""_h() operator""_h() @endlink negation operator, an @link Literals::operator""_h() operator""_h() @endlink
literal and an @ref operator<<(Debug&, Half) debug operator. Internally the class uses literal and an @ref operator<<(Debug&, Half) debug operator. Internally the
@ref packHalf() and @ref unpackHalf(). Example usage: class uses @ref packHalf() and @ref unpackHalf(). Example usage:
@snippet MagnumMath.cpp Half-usage @snippet MagnumMath.cpp Half-usage

4
src/Magnum/Trade/PhongMaterialData.h

@ -135,14 +135,14 @@ class MAGNUM_TRADE_EXPORT PhongMaterialData: public AbstractMaterialData {
* non-textured material and @cpp 0xffffffff_rgbaf @ce for a * non-textured material and @cpp 0xffffffff_rgbaf @ce for a
* default value for a textured material. * default value for a textured material.
* @param ambientTexture Ambient texture ID. Ignored if @p flags * @param ambientTexture Ambient texture ID. Ignored if @p flags
* doesn't have @ref Flag::AmbientTexture * doesn't have @ref Flag::AmbientTexture.
* @param ambientCoordinateSet Ambient texture coordinate set. Ignored * @param ambientCoordinateSet Ambient texture coordinate set. Ignored
* if @p flags doesn't have @ref Flag::AmbientTexture * if @p flags doesn't have @ref Flag::AmbientTexture
* @param diffuseColor Diffuse color. Use * @param diffuseColor Diffuse color. Use
* @cpp 0xffffffff_rgbaf @ce for a default value for both a * @cpp 0xffffffff_rgbaf @ce for a default value for both a
* non-textured and a textured material. * non-textured and a textured material.
* @param diffuseTexture Diffuse texture ID. Ignored if @p flags * @param diffuseTexture Diffuse texture ID. Ignored if @p flags
* doesn't have @ref Flag::DiffuseTexture * doesn't have @ref Flag::DiffuseTexture.
* @param diffuseCoordinateSet Diffuse texture coordinate set. Ignored * @param diffuseCoordinateSet Diffuse texture coordinate set. Ignored
* if @p flags doesn't have @ref Flag::DiffuseTexture * if @p flags doesn't have @ref Flag::DiffuseTexture
* @param specularColor Specular color. Use * @param specularColor Specular color. Use

Loading…
Cancel
Save