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.
RE: Gift for those single-sourcing or API documentation projects
Subject:RE: Gift for those single-sourcing or API documentation projects From:"Glenn Maxey" <glenn -dot- maxey -at- voyanttech -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 24 Jan 2002 09:13:21 -0700
Hi Rob,
Although I didn't create these tools for JavaDoc, I'm pretty sure that
you'll be able to support them.
The code has some Doxygen specific stuff in it. What comes to mind are:
(1) Parsing files with "group" in the name, looking for anchors with
"doxytag", and creating index tokens.
(2) The navigation that I set up.
You might find it worthwhile to have have some JavaDoc specific
routines. The perl program that creates the TOC will definitely need
something new.
I suspose if I were to contemplate future revisions of the tools and
their doc's, it would be to have chapters on WWP and JavaDoc.
The concept of wrapping the mini-HTML systems from JavaDoc, Doxygen,
WWP, and Mif2Go into comprehensive HTML systems was certainly needed.
Good luck with the modifications you may have to make.
Glenn
> -----Original Message-----
> From: Rob Writer [mailto:piercedroo -at- hotmail -dot- com]
> Sent: Thursday, January 24, 2002 8:59 AM
> To: TECHWR-L
> Subject: Re: Gift for those single-sourcing or API documentation
> projects
>
>
> Glenn,
>
> This tool might prove to be invaluable to me.
> About 75% of my job consits of writing API documentation. I
> am currently wringing JavaDoc for all it's worth, and knew
> there must be a better way.
>
> I think you are on the right path...and once again, thank you.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr
---
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.
