[Pharo-project] Best Class Comment Award.... tada to XMLWriter!

Torsten Bergmann astares at gmx.de
Wed Feb 2 08:19:05 CET 2011


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




More information about the Pharo-project mailing list