next up previous
Next: Class Documentation Up: PRIS Programmer's Handbook Previous: Patterns

Documentation

  Documentation of .H files should be done using the syntax specified by Cocoon. This allows us to automatically extract documentation for classes and put it into a web hierarchy. In addition to the benefit of being able to browse and learn the system through hyperlinked documentation, a standard documentation template results in more people documenting the .H file. The current documentation in online. It is possible to look at .H files from there and see the syntax to follow. The manual for Cocoon is also online.





Comments: Brian Edward Smits
Wed Apr 23 17:04:33 MDT 1997