Skip to content

Commit 6b0b867

Browse files
committed
Bug#33734075 doc-comment warnings in authentication_ldap
Issue ===== clang -Wdocumentation reports: libmysql/authentication_ldap/auth_ldap_kerberos.h:66:12: warning: empty paragraph passed to '@return' command [-Wdocumentation] @return should be followed by a {description} block, but is empty here. Change ====== - removed empty @return - align indent of @RetVal RB: 27539
1 parent 389f01c commit 6b0b867

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

libmysql/authentication_ldap/auth_ldap_kerberos.h

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/* Copyright (c) 2020, 2021, Oracle and/or its affiliates.
1+
/* Copyright (c) 2020, 2022, Oracle and/or its affiliates.
22
33
This program is free software; you can redistribute it and/or modify
44
it under the terms of the GNU General Public License, version 2.0,
@@ -46,10 +46,10 @@
4646
with one name that is considered canonical
4747
4848
Credential cache:
49-
A credential cache (or “ccache”) holds Kerberos credentials while they remain
50-
valid and, generally, while the user’s session lasts, so that authenticating
51-
to a service multiple times (e.g., connecting to a web or mail server more
52-
than once) doesn’t require contacting the KDC every time.
49+
A credential cache (or “ccache”) holds Kerberos credentials while they
50+
remain valid and, generally, while the user’s session lasts, so that
51+
authenticating to a service multiple times (e.g., connecting to a web or mail
52+
server more than once) doesn’t require contacting the KDC every time.
5353
*/
5454
namespace auth_ldap_client_kerberos_context {
5555
class Kerberos {
@@ -63,19 +63,17 @@ class Kerberos {
6363
3. If user credentials already exist in the cache, it doesn't attempt to get
6464
it again.
6565
66-
@return
67-
@retval true Successfully able to obtain and store credentials.
68-
@retval false Failed to obtain and store credentials.
66+
@retval true Successfully able to obtain and store credentials.
67+
@retval false Failed to obtain and store credentials.
6968
*/
7069
bool obtain_store_credentials();
7170
/**
7271
This function retrieves default principle from kerberos configuration and
7372
parses the user name from it. If user name has not been provided in the
7473
MySQL client, This method can be used to get the user name and use for
7574
authentication.
76-
@return
77-
@retval true Successfully able to get user name.
78-
@retval false Failed to get user name.
75+
@retval true Successfully able to get user name.
76+
@retval false Failed to get user name.
7977
*/
8078
bool get_user_name(std::string *name);
8179
void destroy_credentials();
@@ -88,10 +86,9 @@ class Kerberos {
8886
/**
8987
This function creates kerberos context, initializes credentials cache and
9088
user principal.
91-
@return
92-
@retval true All the required kerberos objects like context,
89+
@retval true All the required kerberos objects like context,
9390
credentials cache and user principal are initialized correctly.
94-
@retval false Required kerberos objects failed to initialized.
91+
@retval false Required kerberos objects failed to initialized.
9592
*/
9693
bool setup();
9794
/**

0 commit comments

Comments
 (0)