File	Date	Author	Commit
bin	2010-09-25	wtschueller	[249751] detect changed source files with hg stat
doc	2010-04-04	wtschueller	[82bfb0] updated binaries and documentation
patches	2010-03-07	wtschueller	[06f814] these patches make fickle and taccle generate c...
release	2010-05-13	wtschueller	[e0e922] updated build tools to use hg for status check
src	2010-09-05	wtschueller	[ee7b89] account for brackets inside quoted strings
test	2010-09-05	wtschueller	[a29c92] manual review, is ok
.hgtags	2010-05-13	convert-repo	[b7b2bd] update tags
LICENSE	2010-01-24	wtschueller	[aae9b5] added license and readme
Makefile	2010-05-02	wtschueller	[950155] included build script into release, mentioned s...
README	2010-05-13	wtschueller	[dcef41] updated changelog

Read Me

A NEW ATTEMPT TO MAKE DOXYGEN DOCUMENT TCL SCRIPTS

I have been using tcl-dox for a while. It is a nice programme
to make doxygen produce documentations for tcl programmes.
Tcl-dox is a flex generated scanner. A sophisticated one, of course.

Last year the author of tcl-dox has abandoned the flex approach
because of it being error prone and difficult to maintain.
Well, as I also developed some enhancements for my own scripts
I can confirm this. Anyway, thank you Greg for starting out
with tcl-dox and making it a rather useful tool.

As for me, I am not willing to give up the generator approach
for the moment. I have used fickle and taccle in the past.
They are the tcl counterparts of lex and yacc. So what would be
more obvious than a tcl only approach? Now, the Tclers can
write their doxygen input filter in Tcl!

Tcl2doxy is a new start from scratch. I tried to set up a frame work
first which is easy to maintain and develop. Therefore the current
code is far from the capabilities of tcl-dox. However, it can
document itself nicely. Freewrap produces the binaries.

W T Schueller, January 2010



CONTENTS

The archive contains the following files:
LICENSE             license
Makefile            used to build everything
README              this file
bin/tcl2doxy.exe    Windows binary (32bit)
bin/tcl2doxy        Linux binary (32bit)
bin/build.tcl       wrapper script
doc/tc2doxy.chm     source documentation of tcl2doxy itself
doc/Doxyfile        example of Doxygen configuration file
src/*.*             source files, note that parser.tcl and lexer.tcl are generated files



USAGE

Just put the tcl2doxy binary somewhere in your executable path, for instance
in the bin subdirectory of your doxygen installation. Then configure it as
input filter for your Tcl/Tk source files. The doc/Doxygen gives you en example



BUILD

Only a make command, the sdx.kit and a tclkitsh for your architecture (and another
one for the target architecture if different) is necessary to build tcl2doxy.
Put them into the bin subdirectory. You may also need to tweak the Makefile to
fit your installation. Type "make bin". Rename the binary.



CHANGELOG

Release 0.2, April 2010
* included all build tools

Release 0.1, April 2010
* initial beta release