[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Editing files that were generated from Javadocs once

Subject: Re: Editing files that were generated from Javadocs once
From: "Ken Munro" <kenmunro -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 24 Aug 2006 16:51:51 -0300

Hi.

I think the best solution is to get access to the code. The developers are
probably using a version control system, so you would just need an account
for that.

The best single source solution for Javadoc is to edit the code. The whole
idea behind Javadoc is self-documented code, eliminating the need to do what
you describe.

I don't know of any tools that do what you describe.

Good luck.

Ken Munro

--
email: kenmunro -at- gmail -dot- com
website: http://www.kenmunro.com/
podcast: http://www.kenmunro.com/kenmunro.rss


On 8/23/06, Nurit Zur <nurit286 -at- yahoo -dot- com> wrote:


Hello distinguished gurus,

We use Javadocs to generate API reference guides. However, we do not have
access to the code and the developers do not always copy the updated text to
the source code (almost never would be more accurate).
Therefore, next editing round we have to edit again what we have already
edited.

Is there a tool or method that enables to "single source" the comments
that are used to generate the API reference guide? Either a tool that copies
all the text back to the original files or a method of working that enables
to use or copy the same text to both the source files and the documentation
files.

Thnx






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

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

References:
Editing files that were generated from Javadocs once: From: Nurit Zur

Previous by Author: Re: Podcasts for Customer Support
Next by Author: Re: Breaking into the tech writing job market
Previous by Thread: Re: Editing files that were generated from Javadocs once
Next by Thread: AW: browseable vs browsable

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads