** Summary **
[Richard Suchenwirth] 2004-02-18: I received a document in a markup that I
later found out was Doxygen formatting. As I didn't have Doxygen installed, I
whipped up this little converter that turns it to HTML (on stdout - best pipe
into a file), which was sufficient to make it better readable.
** Description **
The language of Doxygen is of course much more powerful (see
http://www.stack.nl/~dimitri/doxygen/commands.html), but for my limited needs
this was just good enough. If you need to process more Doxygen commands, just
add them (and update this page too, if it's some thing useful). No warranties,
but enjoy!
======
proc xtex2htm {channel filename} {
while {[gets $channel line]>=0} {
set line [string map {
{\li }
\\< \\>
\\verbatim
\\endverbatim
& & < < > >
} $line]
if {$line eq "/*!"} continue
if [regexp {\\mainpage (.+)} $line -> l] {
set line $l
}
if [regexp {\\section (\S+) (.+)} $line -> l h] {
set line "
$h
"
lappend links "$h"
}
if [regexp {\\subsection (\S+) (.+)} $line -> l h] {
set line "
$h
"
lappend links "
$h"
}
if {[string trim $line] eq ""} {set line }
#--- markup C++ comments in code sections
if [regexp {^\s*//} $line] {set line $line}
puts $line
}
puts "
Index
[join $links \n]"
puts "
Converted from $filename on [clock format [clock sec]]"
}
proc prolog {} {
puts
}
proc epilog {} {
puts
}
prolog
if {[llength $argv]} {
foreach file $argv {
set fp [open $file]
xtex2htm $fp $file
close $fp
}
} else {
xtex2htm stdin stdin
}
epilog
======
----
[George Petasis]: There is a small flex tool than act as a doxygen filter, to
generate documentation with doxygen from tcl files. It can be found
[http://therowes.net/~greg/2006/05/07/tcl-filter-for-doxygen/%|%here]
<> Documentation | Arts and Crafts of Tcl-Tk Programming | RS