From: Amos Jeffries <yadij@users.noreply.github.com>
Date: Tue, 8 Aug 2023 19:16:24 +0000 (+0000)
Subject: Maintenance: stop using doxygen bug markers (#1445)
X-Git-Tag: SQUID_6_3~9
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d3891815482686359840c95f21f7c2d58ff5d679;p=thirdparty%2Fsquid.git

Maintenance: stop using doxygen bug markers (#1445)
---

diff --git a/squid.dox b/squid.dox
index 1aab569b9e..cc841bbe2b 100644
--- a/squid.dox
+++ b/squid.dox
@@ -632,7 +632,7 @@ GENERATE_TESTLIST      = YES
 # list. This list is created by putting \bug commands in the documentation.
 # The default value is: YES.
 
-GENERATE_BUGLIST       = YES
+GENERATE_BUGLIST       = NO
 
 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
 # the deprecated list. This list is created by putting \deprecated commands in
diff --git a/src/DiskIO/AIO/AIODiskFile.h b/src/DiskIO/AIO/AIODiskFile.h
index 707aed1974..fa39824851 100644
--- a/src/DiskIO/AIO/AIODiskFile.h
+++ b/src/DiskIO/AIO/AIODiskFile.h
@@ -28,7 +28,7 @@ public:
     AIODiskFile (char const *path, AIODiskIOStrategy *);
     ~AIODiskFile() override;
 
-    /// \bug the code has this as "IORequestor::Pointer callback"
+    // XXX: the code has this as "IORequestor::Pointer callback"
     void open(int flags, mode_t mode, RefCount<IORequestor> callback) override;
 
     void create (int, mode_t, RefCount<IORequestor>) override;
diff --git a/src/fs/ufs/RebuildState.h b/src/fs/ufs/RebuildState.h
index a1591e91a3..7e33fc813d 100644
--- a/src/fs/ufs/RebuildState.h
+++ b/src/fs/ufs/RebuildState.h
@@ -75,7 +75,7 @@ private:
     int getNextFile(sfileno *, int *size);
     bool fromLog;
     bool _done;
-    /// \bug (callback) should be hidden behind a proper human readable name
+    // TODO: (callback) should be hidden behind a proper human readable name
     void (callback)(void *cbdata);
     void *cbdata;
 };
diff --git a/src/http.cc b/src/http.cc
index 141305249d..f4e96aacd5 100644
--- a/src/http.cc
+++ b/src/http.cc
@@ -1100,11 +1100,10 @@ HttpStateData::statusIfComplete() const
     /** \par
      * What does the reply have to say about keep-alive?
      */
-    /**
-     \bug XXX BUG?
+    /* XXX: BUG?
      * If the origin server (HTTP/1.0) does not send a keep-alive
      * header, but keeps the connection open anyway, what happens?
-     * We'll return here and http.c waits for an EOF before changing
+     * We'll return here and wait for an EOF before changing
      * store_status to STORE_OK.   Combine this with ENTRY_FWD_HDR_WAIT
      * and an error status code, and we might have to wait until
      * the server times out the socket.
diff --git a/src/icmp/Icmp.h b/src/icmp/Icmp.h
index e1227c0cfb..a24de2d0cc 100644
--- a/src/icmp/Icmp.h
+++ b/src/icmp/Icmp.h
@@ -109,8 +109,8 @@ protected:
      \param ttl n(129...192) : 64 >= n >= 1
      \param ttl n(193...)    : n < 255
      *
-     \bug BUG? ttl<0 can produce high hop values
-     \bug BUG? ttl>255 can produce zero or negative hop values
+     * XXX: BUG? ttl<0 can produce high hop values
+     * XXX: BUG? ttl>255 can produce zero or negative hop values
      */
     int ipHops(int ttl);
 
diff --git a/src/icmp/IcmpSquid.cc b/src/icmp/IcmpSquid.cc
index f334d10e7a..988aa0ce02 100644
--- a/src/icmp/IcmpSquid.cc
+++ b/src/icmp/IcmpSquid.cc
@@ -64,8 +64,8 @@ IcmpSquid::SendEcho(Ip::Address &to, int opcode, const char *payload, int len)
         len = 0;
 
     /** \li Otherwise if len is 0, uses strlen() to detect length of payload.
-     \bug This will result in part of the payload being truncated if it contains a NULL character.
-     \bug Or it may result in a buffer over-run if the payload is not nul-terminated properly.
+     * XXX: This will result in part of the payload being truncated if it contains a NUL character.
+     *      Or it may result in a buffer over-read if the payload is not NUL-terminated properly.
      */
     else if (payload && len == 0)
         len = strlen(payload);