[Sc-devel] autoHelp?
Andrea Valle
valle at di.unito.it
Sun Nov 4 12:56:25 PST 2007
Hi to all,
I was writing some docs for a project trying to follow the guide
lines. I appreciate a lot their presence, no problem with UGen and
Topic, but I find extremely boring to write all the stuff
related to Class help files, respecting the required format.
I see there's been a lot of work in automatic documentation (I mean:
Help.gui, Class.browse).
Is there anyone working on a Class method generating the html help
file (e.g. Collection.makeHelp)? So that you have all methods and
args listed in the opportune layout following the guide line, and you
have to to complete/clean the resulting document (e.g. removing the
private or not relevant methods, replacing dummy lines with real
content etc).
I think it could greatly help the consistency of new documentation.
I was starting working at it, but maybe there's something already
done. More, I know nothing about help file creation from rtf etc.
Best
-a-
--------------------------------------------------
Andrea Valle
--------------------------------------------------
CIRMA - DAMS
Università degli Studi di Torino
--> http://www.cirma.unito.it/andrea/
--> andrea.valle at unito.it
--------------------------------------------------
I did this interview where I just mentioned that I read Foucault. Who
doesn't in university, right? I was in this strip club giving this
guy a lap dance and all he wanted to do was to discuss Foucault with
me. Well, I can stand naked and do my little dance, or I can discuss
Foucault, but not at the same time; too much information.
(Annabel Chong)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://www.create.ucsb.edu/pipermail/sc-devel/attachments/20071104/c03262ba/attachment.htm
More information about the Sc-devel
mailing list