[Pharo-project] [COTDC] 8 - WikiStyleHelpBuilder
Today: WikiStyleHelpBuilder Comment Of The Day Contest - One Day One Comment Rules: #1: Each day a not commented class is elected. Each day the best comment will be integrated with name of the author(s). #2: If you cannot comment it, deprecate it. Results: http://code.google.com/p/pharo/wiki/CommentOfTheDayContest Laurent
I'm an HelpSystem builder which create an HelpSystem book from a wiki-like formatted string. ! Usage - Create a class-side method on the class you want to put documentation. - Add the pragma <wikiStyleHelp:> with the title of the book as parameter - The method should answer the documentation as a String (using Pier syntax. See http://www.piercms.com/doc/syntax ). ! Example MyClass class>>aMethod <wikiStyleHelp: #'The name of the book I want to write'> ^ ' ! Section 1 Some text for this section !! Subsection 1.1 !!! Subsection 1.1.1 !! Subsection 1.2 ! Section 2' And add WikiStyleHelpBuilder class>>help <wikiStyleHelp: #'Write documentation with wiki like syntax'> ^ self comment Laurent On Fri, Feb 11, 2011 at 6:29 PM, laurent laffont <laurent.laffont@gmail.com>wrote:
Today: WikiStyleHelpBuilder
Comment Of The Day Contest - One Day One Comment Rules: #1: Each day a not commented class is elected. Each day the best comment will be integrated with name of the author(s). #2: If you cannot comment it, deprecate it. Results: http://code.google.com/p/pharo/wiki/CommentOfTheDayContest
Laurent
participants (1)
-
laurent laffont