Re: [Tcllib-devel] Questions about writting the docs and selenium-tcl

[Lars H. <Lar...@re...>]

Andreas Kupries skrev 2015-05-27 01.28:
>> It also seems that there is no standard way to generate automatically
>> documentation from the source code.
> That is true. There are Tcl-based tools around, but not a standard one.
> See
>    * tcldoc -http://wiki.tcl.tk/5598
>    * autodoc -http://wiki.tcl.tk/2799  (myself, old)
>    * tdoc -http://wiki.tcl.tk/7577
>
> Doxygen (http://wiki.tcl.tk/17438) seems to be a general standard, and
> is able to parse Tcl code.
>
>> Is there some library with respect to this in tcllib?
> No.

That last part is actually not quite true: the docstrip package for this 
_is_ in tcllib. However, that follows the Literate Programming paradigm of 
making the program part of the documentation rather than (as with the tools 
above) making the documentation part of the program.

The cleanest example of using it is probably the math::numtheory package, 
see modules/math/numtheory.dtx for the true source of that.

And while docstrip may be standard in the LaTeX world, it is certainly not 
so in the Tcl world (even if tcllib's sak.tcl has support for it).


Lars Hellström