]> git.ipfire.org Git - thirdparty/gcc.git/commit
libstdc++: Reduce duplication in Doxygen comments for std::list
authorJonathan Wakely <jwakely@redhat.com>
Mon, 25 Nov 2024 23:01:28 +0000 (23:01 +0000)
committerJonathan Wakely <redi@gcc.gnu.org>
Thu, 28 Nov 2024 15:27:27 +0000 (15:27 +0000)
commit3f3966b5a3103ab198257b62bd7563996f2f6f65
treed67e33dcd094177e98c978c74d274113ccacce16
parentc43527216622a119feb0d2ca4c0d8dd37463fe0a
libstdc++: Reduce duplication in Doxygen comments for std::list

We have a number of comments which are duplicated for C++98 and C++11
overloads, where the signatures are slightly different. Instead of
duplicating the comments that are 90% identical, just use a single
comment that can apply to both. In some cases this means saying "an
iterator" instead of "A const iterator" but that's fine, a
std::list::const_iterator is still an iterator (and a non-const iterator
is a valid argument to those functions because they'll implicitly
convert to const_iterator).

In two cases the @return description just needs to say that it returns
void for C++98 and an iterator otherwise.

libstdc++-v3/ChangeLog:

* include/bits/stl_list.h: Reduce duplication in doxygen
comments.
libstdc++-v3/include/bits/stl_list.h