Including Doxyfile and Meson script for docs into main source tree - Mailing list pgsql-hackers

From Bohdan Mart
Subject Including Doxyfile and Meson script for docs into main source tree
Date
Msg-id 4f331bd5-e8ae-4fee-8b08-e363216a0cea@gmail.com
Whole thread Raw
In response to Re: Where can I find the doxyfile?  (John Morris <john.morris@crunchydata.com>)
Responses Re: Including Doxyfile and Meson script for docs into main source tree
List 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
> 



pgsql-hackers by date:

Previous
From: Aleksander Alekseev
Date:
Subject: Re: Explicitly skip TAP tests under Meson if disabled
Next
From: Bruce Momjian
Date:
Subject: Re: COPY TO (FREEZE)?