[XML-DEV Mailing List Archive Home] [By Thread] [By Date] [Recent Entries] [Reply To This Message]

Re: javadoc like?

• From: Dan Vint <dvint@s...>
• To: mike@w... (Michael Fitzgerald)
• Date: Tue, 19 Dec 2000 08:02:28 -0800 (PST)

Earl Hood created a Perl library and utility that has been used to document
SGML based DTDS. It doesn't place the comments inside the DTD, it uses a 
seperate file to manage that information. It does a nice job of creating a
tree and full linked set of documentation.

Near & Far is a commercial tool that manages a DTD and its documentation for
SGML and then allows you to extract reports - not HTML though.

We use schemas to manage and generate both our DTDs and the documentation in 
HTML via XSLT stylesheets. This works well for the documentation but is so-so
for the creation and management of our DTDs as in the schema we can't
catch ambiguous content models.

..dan

> 
> What I mean is placing hooks in commented text and processing normal DTD
> constructs to produce documentation.
> 
> For example, something similar this:
> 
> <!-- @switch@ The switch element turns rendering on or off. @@ -->
> <!ELEMENT switch EMPTY>
> <!ATTLIST switch boolean (1|0) "1">
> 
> Might produce:
> 
> Element
> 
> switch
> 
>      The switch element turns rendering on or off.
> 
> Attributes
> 
>      boolean     1 or 0      Default: 1
> 
> 
> Likewise, I would expect similar processing on <annotation> elements in XML
> schema.
> 
> Mike
> 
> -----Original Message-----
> From: olivier.dameron@g... [mailto:olivier.dameron@g...]
> Sent: Tuesday, December 19, 2000 12:14 AM
> To: Michael Fitzgerald
> Subject: Re: javadoc like?
> 
> > Is anyone doing anything like a javadoc for DTDs or XML Schema or any
> > other schema language for that matter?
> 
> Could you precise "javadoc for DTD" ?
> I thought javadoc was for documenting java classes...
> 
> Regards,
> Olivier Dameron
> 
> --
> Sent through GMX FreeMail - http://www.gmx.net
> 
> 

• References:
  • RE: javadoc like?
    • From: Michael Fitzgerald <mike@w...>

• Prev by Date: books on XML schema
• Next by Date: RE: NaN or NAN ?
• Previous by thread: RE: javadoc like?
• Next by thread: RE: javadoc like?
• Index(es):
  • Date
  • Thread