gbranden pushed a commit to branch master
in repository groff.

commit e5d97668776aa11e4260503c371a20e5b278ec85
Author: G. Branden Robinson <[email protected]>
AuthorDate: Thu Sep 10 03:01:21 2026 -0500

    src/libs/libbib/index.cpp: Improve annotation.
    
    Better describe function behavior.
---
 src/libs/libbib/index.cpp | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/libs/libbib/index.cpp b/src/libs/libbib/index.cpp
index 7952094b1..ee0a7d5d9 100644
--- a/src/libs/libbib/index.cpp
+++ b/src/libs/libbib/index.cpp
@@ -152,8 +152,8 @@ public:
 inline void unused(void *) { }
 
 // Validate the data reported in the header so that we don't overread on
-// the heap in the load() member function.  Return null pointer if no
-// problems are detected.
+// the heap in the load() member function.  Return string literal
+// characterizing problem, or null pointer if no problems are detected.
 const char *index_search_item::check_header(index_header *file_header,
                                            unsigned file_size)
 {

_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit

Reply via email to