Re: Where can I find the doxyfile?

Поиск
Список
Период
Сортировка
От John Morris
Тема Re: Where can I find the doxyfile?
Дата
Msg-id CYXP222MB09470CFBA2CDEF081D28FAEDA0472@CYXP222MB0947.NAMP222.PROD.OUTLOOK.COM
обсуждение исходный текст
Ответ на Re: Where can I find the doxyfile?  (John Morris <john.morris@crunchydata.com>)
Ответы Re: Where can I find the doxyfile?  (Peter Eisentraut <peter@eisentraut.org>)
Re: Where can I find the doxyfile?  (Bruce Momjian <bruce@momjian.us>)
Список pgsql-hackers

>> It seems something you want to keep for your personal use. 

>> I think this filter is the kind of genious idea that it's OK if you

>> can do it at home

 

I don’t agree with your characterization.

 

The purpose of the filter is to bring existing Postgres comments into the doxygen output. While I haven’t done a full survey, the majority of Postgres code has comments describing functions, globals, macros and structure fields.

 

Currently, those comments are thrown away. They do not appear in the existing Doxygen output.

 

The filter itself is not rocket science. It is a straightforward scanner built using the flex tool. I understand many people are more comfortable with perl or python, but flex is uniquely appropriate for creating small, efficient scanners.

 

The resulting output is not perfect. However, it is a major step forward from what we are currently producing. Over time, we can gradually update Postgres comments to fill in missing information. Eventually, doxygen output could become a “first look” tool for looking at code.

 

Will it be my “first look” tool. Not likely. Like you, I am comfortable with Intellij and VsCode. I have my build environments already set up.

 

I do not see this as a high-risk endeavor. It is “off to the side” of the main Postgres code. It takes an existing tool, doxygen, which is mostly useless, and starts to make it usable.

 

As an aside, I have contacted Intellij about allowing custom Doxygen files for hover information. No reply yet, but it would allow us to tailor our IDEs to display the information we need most.

 

 

В списке pgsql-hackers по дате отправления:

Предыдущее
От: Alexander Lakhin
Дата:
Сообщение: Re: On login trigger: take three
Следующее
От: Alvaro Herrera
Дата:
Сообщение: Re: cataloguing NOT NULL constraints