[Pharo-project] Best Class Comment Award.... tada to XMLWriter!
Add this method as XMLWriter class>>help and open the help browser: help <wikiStyleHelp: 'Writing XML'> ^self comment You can now read it in the help system - but it is only a page. Next: change the class comment to use wiki syntax: "!Introduction The class XMLWriter allows you to generate well-formed XML documents using an API similar to Seaside's canvas and tag brush API. !How to use Markup can be created ..." you will get a nice class comment AND a nice book in the help system. So one can easily turn nice class comments into help system books. Have fun T. -- NEU: FreePhone - kostenlos mobil telefonieren und surfen! Jetzt informieren: http://www.gmx.net/de/go/freephone
thanks :) Stef On Feb 2, 2011, at 8:19 AM, Torsten Bergmann wrote:
Add this method as XMLWriter class>>help and open the help browser:
help <wikiStyleHelp: 'Writing XML'> ^self comment
You can now read it in the help system - but it is only a page.
Next: change the class comment to use wiki syntax:
"!Introduction The class XMLWriter allows you to generate well-formed XML documents using an API similar to Seaside's canvas and tag brush API.
!How to use Markup can be created ..."
you will get a nice class comment AND a nice book in the help system.
So one can easily turn nice class comments into help system books.
Have fun T.
-- NEU: FreePhone - kostenlos mobil telefonieren und surfen! Jetzt informieren: http://www.gmx.net/de/go/freephone
participants (2)
-
Stéphane Ducasse -
Torsten Bergmann