Code comments extraction for documentation

Subject: Code comments extraction for documentation
From: "John Harrington" <beartiger -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Mon, 23 Oct 2006 11:18:19 -0700

By "comments extraction", I mean extracting comments from code (e.g.,
c++) for use in documentation (e.g., of a software developers' kit).
If there is a more standard name for this, please let me know.

Has anyone on the list tackled the problem of comments extraction in a
documentation project?

1) What tool(s) did you use/recommend? Or did you roll your own?

2) What are some other leading tools you know about and why did you
prefer the solution you used?

3) How did you deal with editorial review and updates to content?

I'd be grateful for any comments anyone is willing to offer.


Many thanks,
John Harrington
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help format plus PDF, HTML and more. Flexible, precise, and efficient content delivery. Try it today! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

---
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 admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


Follow-Ups:

Previous by Author: Re: Speaking of conferences ...
Next by Author: RE: If you don't want people to know your age...
Previous by Thread: RE: Release notes
Next by Thread: RE: Code comments extraction for documentation


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


Sponsored Ads