From 82ad6fcfd5ff2c22507c3a9d1e3539bbb4aff65b Mon Sep 17 00:00:00 2001 From: GruelingPine185 <66073333+GruelingPine185@users.noreply.github.com> Date: Sat, 12 Aug 2023 15:39:20 -0400 Subject: [PATCH 1/4] Added clarification for in-code comments --- include/GLFW/glfw3.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/GLFW/glfw3.h b/include/GLFW/glfw3.h index 58b395cd..f3729fe1 100644 --- a/include/GLFW/glfw3.h +++ b/include/GLFW/glfw3.h @@ -3077,7 +3077,7 @@ GLFWAPI void glfwWindowHintString(int hint, const char* value); * This must be greater than zero. * @param[in] height The desired height, in screen coordinates, of the window. * This must be greater than zero. - * @param[in] title The initial, UTF-8 encoded window title. + * @param[in] title The initial, UTF-8 encoded, non-NULL window title. * @param[in] monitor The monitor to use for full screen mode, or `NULL` for * windowed mode. * @param[in] share The window whose context to share resources with, or `NULL` From 20bacd84707205087f0cc592aadb02383dcbc680 Mon Sep 17 00:00:00 2001 From: GruelingPine185 <66073333+GruelingPine185@users.noreply.github.com> Date: Sat, 12 Aug 2023 15:39:57 -0400 Subject: [PATCH 2/4] Added clarification for out-of-code docs --- docs/window.dox | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/window.dox b/docs/window.dox index 3cec6358..97c9fdd9 100644 --- a/docs/window.dox +++ b/docs/window.dox @@ -860,7 +860,8 @@ glfwGetWindowPos(window, &xpos, &ypos); All GLFW windows have a title, although undecorated or full screen windows may not display it or only display it in a task bar or similar interface. You can -set a UTF-8 encoded window title with @ref glfwSetWindowTitle. +set a UTF-8 encoded window title with @ref glfwSetWindowTitle. The set title +should not be `NULL`. @code glfwSetWindowTitle(window, "My Window"); From d85911bef1ad6ab4b805b66579b0bb8a7f028f7a Mon Sep 17 00:00:00 2001 From: GruelingPine185 <66073333+GruelingPine185@users.noreply.github.com> Date: Sat, 12 Aug 2023 15:53:10 -0400 Subject: [PATCH 3/4] Added change to Changelog --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index e3d18ec8..6016ef39 100644 --- a/README.md +++ b/README.md @@ -121,6 +121,7 @@ information on what to include when reporting a bug. ## Changelog + - Added clarification for `glfwCreateWindow` title parameter to documentation (#2232) - Added `GLFW_PLATFORM` init hint for runtime platform selection (#1958) - Added `GLFW_ANY_PLATFORM`, `GLFW_PLATFORM_WIN32`, `GLFW_PLATFORM_COCOA`, `GLFW_PLATFORM_WAYLAND`, `GLFW_PLATFORM_X11` and `GLFW_PLATFORM_NULL` symbols to From 32122d367e5b49919d861454dbd945d3bf838c3d Mon Sep 17 00:00:00 2001 From: GruelingPine185 <66073333+GruelingPine185@users.noreply.github.com> Date: Sat, 12 Aug 2023 15:58:41 -0400 Subject: [PATCH 4/4] Added PR number to Changelog --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6016ef39..f16919d5 100644 --- a/README.md +++ b/README.md @@ -121,7 +121,7 @@ information on what to include when reporting a bug. ## Changelog - - Added clarification for `glfwCreateWindow` title parameter to documentation (#2232) + - Added clarification for `glfwCreateWindow` title parameter to documentation (#2232, #2379) - Added `GLFW_PLATFORM` init hint for runtime platform selection (#1958) - Added `GLFW_ANY_PLATFORM`, `GLFW_PLATFORM_WIN32`, `GLFW_PLATFORM_COCOA`, `GLFW_PLATFORM_WAYLAND`, `GLFW_PLATFORM_X11` and `GLFW_PLATFORM_NULL` symbols to