Improve Doxygen Comments for <iterator> Contents
This commit enhances Doxygen documentation for iterators in libstdc++ by using markdown, suppressing internal details, and improving comment wording.
This commit enhances the Doxygen documentation for iterators in the C++ standard library. It uses markdown formatting in comments, prevents internal namespaces like __detail from being documented as part of the Iterators topic, marks internal helpers as undocumented, and improves the wording of existing comments for functions like distance and advance and classes like iterator_traits.
In Details
The libstdc++ uses Doxygen to generate documentation. This commit modifies <bits/stl_iterator.h>, <bits/stl_iterator_base_funcs.h>, and <bits/stl_iterator_base_types.h> to improve the generated documentation for iterators. It suppresses documentation for internal namespaces and improves the wording and formatting of existing comments.
For Context
Iterators are a fundamental concept in C++ used to traverse collections of data. Doxygen is a tool that automatically generates documentation from source code. This commit improves the quality and clarity of the documentation for iterators in the C++ standard library, making it easier for developers to understand and use them correctly. It hides internal implementation details and clarifies the purpose and usage of key iterator components.