Browse Source

Doc++

pull/168/head
Vladimír Vondruš 3 years ago
parent
commit
bb9eb1f80c
  1. 17
      doc/changelog.dox
  2. 2
      src/Magnum/Math/Range.h
  3. 5
      src/Magnum/Text/AbstractFont.h
  4. 4
      src/Magnum/TextureTools/Atlas.cpp

17
doc/changelog.dox

@ -1486,10 +1486,12 @@ See also:
@relativeref{Corrade,Containers::Pair} instead @relativeref{Corrade,Containers::Pair} instead
- @ref Text::AbstractFont public APIs now take - @ref Text::AbstractFont public APIs now take
@ref Containers::StringView instead of @ref std::string and return @ref Containers::StringView instead of @ref std::string and return
@ref Containers::Pair instead of @ref std::pair. Additionally, the @relativeref{Corrade,Containers::Pair} instead of @ref std::pair.
internal implementation relies on @ref Containers::ArrayView "Containers::ArrayView<const char32_t>" Additionally, the internal implementation relies on
instead of @ref std::u32string and @ref Containers::Triple instead of @ref Corrade::Containers::ArrayView "Containers::ArrayView<const char32_t>"
@ref std::tuple, but that shouldn't affect end-user code in any way. instead of @ref std::u32string and
@relativeref{Corrade,Containers::Triple} instead of @ref std::tuple,
but that shouldn't affect end-user code in any way.
To handle most backwards compatibility, @ref Corrade/Containers/StringStl.h To handle most backwards compatibility, @ref Corrade/Containers/StringStl.h
and/or @ref Corrade/Containers/PairStl.h is included in affected headers and/or @ref Corrade/Containers/PairStl.h is included in affected headers
for implicit conversions from/to a @ref std::string and/or @ref std::pair, for implicit conversions from/to a @ref std::string and/or @ref std::pair,
@ -1497,9 +1499,10 @@ See also:
APIs. APIs.
- @ref Math::Algorithms::svd() that used to return a @ref std::tuple and - @ref Math::Algorithms::svd() that used to return a @ref std::tuple and
printed a message to @relativeref{Magnum,Error} if it didn't converge now printed a message to @relativeref{Magnum,Error} if it didn't converge now
returns a @ref Containers::Tuple wrapped in an @ref Containers::Optional. returns a @relativeref{Corrade,Containers::Triple} wrapped in a
As the optional makes this a breaking change, no backwards compatibility @relativeref{Corrade,Containers::Optional}. As the optional makes this a
header for tuple conversion is included. breaking change, no backwards compatibility header for tuple conversion is
included.
- @ref Image, @ref ImageView and @ref Trade::ImageData now look for a - @ref Image, @ref ImageView and @ref Trade::ImageData now look for a
@cpp pixelFormatSize() @ce API via ADL instead of @cpp pixelSize() @ce. In @cpp pixelFormatSize() @ce API via ADL instead of @cpp pixelSize() @ce. In
case you were passing a custom pixel format enum to the image classes, you case you were passing a custom pixel format enum to the image classes, you

2
src/Magnum/Math/Range.h

@ -196,7 +196,7 @@ template<UnsignedInt dimensions, class T> class Range {
* Contrary to what Doxygen shows, returns reference to an * Contrary to what Doxygen shows, returns reference to an
* one-dimensional fixed-size array of @cpp dimensions*2 @ce elements, * one-dimensional fixed-size array of @cpp dimensions*2 @ce elements,
* i.e. @cpp T(&)[dimensions*2] @ce. * i.e. @cpp T(&)[dimensions*2] @ce.
* @ref min(), @ref max() * @see @ref min(), @ref max()
* @todoc Fix once there's a possibility to patch the signature in a * @todoc Fix once there's a possibility to patch the signature in a
* post-processing step (https://github.com/mosra/m.css/issues/56) * post-processing step (https://github.com/mosra/m.css/issues/56)
*/ */

5
src/Magnum/Text/AbstractFont.h

@ -452,8 +452,9 @@ class MAGNUM_TEXT_EXPORT AbstractFont: public PluginManager::AbstractPlugin {
* *
* Expects that a font is opened. * Expects that a font is opened.
* @note This function is meant to be used only for font observations * @note This function is meant to be used only for font observations
* and conversions. In performance-critical code the @ref layout() * and conversions. In performance-critical code the
* function should be used instead. * @ref fillGlyphCache() and @ref layout() functions should be
* used instead.
*/ */
UnsignedInt glyphId(char32_t character); UnsignedInt glyphId(char32_t character);

4
src/Magnum/TextureTools/Atlas.cpp

@ -88,9 +88,9 @@ Containers::Pair<Int, Containers::Array<Vector3i>> atlasArrayPowerOfTwo(const Ve
} }
/* Sort to have the biggest size first. Assuming the items are square, /* Sort to have the biggest size first. Assuming the items are square,
which is checked below in the loop. It's highly likely there are many which is checked above in the loop. It's highly likely there are many
textures of the same size, thus use a stable sort to have output textures of the same size, thus use a stable sort to have output
consistent across platforms */ consistent across platforms. */
/** @todo stable_sort allocates, would be great if i could make it reuse /** @todo stable_sort allocates, would be great if i could make it reuse
the memory allocated for output */ the memory allocated for output */
std::stable_sort(sortedSizes.begin(), sortedSizes.end(), [](const Vector3i& a, const Vector3i& b) { std::stable_sort(sortedSizes.begin(), sortedSizes.end(), [](const Vector3i& a, const Vector3i& b) {

Loading…
Cancel
Save