Archive of user RTAI additions?

Paolo Mantegazza mantegazza at aero.polimi.it
Fri Jan 20 10:15:29 CET 2006


Stienen, A.H.A. (CTW) wrote:
> I see your 'easy to maintain' point, but perhaps we can add the
> 'requirement' of a minimal amount of documentation in the comments of
> the S-function. For instance, for each of the following subject a couple
> of lines:
>     
>     - Short summary
>     - Version, authors(s)
>     - Installation (compiling, lines to add to .mdl files, etc.)
>     - How to use

I think it's OK. Somebody we'll care of checking for a minimal doc like 
the above.

Paolo.

> Arno.
> 
> Paolo Mantegazza wrote:
> 
>> Marco Romagnoli wrote:
>>
>>> It could be really useful to have a standard format for all 
>>> S-functions and add-on!
>>> Good idea! In particular for the documentation in order to avoid 
>>> consuming time to understand where information is and imediately 
>>> start using it.
>>
>>
>>
>> My idea was to have a text file for each Sfun and a README index for 
>> the related site download directory. Not much sofisticated but simple 
>> to maintain.
>>
>> Paolo.
>>
> 






More information about the Rtai mailing list