Skip to main content.
home | support | download

Back to List Archive

RE: Documentation

From: <Rainer.Scherg(at)>
Date: Mon Sep 18 2000 - 07:30:52 GMT
I think I saw apache is using a utility called  "scandoc".
Which tool is better?

- rainer

-----Original Message-----
From: David Norris []
Sent: Sunday, September 17, 2000 10:35 AM
To: Multiple recipients of list
Subject: [SWISH-E] Documentation

I just started playing around with Doxygen on the SWISH-E 2.01 source. 
I wonder if we could use it to document the source code a bit better. 
Here's a test output:

I just created a basic config with the DoxyWizard and ran doxygen.  I've
not tried documenting anything, yet.  With Doxygen the source is made to
be self documenting.  There are a number of ways to add documentation
into the source.  To be brief, two methods compatible with C would look
like /*! some docs */ or JavaDocs format /** some docs */  Tags are used
document things like functions parameters (@param) and reference related
functions (@see).

Output formats are: HTML (and MS DevStudio 5/6 HTML-Help), XML, LaTeX,
RTF, and Unix Man.

Doxygen is GPL and runs on Linux, various Unix, and Windows.  Static
(due to QT) binaries are available for several common platforms, source
for others.

,David Norris
  Dave's Web -
  Dave's Weather -
  ICQ Universal Internet Number - 412039
  E-Mail -

"I would never belong to a club that would have me as a member!"
                                          - Groucho Marx

This Mail has been checked for Viruses
Attention: Encrypted Mails can NOT be checked !

* * *

Diese Mail wurde auf Viren ueberprueft
Hinweis: Verschluesselte Mails koennen NICHT geprueft werden !
Received on Mon Sep 18 07:31:08 2000