Online Help in eLua?

Posted by jbsnyder on
URL: http://elua-development.15.s1.nabble.com/Online-Help-in-eLua-tp2456949.html

I'm not suggesting this for the current release, but I was playing  
around with enumerating the tables for our hardware modules and it  
gave me a thought.

Is there a plan or interest in using metatables to provide simple help  
information for module methods?  I know something like this could  
always quickly grow into something that consumes many kilobytes of  
space, but what about just optional really short descriptions, like  
the following:

 > help(adc.setclock)
setclock( id, clock, [timer_id] ) -- set clock and timer_id for  
channel id

or even just the parameter list:
 > help(adc.setclock)
setclock( id, clock, [timer_id] )

Doing some sort of programmatic generation of the list, I think, would  
be key to make it maintainable.

Maybe this could even be extended so that the documentation could be  
kept inline in the module source and have a script that will take take  
these elements and populate the webbook docs.

Just a thought :-)   I like the idea of only having to update  
documentation in one place and have it be usable in multiple  
contexts.  I'm not thinking it should be too rigid or have a million  
fields that need to be populated, more something that is as simple as  
possible.

--
James Snyder
Biomedical Engineering
Northwestern University
[hidden email]
http://fanplastic.org/key.txt

_______________________________________________
Elua-dev mailing list
[hidden email]
https://lists.berlios.de/mailman/listinfo/elua-dev