[Scilab-Dev] Re: and idea for the development of Scipad

[Michael Baudin]

Hi,

A simple system based on headers is Robodoc :
http://en.wikipedia.org/wiki/ROBODoc
That does not compare, though, with javadoc,Doxygen, etc...

Merging the source and the doc is "literate programming"
and may be possible with Knuth's LaTeX :
http://www.haskell.org/haskellwiki/Literate_programming

Doxygen (or Javadoc) additionnaly takes into
account the structure of the source code to generate the
doc. For example, it computes (i.e. parses) the number of arguments,
their name, the class hierarchy (etc...) and uses that
information to generate the doc. This is more complicated
(and powerful) than just collecting data after some
pre-defined tag, but allows the developer to miminize the
size of the header.

When Scilab v6 will be available, the parser may allow
a connection between the interpreter and the editor,
so that the generation of the doc may be done
based on Scilab's introspection features.
But a lot of work is necessary until this is possible, isn'it it ?

Regards,

Michaël

Collette Yann a écrit :
> And what about a doxygen for scilab ?
> You get everything after //
> With some markups, you fill an xml fill and then generate the help page.
> If then help page is younger than the sci file, the help page is not 
> regenerated ...
>
> YC
>