According to Geoff Hutchison:
>I was talking to a friend of mine who said he took a look at the source
>and he thought it lacked an overview, especially some sort of class
>browser. I was going to write up an overview document, but it would
>probably become outdated quickly.
>
>So I took a look at the PERCEPS system. It still has some bugs (it didn't
>make an index), but it did spit up some useful pages:
>http://ethel.williams.edu/doc/HtHTTP.html
>http://ethel.williams.edu/doc/Retriever.html
>http://ethel.williams.edu/doc/List.html
>
>In particular, any sort of code browser will require rewriting some
>comments and making sure most key methods are commented.
>
>Are there any better packages for this sort of thing? If we get something
>that works for us, I could set the snapshot script to generate the
>documenation for the current source.
>
>Until that point, is it worthwhile to write up an overview by hand? The
>comments could be reused later.
The result from that tool look quite nice. However, it would be
better if there would not only be a link to classes that the current
class has been derived from but also links to derived classes from
the parents.
Ok, this only makes sense in a closed environment (i.e. where all
derived classes are known), but since ht://Dig is such an environment,
it would be nice to have some sort of tree. (Hmm.. maybe this is the
missing index you're talking about?)
An even better approach to this would be the automatic generation
of OOD/M diagrams. Maybe this can be done by some minor modifications
to the doc generator. At least that would be a more standard way of
documenting an OO program ;-)
cheers,
Torsten
--
InWise - Wirtschaftlich-Wissenschaftlicher Internet Service GmbH
Waldhofstra�e 14 Tel: +49-4101-403605
D-25474 Ellerbek Fax: +49-4101-403606
E-Mail: [EMAIL PROTECTED] Internet: http://www.inwise.de
------------------------------------
To unsubscribe from the htdig3-dev mailing list, send a message to
[EMAIL PROTECTED] containing the single word "unsubscribe" in
the SUBJECT of the message.
