Project   History   Mission   Quotes   License   News Related Efforts   XQuery Style Quick Start   General   BaseX   eXist   MarkLogic   Saxon   xquerydoc   Zorba Documentation   Assumptions   Limitations   xqDoc Comments   xqDoc Schema   xqDoc Conversion   xqDoc Display   xqDoc Drivers Downloads   Binaries   Source Sample Output   xqDoc Basic   xqDoc Standard   xqDoc Enhanced Credits   Who We Are

Mission The goal of xqDoc is to provide a simple vendor neutral solution for documenting XQuery library and main modules, as well as tools to generate a user friendly presentation of this documentation and cross referencing information. This is being accomplished through 4 specific components: xqDoc proposes a new commenting convention that extends the currently defined XQuery comment style. This convention is modelled after Java's Javadoc commenting style, and provides a simple, uniform way to document XQuery source code. xqDoc defines a standard xqDoc XML schema. This schema provides a neutral format for storing information for user-defined XQuery modules as well as 3rd party proprietary functions that may be implemented in other programming languages. xqDoc provides a vendor neutral Java based conversion package that parses an XQuery library or main module and generates an xqDoc XML document modelled after the xqDoc XML schema. Support for specific XML database platforms and XQuery processors is provided by writing vendor specific drivers to store the generated xqDoc XML into the vendor's database or filesystem. xqDoc provides a vendor neutral presentation component, consisting of XQuery main modules and a library module, that can process the xqDoc XML document(s) stored in a XML database or filesystem and generate an extensively hyperlinked XHTML navigation interface.