TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
I use it for C/C++ and IVE (internal Pascal-like language) and like it.
It does a great job of sniffing the code and putting together summaries
of what you find.
It is useful even if you don't have total buy-off from development to
get them to change their code comment style. You get something useful
even without code comments.
I use the input filter feature to have it run Perl scripts. This is how
I change the @bug command to our @lim command, so the end result doesn't
say "Bugs and Limitations" but "Limitations and Caveats" instead. I also
use input filters to turn quasi Pascal-like code into something that
looks like C so that Doxygen knows how to handle it.
I post-process it with Perl scripts to enhance navigation, index, etc.
when used as part of a bigger system.
My complaints (minor in nature compared to the big picture):
- The HTML isn't as clean as I would like. Specifically, some tags like
<li> are left open. Also, list items have their carriage returns in the
middle of a tag (such as "<a \n href=...>") rather than logically after
a (missing) </li> tag. It's an annoyance, because it makes it more
difficult for homegrown tools to find things that it might want to pull
out or enhance.
- To create PDFs, you have to generate LaTEX files, print to postscript,
and then convert to PDF. This presents two problems. (1) It's more
difficult to customize the layout unless you know LaTEX (which I don't).
(2) If you're using TAG files to simplify the build processes in the
HTML system, your PDF files will be incomplete because it doesn't find
Voyant Technologies, Inc.
Tel. +1 303.223.5164
Fax. +1 303.223.5275
glenn -dot- maxey -at- voyanttech -dot- com
> -----Original Message-----
> From: Steve Goldberg [mailto:steveg -at- raqia -dot- com]
> Sent: Monday, October 01, 2001 1:02 PM
> To: TECHWR-L
> Subject: Doxygen
> Doxygen is a documentation system for C++, Java, IDL, and C, which
> creates documentation from source files.
> Does anyone have experience using this, good or bad? I'd be interested
> in hearing any feedback.
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.