Including Doxyfile and Meson script for docs into main source tree

Поиск
Список
Период
Сортировка
От Bohdan Mart
Тема Including Doxyfile and Meson script for docs into main source tree
Дата
Msg-id 4f331bd5-e8ae-4fee-8b08-e363216a0cea@gmail.com
обсуждение исходный текст
Ответ на Re: Where can I find the doxyfile?  (John Morris <john.morris@crunchydata.com>)
Ответы Re: Including Doxyfile and Meson script for docs into main source tree
Список 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 по дате отправления:

Предыдущее
От: Aleksander Alekseev
Дата:
Сообщение: Re: Explicitly skip TAP tests under Meson if disabled
Следующее
От: Bruce Momjian
Дата:
Сообщение: Re: COPY TO (FREEZE)?