Browse Source

Fix @note in docs

pull/6/head
falkTX 10 years ago
parent
commit
9ef573d693
4 changed files with 10 additions and 10 deletions
  1. +1
    -1
      dgl/App.hpp
  2. +1
    -1
      dgl/Color.hpp
  3. +4
    -4
      dgl/Image.hpp
  4. +4
    -4
      dgl/Widget.hpp

+ 1
- 1
dgl/App.hpp View File

@@ -60,7 +60,7 @@ public:
/** /**
Run the application event-loop until all Windows are closed. Run the application event-loop until all Windows are closed.
idle() is called at regular intervals. 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(); void exec();




+ 1
- 1
dgl/Color.hpp View File

@@ -83,7 +83,7 @@ struct Color {


/** /**
Check if this color matches another. 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 isEqual(const Color& color, bool withAlpha = true) noexcept;
bool isNotEqual(const Color& color, bool withAlpha = true) noexcept; bool isNotEqual(const Color& color, bool withAlpha = true) noexcept;


+ 4
- 4
dgl/Image.hpp View File

@@ -45,13 +45,13 @@ public:


/** /**
Constructor using raw image data. 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); 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. 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); 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. 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; 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. 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; void loadFromMemory(const char* const rawData, const Size<uint>& size, const GLenum format = GL_BGRA, const GLenum type = GL_UNSIGNED_BYTE) noexcept;




+ 4
- 4
dgl/Widget.hpp View File

@@ -360,16 +360,16 @@ protected:
/** /**
Tell the parent window this widget needs the full viewport. Tell the parent window this widget needs the full viewport.
When enabled, the local widget coordinates are ignored. 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; void setNeedsFullViewport(bool yesNo) noexcept;


/** /**
Tell the parent window this widget needs scaling. Tell the parent window this widget needs scaling.
When enabled, the widget viewport is scaled to match width and height. 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; void setNeedsScaling(bool yesNo) noexcept;




Loading…
Cancel
Save