Re: Where can I find the doxyfile?

From: Stefan Kaltenbrunner <stefan(at)kaltenbrunner(dot)cc>
To: Bohdan Mart <mart(dot)bogdan(at)gmail(dot)com>, postgres(at)coyotebush(dot)net, john(dot)morris(at)crunchydata(dot)com
Cc: pgsql-hackers(at)postgresql(dot)org, 'Bruce Momjian' <bruce(at)momjian(dot)us>
Subject: Re: Where can I find the doxyfile?
Date: 2023-10-09 08:38:54
Message-ID: 40f09999-19c0-4333-8615-1e90ef5727c4@kaltenbrunner.cc
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On 07.10.23 00:23, Bohdan Mart wrote:
>
> On 07.10.23 00:29, postgres(at)coyotebush(dot)net wrote:
>> Sometime earlier, I created a filter to annotate regular C comments as
>> doxy
>> comments.  I'll attach it along with a sample doxyfile for running
>> it.  Just
>> in case it looks useful.
>>
>> I've never been a big fan of Doxygen, but it seems to have gotten better
>> over time. Now that some IDEs display doxy comments on hover, I'm
>> beginning
>> to appreciate it.
>
> Thank you for providing this `flex` filter! It is actually useful. I've
> tested it on one
>
> file from postures source base, and it actually converted regular
>
> comments to doc-comments! If this filter could be used by official
>
> Doxygen generation of Postgres, it would highly increase quality
>
> of online documentation of Postgres!

I have not actually looked at the code of the filter itself but
personally I'm not super happy with doing a C-based filter as part of
our doxygen documentation generation step - that seems like an
additional maintainance burden infrastrukcture wise - is there nothing
more lightweight available(assuming we even want that)?

Stefan

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Heikki Linnakangas 2023-10-09 08:52:58 Re: Checks in RegisterBackgroundWorker.()
Previous Message Laurenz Albe 2023-10-09 08:29:07 Re: Fix output of zero privileges in psql