[Doxygen-users] TCL support?
Brought to you by:
dimitri
|
From: Oren Ben-K. <or...@be...> - 2003-04-14 19:13:39
|
I have a project that mixes C, C++ and TCL. I'm using Doxygen for the
C/C++ parts. The best I could come up for the TCL files is the following
hack:
- Add '*.tcl' to the FILE_PATTERNS
- Each TCL file is wrapped with comments like this:
# /** \file <name>
# one line description
# */
# ifdef NEVER
... The file ...
# endif // NEVER
This causes Doxygen to at least list the file in the files list, specify
a one-line text about it, and include a link to the source. Note that a
multi-line description would include a '#' at the end of each line;
there is already a "# #" at the start and the end of the text Doxygen
places in the documentation.
Of course, this isn't really using Doxygen, since I don't get a listing
of namespaces, procedures, packages, cross-references etc. I can push
things a bit further by writing inside the file something like:
# endif // NEVER
# /** \namespace <name>
# one line description
# */
# ifdef NEVER
namespace eval ::<name>:: {
... The namespace ...
}
But that's just too horrible, even disregarding the restriction to
one-line descriptions.
Is there some way to convince Doxygen to handle TCL sources? I know that
there was some attempt to make Doxygen understand iTcl, but it never
made it into the main branch. Does anyone know if this is still alive
somewhere as a private extension? Or what is involved in writing
something like that from scratch? Alternatively, has anyone managed to
generate documentation for the TCL parts using some other tool, then
somehow integrate it with the Doxygen documentation?
Thanks,
Oren Ben-Kiki
|