[MAKR], 2004/11/18: I noticed - and came across the same problem - people on [comp.lang.tcl] are regularly asking for tools to automatically generate documentation from source code. It seems no page is currently dedicated to maintain a list of tools available for Tcl. So let's start here (in no particular order): * [autodoc] * [ddoc] * [docstring] using leading comment in [proc] bodies * [docstrip] * [docstrip and tclldoc] - Literate programming the scripting way * [doctools] - this is more a generic [markup language] tool * [doxygen] - documentation tool; can be used for tcl with a filter/pre-processor [http://therowes.net/~greg/software/tcl-doxygen-filter/tcl-dox-0.6.tar.gz] [http://therowes.net/~greg/download/tcl-doxygen-filter/] [A little doxygen converter] * [HelpSystem] interactive help doc embedded into tcl/tk code - kind of different * [robodoc] * [Sdoc] * Simpledoc [http://pietersz.co.uk/software/simpledoc] - very simple: generates HTML from source with markup in comments. * [src2tex] * [tcl2tex] * [tcldoc] - similar to javadoc * [tdoc] * [TL] - this is a glue language that has auto documentation functions * [TMML] - this is more a generic [markup language] tool * [tna] * [tycho] - this [GUI] [itcl] dev environment included a system to create [HTML] from [itcl] classes * [zdoc] * [feathers: an hand-written documents tool] * [NaturalDocs] - attempts to parse code docs written in a very natural manner * [XOTcl Documentation Tool] ---- * [ParseTools] - extension that can be used to write documentation extractors * [The Simple Library] - framework to support nearly literate programming doc ---- ''[escargo] 21 Apr 2005'' - One thing to keep in mind with these tools is that some of them might be used with [OO] systems that extend the Tcl syntax, [Snit] for example. Now, instead of just need to track [proc] definitions, [namespace]s, and [global] variables, you might want to keep track of classes, [method]s, typemethods, and other interesting extended Tcl syntax. I haven't looked at all of these tools, but I know that [robodoc] made it possible to handle pretty arbitrary ''things'' to track and document. ---- [MAKR], 2006-12-08: Half a year ago I decided to move over to [robodoc]. I now have all in-source documentation (C and Tcl) converted to this format. This was one of the best ideas I ever had. The commentary in the sources is clean and readable. The resulting HTML documentation is it too. You can format it to your liking using CSS... ''[escargo] -'' Do you use any [OO] extensions, or just plain [Tcl]/[Tk]? [MAKR], 2006-12-13: As it gets tool specific, I continue at the [robodoc] page ... ---- [MAKR], 2007-12-14, just stumbled over discussions about the Tcl [user documentation project] and also saw an URL [http://www.linux.com/articles/34212] at [c.l.t.] about how to write [manpages]. ---- [Tcl Style Guide] has a couple of recommendations about documentation near the end of the page. ---- !!!!!! %| [Category Documentation] |% !!!!!!