From 84e9c6a110435e135999e1886e6a0527d0f6e8db Mon Sep 17 00:00:00 2001 From: Marko Lindqvist Date: Tue, 22 Nov 2022 20:29:15 +0200 Subject: [PATCH 19/19] gtk: Correct check_player_or_user_name() header Drop documentation of nonexistent match_len parameter. Document parameters in doxygen style. See osdn #45973 Signed-off-by: Marko Lindqvist --- client/gui-gtk-3.0/chatline.c | 9 ++++----- client/gui-gtk-3.22/chatline.c | 9 ++++----- client/gui-gtk-4.0/chatline.c | 9 ++++----- 3 files changed, 12 insertions(+), 15 deletions(-) diff --git a/client/gui-gtk-3.0/chatline.c b/client/gui-gtk-3.0/chatline.c index a1fdd4c10a..08414f072d 100644 --- a/client/gui-gtk-3.0/chatline.c +++ b/client/gui-gtk-3.0/chatline.c @@ -193,12 +193,11 @@ static const char *get_player_or_user_name(int id) /**********************************************************************//** Find a player or a user by prefix. - prefix - The prefix. - matches - A string array to set the matches result. - max_matches - The maximum of matches. - match_len - The length of the string used to returns matches. + @param prefix The prefix. + @param matches A string array to set the matches result. + @param max_matches The maximum of matches. - Returns the number of the matches names. + @return the number of the matches names. **************************************************************************/ static int check_player_or_user_name(const char *prefix, const char **matches, diff --git a/client/gui-gtk-3.22/chatline.c b/client/gui-gtk-3.22/chatline.c index aa3a1f407d..07752ab2a8 100644 --- a/client/gui-gtk-3.22/chatline.c +++ b/client/gui-gtk-3.22/chatline.c @@ -193,12 +193,11 @@ static const char *get_player_or_user_name(int id) /**********************************************************************//** Find a player or a user by prefix. - prefix - The prefix. - matches - A string array to set the matches result. - max_matches - The maximum of matches. - match_len - The length of the string used to returns matches. + @param prefix The prefix. + @param matches A string array to set the matches result. + @param max_matches The maximum of matches. - Returns the number of the matches names. + @return the number of the matches names. **************************************************************************/ static int check_player_or_user_name(const char *prefix, const char **matches, diff --git a/client/gui-gtk-4.0/chatline.c b/client/gui-gtk-4.0/chatline.c index 8df1c8afb3..ed9dac511d 100644 --- a/client/gui-gtk-4.0/chatline.c +++ b/client/gui-gtk-4.0/chatline.c @@ -195,12 +195,11 @@ static const char *get_player_or_user_name(int id) /**********************************************************************//** Find a player or a user by prefix. - prefix - The prefix. - matches - A string array to set the matches result. - max_matches - The maximum of matches. - match_len - The length of the string used to returns matches. + @param prefix The prefix. + @param matches A string array to set the matches result. + @param max_matches The maximum of matches. - Returns the number of the matches names. + @return the number of the matches names. **************************************************************************/ static int check_player_or_user_name(const char *prefix, const char **matches, -- 2.35.1