[PATCH wayland 4/5] man: Add man pages for event dispatch client functions

Tiago Vignatti tiago.vignatti at linux.intel.com
Mon Dec 3 05:35:04 PST 2012


On 12/03/2012 11:23 AM, Jonas Ådahl wrote:
> On Mon, Dec 3, 2012 at 2:06 PM, Tiago Vignatti
> <tiago.vignatti at linux.intel.com> wrote:
>> We have every entry-point documented on the code now, using doxygen style,
>> with all classes referenced and so on. So, something we discussed before was
>> to automate most of the man-page contents based on the doxygen output. I
>> mean, this patch is nice, but have you thought about automating the man-page
>> instead?
>
> I was not familiar with these plans and thought we were to write man
> pages as it was already started by David. Anyhow, I have no objections
> to using doxygen if that is what is preferred. In that case I'd vote
> for dropping the doc/man directory.

it's not about dropping doc/man but to feed it with the already existent 
documentation that we have on the code. We still want man-pages but if 
we could automate instead duplicating the writing effort then would be 
great. Something to check is whether doxygen -> man-page works in fact 
(GENERATE_MAN = YES, in wayland.doxygen.in).

Tiago



More information about the wayland-devel mailing list