Re: integrating authored content with generated API docs

Subject: Re: integrating authored content with generated API docs
From: Chris Despopoulos <despopoulos_chriss -at- yahoo -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Sun, 22 May 2016 09:31:03 +0000 (UTC)

I had set up DoxyGen to do this with FrameMaker. I saved the Maker as HTML, ran some custom java routines over the individual topic to clean out the junk Maker put into them, and then used DoxyGen configuration to generate the final package that included the code docs plus the authored docs. The result was a two-section piece, with a "guide" made of authored content, and a "reference" from the generated content. I would imagine that you could do something similar with JavaDoc, where you can merge some form of Maker's PUBLISH output with JavaDoc output.Â

I'm not aware of any out-of-the box tools to do this.Â

cud
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com

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

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


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

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Previous by Author: Re: Online help for GUI/web-based config app of HW telecom
Next by Author: Re: Animated GIFs in documentation
Previous by Thread: Re: integrating authored content with generated API docs
Next by Thread: Flare-only shop?


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

Sponsored Ads


Sponsored Ads