Mailing-List: contact forrest-dev-help@xml.apache.org; run by ezmlm
Precedence: bulk
Reply-To: forrest-dev@xml.apache.org
Date: Fri, 22 Nov 2002 22:00:48 +1100
From: Jeff Turner <jefft@apache.org>
To: forrest-dev@xml.apache.org, cocoon-docs@xml.apache.org
Subject: Re: JavaDocGenerator, ideas?
Message-ID: <20021122110047.GA11708@expresso.localdomain>
Mail-Followup-To: forrest-dev@xml.apache.org, cocoon-docs@xml.apache.org
References: <20021122103537.99AB223CD8@dj.codeconsult.ch>
Mime-Version: 1.0
Content-Type: text/plain; charset=iso-8859-1
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <20021122103537.99AB223CD8@dj.codeconsult.ch>
User-Agent: Mutt/1.4i

On Fri, Nov 22, 2002 at 11:35:37AM +0100, Bertrand Delacretaz wrote:
> (cc to cocoon-docs for info, please discuss on forrest-dev)
> 
> Hi Forresters,
> 
> On cocoon-docs [1] we recently agreed (I think - no vote yet) to generate 
> parts of the soon-to-be Cocoon Users Reference Docs from custom javadoc tags 
> embedded in java source code.
> 
> For this we need a JavaDocGenerator that would parse java sources and output 
> an XML representation of (at least) the javadoc tags and their content. I 
> think such a generator could be very useful for other projects.

Yes, I would find that useful for documenting Ant tasks.

I propose sucking up to Peter Donald:

  "Essentially what I want to do is be able to point at a java source
  file that gets processed by qdox.sourceforge.net and outputs some
  custom xml. The code is already written but only works from command
  line. What I would like to do is get it working inside forrest so that
  everytime I rebuild the descriptions of components are regenerated and
  crosslinked."
   <200211161844.56489.peter@apache.org>


--Jeff

> I assume this component would be added to the Cocoon code base, but the most 
> immediate need that I can see is in Forrest, which prompts me to bring the discussion here.
> 
> Any suggestions on how to best implement this? 
> I see it has been discussed lately but did not find concrete conclusions.
> 
> I gave a quick look at qdox [2], looks like it would be fairly easy to base 
> the JavaDocGenerator on this library.
> 
> Thoughts?
> 
> -- 
>  Bertrand Delacr�taz (codeconsult.ch, jfor.org)
> 
>  buzzwords: XML, java, XSLT, Cocoon, FOP, mentoring/teaching/coding.
>  blogspace http://www.codeconsult.ch/bertrand
> 
> [1] http://marc.theaimsgroup.com/?l=xml-cocoon-docs&m=103788336715888&w=2
> [2] http://qdox.sourceforge.net/model.html