commit 9ef573d693a8d4e515f389529b7144f9430b9062
parent c6789d1889cfdb9fef784f19ab452ff70723ffc2
Author: falkTX <falktx@gmail.com>
Date: Mon, 4 May 2015 23:44:50 +0200
Fix @note in docs
Diffstat:
4 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/dgl/App.hpp b/dgl/App.hpp
@@ -60,7 +60,7 @@ public:
/**
Run the application event-loop until all Windows are closed.
idle() is called at regular intervals.
- @note: This function is meant for standalones only, *never* call this from plugins.
+ @note This function is meant for standalones only, *never* call this from plugins.
*/
void exec();
diff --git a/dgl/Color.hpp b/dgl/Color.hpp
@@ -83,7 +83,7 @@ struct Color {
/**
Check if this color matches another.
- @note: Comparison is forced within 8-bit color values.
+ @note Comparison is forced within 8-bit color values.
*/
bool isEqual(const Color& color, bool withAlpha = true) noexcept;
bool isNotEqual(const Color& color, bool withAlpha = true) noexcept;
diff --git a/dgl/Image.hpp b/dgl/Image.hpp
@@ -45,13 +45,13 @@ public:
/**
Constructor using raw image data.
- @note: @a rawData must remain valid for the lifetime of this Image.
+ @note @a rawData must remain valid for the lifetime of this Image.
*/
Image(const char* const rawData, const uint width, const uint height, const GLenum format = GL_BGRA, const GLenum type = GL_UNSIGNED_BYTE);
/**
Constructor using raw image data.
- @note: @a rawData must remain valid for the lifetime of this Image.
+ @note @a rawData must remain valid for the lifetime of this Image.
*/
Image(const char* const rawData, const Size<uint>& size, const GLenum format = GL_BGRA, const GLenum type = GL_UNSIGNED_BYTE);
@@ -67,13 +67,13 @@ public:
/**
Load image data from memory.
- @note: @a rawData must remain valid for the lifetime of this Image.
+ @note @a rawData must remain valid for the lifetime of this Image.
*/
void loadFromMemory(const char* const rawData, const uint width, const uint height, const GLenum format = GL_BGRA, const GLenum type = GL_UNSIGNED_BYTE) noexcept;
/**
Load image data from memory.
- @note: @a rawData must remain valid for the lifetime of this Image.
+ @note @a rawData must remain valid for the lifetime of this Image.
*/
void loadFromMemory(const char* const rawData, const Size<uint>& size, const GLenum format = GL_BGRA, const GLenum type = GL_UNSIGNED_BYTE) noexcept;
diff --git a/dgl/Widget.hpp b/dgl/Widget.hpp
@@ -360,16 +360,16 @@ protected:
/**
Tell the parent window this widget needs the full viewport.
When enabled, the local widget coordinates are ignored.
- @note: This is an internal function;
- You do not need it under normal circumstances.
+ @note This is an internal function;
+ You do not need it under normal circumstances.
*/
void setNeedsFullViewport(bool yesNo) noexcept;
/**
Tell the parent window this widget needs scaling.
When enabled, the widget viewport is scaled to match width and height.
- @note: This is an internal function;
- You do not need it under normal circumstances.
+ @note This is an internal function;
+ You do not need it under normal circumstances.
*/
void setNeedsScaling(bool yesNo) noexcept;