On Dec 23, 2011, at 1:40 AM, Igor Galić wrote:

> 
> 
> ----- Original Message -----
>> Hi all,
>> 
>> I made a start on converting the v2 SDK reference pages to section 3
>> man pages. If this is the desired approach for reference material
>> and they look OK on the supported OSs, I can convert a few more ...
> 
> As you can see in the new docs I dropped the SDK reference because
> I felt it wrong to maintain reference documentation in two places.
> To me personally an up-to-date Doxygen is more worth - I think we
> could go from *there* to create man pages - thoughts?

You could do either man <- doxygen -> html or man -> html.

I haven't ever used the doxygen man page generation; google seems to have mixed 
feedback. I've previously used the docbook stuff and it was pretty painful. You 
end up having to to a lot of silly things to get the man formatting reasonable. 
mdoc is tedious but it's a pretty simple toolchain and easy to work from 
examples.

I don't have a strong opinion either way, but I agree that you don't want to 
have to maintain documentation in 2 places. It's important that there be a 
strong consensus on what people are willing to maintain and contribute to.

J

> 
> 
>> cheers,
>> James
> 
> i
> 
> --
> Igor Galić
> 
> Tel: +43 (0) 664 886 22 883
> Mail: i.ga...@brainsware.org
> URL: http://brainsware.org/
> GPG: 6880 4155 74BD FD7C B515  2EA5 4B1D 9E08 A097 C9AE
> 

Reply via email to