Skip to content

Commit 3677be2

Browse files
committed
Add doxygen comments
1 parent b722cfa commit 3677be2

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

include/Window.hpp

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,14 @@ class Window {
2525
/**
2626
* Initialize window and OpenGL context.
2727
*
28+
* @param width The width of the window.
29+
* @param height The height of the window.
30+
* @param title The desired title of the window.
31+
* @param flags The ConfigFlags to set prior to initializing the window. See SetConfigFlags for more details.
32+
*
33+
* @see ::SetConfigFlags()
34+
* @see ConfigFlags
35+
*
2836
* @throws raylib::RaylibException Thrown if the window failed to initiate.
2937
*/
3038
Window(int width, int height, const std::string& title = "raylib", unsigned int flags = 0) {
@@ -41,11 +49,19 @@ class Window {
4149
/**
4250
* Initializes the window.
4351
*
52+
* @param width The width of the window.
53+
* @param height The height of the window.
54+
* @param title The desired title of the window.
55+
* @param flags The ConfigFlags to set prior to initializing the window. See SetConfigFlags for more details.
56+
*
57+
* @see ::SetConfigFlags()
58+
* @see ConfigFlags
59+
*
4460
* @throws raylib::RaylibException Thrown if the window failed to initiate.
4561
*/
4662
inline void Init(int width = 800, int height = 450, const std::string& title = "raylib", unsigned int flags = 0) {
4763
if (flags != 0) {
48-
SetConfigFlags(flags);
64+
::SetConfigFlags(flags);
4965
}
5066
::InitWindow(width, height, title.c_str());
5167
if (!::IsWindowReady()) {
@@ -405,6 +421,13 @@ class Window {
405421
return ::IsWindowReady();
406422
}
407423

424+
/**
425+
* Sets the configuration flags for raylib.
426+
*
427+
* @param flags The ConfigFlags to apply to the configuration.
428+
*
429+
* @see ::SetConfigFlags
430+
*/
408431
inline void SetConfigFlags(unsigned int flags) {
409432
::SetConfigFlags(flags);
410433
}

0 commit comments

Comments
 (0)