Re: [Libclc-developers] Suggested documentation format

[<bo...@me...>]

Hallvard B Furuseth wrote:
> Here is a suggestion for a file format for documentation.
> Contributors should write this, though maybe the documentation
> manager(s) will clean the file up a little, and it will be used to
> generate the other formats. If accepted, I'll write a Perl program to
> process it.  The overall documentation structure reflects Unix man
> pages, as in <http://libclc.sourceforge.net/documentation-policy.txt>.
> I've also added an initial NAME section.  (Bertrand, are you there?:-)
> 
> Comments welcome.

No comments, just a question or two.

Your suggestion give me the impression that you have done this before. 
If so, have you previously evaluated tools and formats like Doxygen and 
DocBook?

My personal experience is that Doxygen will give us most or everything 
of what we need, but I have no experience with neither SGML nor DocBook. 
If Doxygen does what we need and is widely used, well documented and 
mature, do we need our own format and toolset?

BTW, there seems to be a lot of confusion about doxygen. We don't have 
to tag everything and we don't have to write the documentation in the 
source/header files. Doxygen will process any file we ask it to process. 
;-)

Bjørn