Added documentation for glfwGetJoystickName.

ago%!(EXTRA string=13 years) · 7d9b5c0127
parent 0bac579506
commit 7d9b5c0127
1 changed files with 7 additions and 0 deletions
--- a/include/GL/glfw3.h
+++ b/include/GL/glfw3.h
@ -1534,6 +1534,13 @@ GLFWAPI int glfwGetJoystickAxes(int joy, float* axes, int numaxes);
 *  @ingroup input
 */
 GLFWAPI int glfwGetJoystickButtons(int joy, unsigned char* buttons, int numbuttons);
+
+/*! @brief Returns the name of the specified joystick.
+ *  @param[in] joy The joystick to query.
+ *  @return The UTF-8 encoded name of the joystick, or @c NULL if the joystick
+ *  is not present.
+ *  @ingroup input
+ */
 GLFWAPI const char* glfwGetJoystickName(int joy);

 /*! @brief Sets the clipboard to the specified string.