[Swift-devel] documenting sites.xml

Mihael Hategan hategan at mcs.anl.gov
Mon Sep 3 14:42:35 CDT 2007


On Mon, 2007-09-03 at 18:53 +0000, Ben Clifford wrote:
> I was wondering about the best way to provide reference material for 
> sites.xml (and a future XML-based tc.data rewrite).
> 
> At present, sites.xml is a karajan code fragment document rather than an 
> XSD-compliant document (which manifests itself primarily in the handling 
> of namespaces). If it was an XSD-compliant file, then I'd use an XSD -> 
> documentation tool and put the descriptions in there.

What exactly is the difference?

> 
> Is there any established convention for doing something like this with 
> karajan elements?

Basically, no. The documentation is somewhat flat, as in it doesn't have
any structure describing mechanism besides spelling things out.

> 




More information about the Swift-devel mailing list