From: Jeff King Date: Fri, 16 Jan 2015 09:05:57 +0000 (-0500) Subject: strbuf.h: drop boilerplate descriptions of strbuf_split_* X-Git-Tag: v2.4.0-rc0~91^2~1 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/f20e56e202fa2a6cd3faa1710ed9f600ba58ce1d?ds=inline;hp=f20e56e202fa2a6cd3faa1710ed9f600ba58ce1d strbuf.h: drop boilerplate descriptions of strbuf_split_* The description of strbuf_split_buf says most of what needs to be said for all of the split variants that take strings, raw memory, etc. We have a boilerplate comment above each that points to the first. This boilerplate ends up making it harder to read, because it spaces out the functions, which could otherwise be read as a group. Let's drop the boilerplate completely, and mention the variants in the top comment. This is perhaps slightly worse for a hypothetical system which pulls the documentation for each function out of the comment immediately preceding it. But such a system does not yet exist, and anyway, the end result of extracting the boilerplate comments would not lead to a very easy-to-read result. We would do better in the long run to teach the extraction system about groups of related functions. Signed-off-by: Jeff King Signed-off-by: Junio C Hamano ---