CookXmlDoc preview in Subversion

CookXmlDoc, a utility to document XML tag libraries for CookXml, is now in Subversion. CookXml is a uniquely XML parser that is not only fast, but also allows fast generation of custom XML parsers in Java. In the past, there was a problem of clearly documenting the semantics of the XML that is handled by CookXml tag libraries. This new tool, CookXmlDoc converts the XML tag library into a represenation that is suitable for output. It works very similar like JavaDoc that can take doclets to generate custom formats.

There is a quite functional HTML that generate the XML tags and attributes into a JavaDoc like format. Not only it documents the structure of the tag library, it also extracts JavaDoc comments to fill in the descriptions. For a sample output, please take a look at

http://cookxml.yuanheng.org/tagdoc/

It documents the tags in the CookSwing library.

The output format is by no means final; I am still working on to produce better and more informative outputs. Not all tag library components are generated. Also, there should be a way to describe the tag more fully, and giving examples and such.

As one could imagine, one could write a doclet for CookXmlDoc that would allow the generation of XML schema from existing XML parsers written in CookXml. That would be the next step when I finish up the HTML doclet tool.

CookXml, a high performance and rapid custom XML parser: http://cookxml.sf.net/ or http://cookxml.yuanheng.org/
CookSwing, an XML->Swing tool: http://cookxml.sf.net/cookswing/ or http://cookxml.yuanheng.org/cookswing/
CookSwt, an XML->SWT tool: http://cookxml.sf.net/cookswt/ or http://cookxml.yuanheng.org/cookswt/