Google Groups no longer supports new Usenet posts or subscriptions. Historical content remains viewable.
Dismiss
Technical documentation about Tcl-script
55 views
Skip to first unread message
Esa Heikkinen
Feb 13, 2012, 5:19:11 AM2/13/12
to
Hi
I have one big tcl-script (2 files and about 6500 lines) and would
want to make technical documentation about it.
Are there exist some tools to help to make documentation about Tcl-
scripts ?
I am also interesting about advices how to "re-write" tcl-script to
make it better for reading and writing documentation about it.
Best Regards
Esa
I have one big tcl-script (2 files and about 6500 lines) and would
want to make technical documentation about it.
Are there exist some tools to help to make documentation about Tcl-
scripts ?
I am also interesting about advices how to "re-write" tcl-script to
make it better for reading and writing documentation about it.
Best Regards
Esa
Arjen Markus
Feb 13, 2012, 6:02:26 AM2/13/12
to
Advice on how to improve the documentation is rather difficult to
give. You will have to give us some information about what you want
to achieve for example.
Regards,
Arjen
Esa Heikkinen
Feb 14, 2012, 10:21:10 AM2/14/12
to
> You can have a look at the doxygen-support for Tcl - see the Wiki.
>
>
It (version 1.7.6.1 in windows) works somehow, but something problems
>
>
with it:
- there are no all functions found in the Call graphs
- line feeds and scandinavian characters do not work (i have tried
INPUT_ENCODING: ASCII, UTF-8 and ISO-8859-10) in function's source-
list
- some characters in original source-codes confuse results maybe ?
Regards
Esa
rene
Feb 14, 2012, 10:44:53 AM2/14/12
to
Some further improvements regarding @addtogroup are in the next
release.
Search for "doxygen tcl" in bugzilla for more information.
Regards
rene
Ashok Nadkarni
Feb 14, 2012, 11:15:25 AM2/14/12
to
Esa,
Perhaps you might also try the Ruff documentation generator
User guide at http://woof.magicsplat.com/ruff_guide
Reference pages (generated using Ruff itself) at
http://woof.magicsplat.com/manuals/ruff/index.html
Another example of generated docs is at
http://woof.magicsplat.com/manuals/woof/index.html
As to why use Ruff!, see http://woof.magicsplat.com/node/4
Also, Ruff! can directly generate documentation in HTML (as in the above
samples) or generate Robodoc or Tcl's own doctools format.
/Ashok
Perhaps you might also try the Ruff documentation generator
User guide at http://woof.magicsplat.com/ruff_guide
Reference pages (generated using Ruff itself) at
http://woof.magicsplat.com/manuals/ruff/index.html
Another example of generated docs is at
http://woof.magicsplat.com/manuals/woof/index.html
As to why use Ruff!, see http://woof.magicsplat.com/node/4
Also, Ruff! can directly generate documentation in HTML (as in the above
samples) or generate Robodoc or Tcl's own doctools format.
/Ashok
Ocsimize
Feb 16, 2012, 4:58:46 AM2/16/12
to
Hi !
"zdoc" : Though the page is in French, the comments inside the program are in English :
http://www.oklin.com/zdoc/
An exemple is here (simple but efficient) :
http://www.oklin.com/zdoc/sample/index.html
It lists the procedure with their comments and arguments.
O.
"zdoc" : Though the page is in French, the comments inside the program are in English :
http://www.oklin.com/zdoc/
An exemple is here (simple but efficient) :
http://www.oklin.com/zdoc/sample/index.html
It lists the procedure with their comments and arguments.
O.
0 new messages