Including Doxyfile and Meson script for docs into main source tree

From: Bohdan Mart <mart(dot)bogdan(at)gmail(dot)com>
To: Stefan Kaltenbrunner <stefan(at)kaltenbrunner(dot)cc>
Cc: "pgsql-hackers(at)postgresql(dot)org" <pgsql-hackers(at)postgresql(dot)org>, 'Bruce Momjian' <bruce(at)momjian(dot)us>, "postgres(at)coyotebush(dot)net" <postgres(at)coyotebush(dot)net>, John Morris <john(dot)morris(at)crunchydata(dot)com>
Subject: Including Doxyfile and Meson script for docs into main source tree
Date: 2023-10-30 13:57:08
Message-ID: 4f331bd5-e8ae-4fee-8b08-e363216a0cea@gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Hello, Stefan!

What do you think about this? See quoted message from John Morris.

P.S. Also we would like you to provide currently used Doxyfile, as
Postgres doxigen's home page no longer have link to download said file.

Regards,
Bohdan.

On 14.10.23 21:54, John Morris wrote:
> Thank you for trying the patch out and commenting on it.
>
> I'm starting to think of it as a project. Here's a quick project statement.
>
> The purpose is to generate improved  Doxygen output while making maximal
> use of how Postgres currently does program comments.
>
> Thinking in terms of specific steps, and adding to what you have mentioned:
>
> * Configure Doxyfile so it produces output similar to previous output.
> * Only build Doxygen output if requested
> * Don't compile the filter or configure the Doxyfile  if they aren't
> needed
> * Include contrib in the sources to document
> * Provide options for other (non-html) output. (Which ones?)
> * Update Postgres documentation to include instructions for creating
> Doxygen output.
> * Mention it in developer guidelines and provide sample code showing a
> "desired" commenting style.
>
> Does that list seem complete? I don't want people to think we're
> imposing new standards or legislating new commenting styles.  It's more
> a matter of describing what we currently do, maybe with some minor
> suggestions for improving.
>
> * John Morris
>

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Bruce Momjian 2023-10-30 13:58:20 Re: COPY TO (FREEZE)?
Previous Message Aleksander Alekseev 2023-10-30 13:47:14 Re: Explicitly skip TAP tests under Meson if disabled