On Mar 5, 2010, at 7:50 AM, Danny Chan wrote:
<classcomment> Here comes the comment for the class </classcomment>
Why XML?
No special reason, just made up something, so that both a normal class comment and the big picture documentation for the package can coexist.
In addition I would like to have a tag for promoting test to be list in the help. <documentation>
Hm, I just thought about this: Why not have one pragma, call it <help:>, that takes as an argument some kind of string encoded path, for example for a test with a nice example something like this:
testInstanceCreation <help: 'Examples/Instance Creation'>
"Here we show some different ways to create new instances"
...
And then in addition to API documentation that strictly follows the class structure we have dynamically generated books that are structured along the help pragmas.
Yes!! I proposed that several times already. Could be prefixed automatically by the package in which the method is defined.
Danny
_______________________________________________ Pharo-project mailing list Pharo-project@lists.gforge.inria.fr http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project