From 3cd18b337a5662faf9a699733f8a28efd04979e2 Mon Sep 17 00:00:00 2001 From: Misa Date: Sun, 7 Feb 2021 12:57:00 -0800 Subject: [PATCH] Remove comment from GCChar() This comment indicates that the function is used by UtilityClass::GCString(). Which is unnecessary, because the reader can trivially search for usages of GCChar in the file itself (the 'static' preceding the function should be a good enough hint) - and if there aren't any, then the reader will know the function is unused, whereas if they read the comment, they would have been under the assumption that it wasn't used. (There might also a compiler warning about it being unused, which would be more confusing if the comment was still there.) Point is, comments can get outdated, so removing the comment here makes the code more self-documenting. --- desktop_version/src/UtilityClass.cpp | 1 - 1 file changed, 1 deletion(-) diff --git a/desktop_version/src/UtilityClass.cpp b/desktop_version/src/UtilityClass.cpp index 318b2b6f..7407753b 100644 --- a/desktop_version/src/UtilityClass.cpp +++ b/desktop_version/src/UtilityClass.cpp @@ -4,7 +4,6 @@ #include #include -/* Used by UtilityClass::GCString to generate a button list */ static const char *GCChar(SDL_GameControllerButton button) { if (button == SDL_CONTROLLER_BUTTON_A)