JAVADOC for XML

[Milind Gadre <mi...@ecplatforms.com>]

Ideally, we would have something like JAVADOC for XML. After several
years of working with C/C++/Objective-C etc, and having the biggest
nightmare of a time maintaining and preparing documentation, it is
extremely useful to have the documentation be in one place - the source
which is being described - and have a human readable format generated
from it. You have no idea how it wows the customers :-)

I apologize if this has been discussed before, but it would be great if
there was a similar standard for XML and DTD documentation.

Just like a DOMParser, we can have a DOCParser, that can have a
'generateOutput' method of some sort that can be subclassed to output
HTML, PDF etc.

Regards...

Milind Gadre
ecPlatforms, Inc
901 Mariner's Island Blvd, Suite 565
San Mateo, CA 94404
C: 510-919-0596
F: 815-352-0779
milind@ecplatforms.com

----- Original Message -----
From: "Jeffrey Rodriguez" <je...@hotmail.com>
To: <xe...@xml.apache.org>
Sent: Friday, January 26, 2001 10:32 PM
Subject: Re: What should we do about StyleBook?


> Keeping the documentation in XML would give lot more options to
> trasnforming such documentation into other formats.
> The real question is what does StyleBook buy you, specially when it is
> an obscure set of API's, not  currently maintained.
> If there are somebody out there how is maintain this package I would
fine
> but without an active commiter or anybody who would be responsive to
bugs I
> feel like it is just better to keep the documentation in html.
> This is just my 2 cents.
>
> Thanks,
>                     Jeffrey Rodriguez
>                     XML Developer
>
>
> >From: Eric Hodges <ha...@swbell.net>
> >Reply-To: xerces-j-dev@xml.apache.org
> >To: xerces-j-dev@xml.apache.org
> >Subject: Re: What should we do about StyleBook?
> >Date: Wed, 24 Jan 2001 20:21:34 -0600
> >
> >
> >----- Original Message -----
> >From: <ne...@ca.ibm.com>
> >To: <xe...@xml.apache.org>
> >Sent: Wednesday, January 24, 2001 4:41 PM
> >Subject: What should we do about StyleBook?
> >
> >
> > >
> > > 3.  To convert our docs into HTML and leave them in that form, so
that
> >all
> > > modifications/additions would be done in that language.
> > >
> > > 3. is an unpleasant option vis-a-vis maintainability.  Does anyone
know
> >of
> > > another package that would allow us to go the second route?  In
some
> >ways
> >1
> > > is the most obvious choice, but  are we certain we'll have the
time to
> >keep
> > > dragging StyleBook along?  Does anyone know what other Apache
projects
> >that
> > > use StyleBook--and I think there are several--are thinking about
these
> > > questions?
> >
> >What does keeping the docs in XML buy you?
> >
> >
> >
> >---------------------------------------------------------------------
> >To unsubscribe, e-mail: xerces-j-dev-unsubscribe@xml.apache.org
> >For additional commands, e-mail: xerces-j-dev-help@xml.apache.org
> >
>
> _________________________________________________________________
> Get your FREE download of MSN Explorer at http://explorer.msn.com
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: xerces-j-dev-unsubscribe@xml.apache.org
> For additional commands, e-mail: xerces-j-dev-help@xml.apache.org
>
>

Re: JAVADOC for XML

["Randall J. Parr" <RP...@TemporalArts.COM>]

Milind Gadre wrote:

> Ideally, we would have something like JAVADOC for XML. After several
> years of working with C/C++/Objective-C etc, and having the biggest
> nightmare of a time maintaining and preparing documentation, it is
> extremely useful to have the documentation be in one place - the source
> which is being described - and have a human readable format generated
> from it. You have no idea how it wows the customers :-)
>
> I apologize if this has been discussed before, but it would be great if
> there was a similar standard for XML and DTD documentation.
>
> Just like a DOMParser, we can have a DOCParser, that can have a
> 'generateOutput' method of some sort that can be subclassed to output
> HTML, PDF etc.
>
> Regards...
>
> Milind Gadre
> ecPlatforms, Inc
> 901 Mariner's Island Blvd, Suite 565
> San Mateo, CA 94404
> C: 510-919-0596
> F: 815-352-0779
> milind@ecplatforms.com

There is an open source project called XSLDOC which works much like Javadoc
(sorry I don't have the URL handy).

R.Parr
TemporalArts