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.
We're using Doxygen to create our API Reference but we're not crediting it
anywhere, we probably should. We used to ship all the tools we used to
create our API Reference with the SDK so customers were able to build their
own, however we've stopped doing this and we haven't had any customers
asking why we've done this.
Doxygen has made our life a lot easier. The docs are with the code meaning
that when the code is updated the docs are as well. Anyone can update the
docs. The docs can be built at any time.
After extracting the source code comments with Doxygen we use HTML Help
Workshop to create a chm.
Hope this is useful.
Katherine
-----Original Message-----
From: Dave Neufeld [mailto:Dave_Neufeld -at- spectrumsignal -dot- com]
Sent: Wednesday, 13 February 2002 23:17
To: TECHWR-L
Subject: Doxygen question
To any Doxygen users out there:
When shipping doxygen created API references to customers, do you mention
the fact that they were created with doxygen? Or even how the API references
can be rebuilt with doxygen if the customer decides to modify the
"doxygen-tagged" source code that they are given? How much credit do you
give Doxygen?
We're having this discussion at our office as we determine how to
incorporate doxygen into the development process. The "proof of concept"
work done by the developers looks quite good; just needs a good proofing and
edit. But the scope and accuracy of information is nice.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Did you know you can get RoboHelp certified?
To learn how, visit http://www.ehelp.com/techwr. Be sure to also check out
our special pricing offers and promotions for RoboHelp 2002.
---
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.
