[TYPO3-ect] Documenting Typoscript

[Jeff Segars]

Since this seems to by Typoscript day around the ECT newsgroup (thanks 
Elmar!), I figured I'd make a post that I've been thinking about for a 
while.

In helping with documentation for the Calendar Base extension, I've been 
reminded again how painful it is to provide good documentation for 
Typoscript within an extension manual.  Making sure every option is 
covered is a pain and the challenges only increase when many people are 
working on the code.

I've talked to several people about inline, javadoc-like documentation 
for Typoscript, with the goal of parsing the TS and generating reference 
tables more automatically.  The constant editor already takes a step int 
this direction with its fields, but we'd likely need something a little 
more robust.

Has anyone else given any thought to standardizing inline documentation 
for Typoscript in order to pull it up to higher level documentation?

Thanks,
Jeff