Re: Javadoc comments or equivalent in XSchema
Ron Bourret (rbourret@dvs1.informatik.tu-darmstadt.de)
Sun, 19 Jul 1998 11:58:28 +0200
> I think the remaining one might be useful (or possibly already discussed
> here). I have been using some JavaDoc-like comments in my XML-Data
> definitions to automatically generate HTML documentation for the document
> content. I have had my XML-Data to DTD converter modified to produce the
> HTML documentation at the same time as it builds the DTD.
>
> I haven't been making a distinction between regular comments and processed
> comments and have only been using @see and @example formulations. Between
> minimal comments and information in the schema, it is able to do a
> reasonably good job documenting how to use the schema.
>
> Has any body else been doing anything in this area?
XSchema does something similar. Most elements contain an optional Doc element
which, in turn, contains a subset of HTML: John Cowan's Itsy Bitsy Teeny Weeny
Simple Hypertext (IBTWSH) format ( http://www.ccil.org/~cowan/XML/ibtwsh.dtd )
See section 2.6.1 of the spec
(http://members.aol.com/simonstl/xschema/spec/xscspec2p6v3.htm)
-- Ron Bourret