Saturday, March 19, 2011

Tcl documentation

After 2-3 days of research, analyzing the available options and trying to work with some doc tools - here is my conclusion for Tcl documentation:

Wiki          -

  • VERY easy
  • Clean documentation
  • Various output types (PDF, HTML, CHM, ...)
  • Supports many languages (If you manually configure it I believe it can support any language). 

I've also tried Doxygen
  • After spending 1/2 a day i gave up configuring it with Tcl.
  • The documentation in the code should have special chars 
    • Ugly inline documentation
    • When pressing F2 (function quick help) this ugly characters make the documentation more ugly.
  • At this stage I gave up.

Major resource pages 

No comments:

Post a Comment