Re: Where can I find the doxyfile?

From: John Morris <john(dot)morris(at)crunchydata(dot)com>
To: Bohdan Mart <mart(dot)bogdan(at)gmail(dot)com>
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>, Stefan Kaltenbrunner <stefan(at)kaltenbrunner(dot)cc>
Subject: Re: Where can I find the doxyfile?
Date: 2023-10-14 18:54:28
Message-ID: BYAPR13MB267716CD32F5C3B070DFFE90A0D1A@BYAPR13MB2677.namprd13.prod.outlook.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

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 Bohdan Mart 2023-10-14 19:25:19 Re: Where can I find the doxyfile?
Previous Message David Steele 2023-10-14 18:19:42 Rename backup_label to recovery_control