Zen+Docs+-+CLIPS+Class+Documentation

Documentation of classes.
The documentation is available [|here].

Adding the comments in the class' .as file
 The best approach is to compare an existing .as file and its documentation and notice what effect one has on the other. Basically, for every "THING" you want to document in the Help file, include a /** ..... blah blah blah */ block comment immediately before it. This could be methods, properties, or the class description itself. Things that should stand out in the help text often have an @param type line so they are treated (and formatted) slightly differently, often on their own line. Some @ things are ignored, depending on the Help Type documentation template is being used.

If your class does not have an import statement, add one within regular comments //on the first line. e.g.// import edu.clips.ui.*

To create the constructor definition (for the ZenDoc to recognize it as a constructor), the comment must go before the function with the same name as the class - NOT - before the .create function def'n (then it just shows in the list of Methods)

I purposely did NOT comment some of the properties and component _mc s that are created if they were things that are only needed internally by the class, but not needed to be accessible by programmers from the outside.  The block comments define a comment, and it is automatically attached to the thing (variable / function / class ) that follows. IF the thing that follows is in fact commented out (with regular / / comment marks), ZenDocs doesn't care, and still documents it, as if it truly existed. So this is a way to fool ZenDocs into creating the definition for the Event call that is being broadcast inside the class. NOTE: Also needed for ZenDocs to recognize a method as an event is that the function must be declared of type Void, as well as start with onSomething. Leave off the Void function type, and it is just another method. e.g. Good Event that Zen Doc will recognize (even inside comments): / / function onSomethingChanged:Void { / / stuff happens / / }

To create the .html file of documentation
(1) Go to [] (2) Click on LOCAL FILES tab (3) Select the class(es) that you wish to update the documentation for. The classes must reside in Common Source/classes directory (4)Click the DOCUMENT LOCAL button (5) When it is done, access [] to check the results 

Old information for when the documentation was on OAME.


To create the .html file of documentation
(1) Go to [] (2) Click on EXTERNAL FILES tab (3) From Flash (or any text editor), select all the text for the .as file you wish to document, and then EDIT - COPY (4) Then, in the EXTERNAL FILES tab, do CTRL-V (paste) into the Write (*) text area box (with that radio button selected) (5) Choose Template File --> Sample (check radio button) - and select BlueRS.html from the drop down list (6) click the DOCUMENT EXTERNAL button (7) Look at the results - if you like them, then choose VIEW - SOURCE - and save the results in a text editor, with a name ending in .HTML (I think the logical naming convention is the name of the class.HTML ) (or use Dreamweaver and replace an existing version of the HTML file). (8) Upload the file to the correct subfolder of Common Source/classesNEW/docs on the FTP site on isenegger.ca Notes: I have uploaded the most recent version of all the edu.clips.*.* to the OAME /lib/docs/ area, so from the first tab (LOCAL FILES) - you can see them there. It would be nice if we could generate this type of documentation directly from there -= BUT - when I try that (with any template) - it seems to leave off the header part of the documentation (name of the class and overview section)

