RE: Getting started with Doxygen - take II

Subject: RE: Getting started with Doxygen - take II
From: "Susan W. Gallagher" <sgallagher5 -at- cox -dot- net>
To: "Erika Yanovich" <ERIKA_y -at- rad -dot- com>, "Bill Swallow" <techcommdood -at- gmail -dot- com>
Date: Thu, 29 Dec 2005 16:21:51 -0800

Erika,

It's been a while, but as I recall, Doxygen is very easy to set up and use.
If instructing the devs on the commenting syntax that's the problem, it'll
be very easy to create a 2-hour presentation and a 1-page cheat sheet from
the Doxygen docs. While there are a number of commenting styles available,
you need merely choose one and say, "do it this way." And depending on the
language they're commenting, you'll need to be specific about
language-specific constructions as well. But the Doxygen docs are excellent.

If you need more help than you get here, you might try the nettechwriters
list on Yahoo. It's a list dedicated to API documentation.

HTH
-Sue Gallagher


> -----Original Message-----
> From: techwr-l-bounces+sgallagher5=cox -dot- net -at- lists -dot- techwr-l -dot- com
> [mailto:techwr-l-bounces+sgallagher5=cox -dot- net -at- lists -dot- techwr-l -dot- com]On
> Behalf Of Erika Yanovich
>
> Thanks, Bill. In the archives the stories are around people's
> experience with the tool. However, I'm not yet there. I'm having
> difficulty introducing it to a particular R&D group here. They
> want someone to hold their hand without the need to read
> anything. They allocated 2 hours for the task. As I am also new
> to it, I'm quite clueless. Someone came up with the idea of
> asking for a piece of code (well, a copy, of course) and
> inserting comments in a Doxygen-compatible format as an example.
> So, my problem is actually lowering developers' inertia while I
> don't yet posses the necessary knowledge.
> Erika
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


References:
RE: Getting started with Doxygen - take II: From: Erika Yanovich

Previous by Author: RE: Word "Find and Replace"
Next by Author: Re: User vs. ???
Previous by Thread: Re: Getting started with Doxygen - take II
Next by Thread: Thanks. A lot!


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads