@MSGID: <klrhhmFvgtU1@mid.individual.net>
baf1b17c
@REPLY: 1@dont-email.me> d1773d8c
@REPLYADDR ted@loft.tnolan.com (Ted Nolan

@REPLYTO 2:5075/128 ted@loft.tnolan.com (Ted
Nolan
@CHRS: CP866 2
@RFC: 1 0
@RFC-Message-ID:
<klrhhmFvgtU1@mid.individual.net>
@RFC-References:
<cfef6de1-b912-42d3-9fa7-5d58e911bd66n@googlegroups.com> 1@dont-email.me>
@TZUTC: 0000
@TID: FIDOGATE-5.12-ge4e8b94
In article 1@dont-email.me>, Rich  <rich@example.invalid> wrote:
>stk <skuhagen@web.de> wrote:
>> *Documentation:*
>> I`d like to use Doxygen, but not sure, if this is still a good 
>> option, since Tcl is not supported anymore.  Whats your preference?  
>> My goal is, to document the API of my project in source and generate 
>> it into HTML automatically.
>
>Personal opinion here, but in every case I can think of where doxygen 
>was used to "autodocument the source" the resulting docs were no more 
>valuable than simply reading the source (in fact, often less valuable).  
>The doxygen html would tell you that there were these twelve C 
>functions you could call, and that their parameters were X, Y, or Z, 
>but leave off what the function did (I guess the author`s though their 
>names were meaningful enough) and more often than not, leave off any 
>description of what was expected of the parameters.
>
>Now, this might have been a failure of the author to insert enough 
>"doxygen tags" into the source to generate proper docs, but as I saw 
>the pattern with *every* one I remember, it felt more like doxygen 
>existed merely to satisify some corportate code review checkbox for 
>"auto-generated code documentation" where the code review checkbox 
>omitted a second checkbox of "and the output documentation is useful to 
>someone for the purpose of learning/using the API).
>

I find the Doxygen reports for Tcl projects very useful.  You do need
to use enough tags to provide the information -- nothing will provide
it for you if it`s not there.  I anticipate being able to build the
versions supporting Tcl for many years to come.
-- 
columbiaclosings.com
What`s not in Columbia anymore..
--- trn 4.0-test76 (Apr 2, 2001)
 * Origin: loft (2:5075/128)
SEEN-BY: 5001/100 5005/49 5015/255 5019/40 5020/715
848 1042 4441 12000
SEEN-BY: 5030/49 1081 5058/104 5075/128
@PATH: 5075/128 5020/1042 4441