From: Amos Jeffries <squid3@treenet.co.nz>
Date: Mon, 7 Sep 2015 15:52:27 +0000 (-0700)
Subject: fix documentation
X-Git-Tag: SQUID_4_0_1~21^2~17
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=4fca920f5d619d7f62c7b4196c7cc141154ee745;p=thirdparty%2Fsquid.git

fix documentation
---

diff --git a/src/auth/UserNameCache.h b/src/auth/UserNameCache.h
index 8cfa431c1d..b498ec3a68 100644
--- a/src/auth/UserNameCache.h
+++ b/src/auth/UserNameCache.h
@@ -18,10 +18,7 @@
 
 namespace Auth {
 
-/** Cache of Auth::User::Pointer, keyed by Auth::User::userKey
- *
- * \returns a pointer to cached credentials, or nullptr if none found
- */
+/// Cache of Auth::User credentials, keyed by Auth::User::userKey
 class UserNameCache : public RegisteredRunner
 {
 private:
@@ -39,6 +36,7 @@ public:
     UserNameCache& operator=(const UserNameCache&) = delete;
 
     /// obtain pointer to user if present, or Pointer(nullptr) if not
+    /// \returns a pointer to cached credentials, or nil if none found
     Auth::User::Pointer lookup(const SBuf &userKey) const;
 
     /// add an user to the cache