[fpc-devel] convert comment help to fpcdoc

[Marco van de Voort]

In our previous episode, Michael Schnell said:
> > Do we have any tool to convert documentation written in javadoc style
> > (those comments in the source code) to fpdoc xml? I like to write my
> > documentation as comments...
> As several different help formats are used and can be created from the 
> help sources (is that LateX plus source-core comments ?).

No, it is more wiki like tags in an XML format. But that is out of source
docs, what is currently most prefered by the documentation author. (and I
like it more to)

In theory, you could write something that parses the comments and writes it
out as XML, and then fpdoc to generate the docs. Or one could use pasdoc.

But I think it is really bad to have many different tools in the same
project, that doesn´t make sense.

: I think for 
> compatibility, any additional converter from another format should 
> target  a format that can be used as source for the help file 
> constructing make system.

In a perfect world maybe. But in reality the documentation content is
connected with the language and the output formats. Such converters would
only yield the lowest common denomitor of formatting.