From: Amos Jeffries <squid3@treenet.co.nz>
Date: Tue, 8 Sep 2015 15:48:59 +0000 (-0700)
Subject: Docs cleanup
X-Git-Tag: SQUID_4_0_1~21^2~14
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=e7403d0122b5f77339b10ca1f326acedb8a13293;p=thirdparty%2Fsquid.git

Docs cleanup
---

diff --git a/src/auth/CredentialsCache.h b/src/auth/CredentialsCache.h
index 793c202c75..5fd40059d6 100644
--- a/src/auth/CredentialsCache.h
+++ b/src/auth/CredentialsCache.h
@@ -57,9 +57,7 @@ public:
     /// cache garbage collection, removes timed-out entries
     void cleanup();
 
-    /** obtain sorted list of usernames
-     *
-     */
+    /// obtain alphanumerically sorted list of usernames
     std::vector<Auth::User::Pointer> sortedUsersList() const;
 
     /* RegisteredRunner API */
@@ -69,7 +67,7 @@ public:
 private:
     void scheduleCleanup();
 
-    /// whether a GC event has been scheduled
+    /// whether a cleanup (garbage collection) event has been scheduled
     bool gcScheduled_;
 
     StoreType store_;