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

[Collette Yann]

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

Sylvestre Ledru a écrit :
>> My idea is that documentation could be written and maintained as part
>> of  the head_comment section of the .sci file, and that help_from_sci
>> should be used for generation of the final xml files. This would
>> eliminate any sync issues. 
>>     
> So, if I understand correctly, for a 3 pages documentation, you would
> put everything into the source ?
>
>   
>>> On the practical side I'm wondering about implementation. 
>>>
>>> Indeed, the Scipad menu entry "File/Create help skeleton" basically
>>> is a wrapper around the Scilab function help_skeleton. It is easy to
>>> call another function instead of help_skeleton. You can see the
>>> details in proc helpskeleton (in file scilabexec.tcl). Calling
>>> help_from_sci instead of help_skeleton is straightforward. 
>>>
>>> However, first of all I would add another entry in the file menu
>>> (e.g. "File/Create help from function header comments" or something
>>> alike), rather than replacing the existing entry. Some users would
>>> like to keep the vanilla help_skeleton perhaps. 
>>>       
>> This sounds interesting. I'll take a look at the tcl files. It could
>> be a nice feature to add to the toolbox. 
>>     
> Yep, this could be a great feature for Scipad to automatically generate
> a help from the profile!
>
> Sylvestre
>
>
>