From: Alex Rousskov <rousskov@measurement-factory.com>
Date: Tue, 27 Feb 2018 00:25:16 +0000 (-0700)
Subject: Fixed a dangerous lie in the dereferenceIdle() description (#163)
X-Git-Tag: SQUID_4_0_24~4
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=4ab6b593f9f749961d561bafe38567a5bc5c01f9;p=thirdparty%2Fsquid.git

Fixed a dangerous lie in the dereferenceIdle() description (#163)

Also moved private Controller method descriptions to .cc per convention.
---

diff --git a/src/store/Controller.cc b/src/store/Controller.cc
index 0affe2edb7..bebc65e05c 100644
--- a/src/store/Controller.cc
+++ b/src/store/Controller.cc
@@ -233,6 +233,7 @@ Store::Controller::callback()
     return result;
 }
 
+/// update reference counters of the recently touched entry
 void
 Store::Controller::referenceBusy(StoreEntry &e)
 {
@@ -256,6 +257,8 @@ Store::Controller::referenceBusy(StoreEntry &e)
     }
 }
 
+/// dereference()s an idle entry
+/// \returns false if and only if the entry should be deleted
 bool
 Store::Controller::dereferenceIdle(StoreEntry &e, bool wantsLocalMemory)
 {
diff --git a/src/store/Controller.h b/src/store/Controller.h
index 1bce65e8f7..3a5290059c 100644
--- a/src/store/Controller.h
+++ b/src/store/Controller.h
@@ -136,9 +136,7 @@ public:
 private:
     bool memoryCacheHasSpaceFor(const int pagesRequired) const;
 
-    /// update reference counters of the recently touched entry
     void referenceBusy(StoreEntry &e);
-    /// dereference() an idle entry and return true if the entry should be deleted
     bool dereferenceIdle(StoreEntry &, bool wantsLocalMemory);
 
     void allowSharing(StoreEntry &, const cache_key *);