Re: integrating authored content with generated API docs

Subject: Re: integrating authored content with generated API docs
From: Tom Johnson <tomjohnson1492 -at- gmail -dot- com>
To: Robert Lauriston <robert -at- lauriston -dot- com>
Date: Fri, 27 May 2016 20:20:36 -0700

Good point about Document!X. That tool processes .NET, C++, but not Java. I
remember playing around with it once and was impressed. Most of the
document generator tools (
https://en.wikipedia.org/wiki/Comparison_of_documentation_generators) seem
somewhat inactive with development, but Document!X seems to be fairly
active.

There's a good article on document generators in the Sept 2014 issue of the
Intercom.

What Tools Do You Use to Produce API Documentation?
By Anita Andrew | Senior Member
Sep 2014

http://intercom.stc.org/2014/09/what-tools-do-you-use-to-produce-api-documentation/

If you are interested in the article but don't have access, let me know and
I'll send it to you.

Tom

---------------------
blog: idratherbewriting.com
twitter: tomjohnson
email: tomjohnson1492 -at- gmail -dot- com
cell: 408-540-8562

On Fri, May 27, 2016 at 6:06 PM, Robert Lauriston <robert -at- lauriston -dot- com>
wrote:

> It's certainly possible. I've done it with Document!X. I don't think
> it's javadoc per se but it uses the same doc comments.
>
> http://www.innovasys.com/product/dx/overview
>
> I doubt there's any big technical obstacle to writing a Java Doclet
> that would write to the Confluence REST API. It would just be work.
>
> On Fri, May 27, 2016 at 12:37 PM, Tom Johnson <tomjohnson1492 -at- gmail -dot- com>
> wrote:
> > As far as integrating Javadoc or Doxygen outputs into another output, I'd
> > say give up this effort now. It's pretty much impossible beyond adding
> some
> > pages in Doxygen.
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Visit TechWhirl for the latest on content technology, content strategy and
> content development | http://techwhirl.com
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as tomjohnson1492 -at- gmail -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
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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


Follow-Ups:

References:
integrating authored content with generated API docs: From: Robert Lauriston
RE: integrating authored content with generated API docs: From: mbaker
Re: integrating authored content with generated API docs: From: Robert Lauriston
Fwd: integrating authored content with generated API docs: From: Robert Lauriston
Re: integrating authored content with generated API docs: From: Robert Fekete
Re: integrating authored content with generated API docs: From: Tom Johnson
Re: integrating authored content with generated API docs: From: Robert Lauriston

Previous by Author: Re: integrating authored content with generated API docs
Next by Author: Re: Satellite-killing software
Previous by Thread: Re: integrating authored content with generated API docs
Next by Thread: Re: integrating authored content with generated API docs


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

Sponsored Ads


Sponsored Ads