fixup: Move problem identification/discussion to C++ comments

Context: https://github.com/squid-cache/squid/pull/1927/files#r1824464433
squid-cache · Oct 31, 2024 · 9fc1ed5 · 9fc1ed5
1 parent 9594244
commit 9fc1ed5
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/refresh.cc b/src/refresh.cc
@@ -570,6 +570,10 @@ refreshIsStaleIfHit(const int reason)
  *
  * \retval 1 if STALE
  * \retval 0 if FRESH
+ *
+ * Do not call this when StoreClient::didCollapse is true. XXX: Callers should
+ * not have to remember to check didCollapse. TODO: Refactor by adding something
+ * like pure virtual StoreClient::refreshCheck() with protocol specializations?
  */
 int
 refreshCheckHTTP(const StoreEntry * entry, HttpRequest * request)