@file and @headername directives

[Kim Gräsman]

Thank you!

On Sun, Aug 18, 2024 at 7:50 PM Jonathan Wakely <jwakely.gcc@gmail.com>
wrote:

>
> I wouldn't be opposed to it though. IWYU is a nice tool and I'd love if it
> worked well with our headers. If being a bit more regular would help you,
> even if it's not strictly needed for doxygen, that seems like a reasonable
> change. As long as doxygen still works of course.
>

I've played around with this a bit after working through getting GCC and
libstdc++ built. I found this page, which describes nicely the
prerequisites and available doc targets:
https://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_hacking.html.

Unfortunately I haven't been able to find a working Doxygen 1.7.6.1 -- is
that still the only supported version? My Ubuntu appears to come with
1.9.1, so I don't think that qualifies for testing.


> Ideally we'd be able to add tests to check that we don't regress in future
> by introducing new headers that don't follow the new convention. But
> failing that it would be OK to just document the convention.
>

Yeah, that would be nice, but also maybe overshooting the importance a bit
:-). We'll need to be very tolerant in IWYU anyway, since there's so many
libstdc++ versions in circulation.

The doc page I linked appears to have quite nice guidelines for @file
already, so at least there's a good place to firm things up should that
become necessary.

- Kim

>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://gcc.gnu.org/pipermail/libstdc++/attachments/20240823/032a042f/attachment.htm>