http://www.zorba-xquery.com/modules/xqdoc ZC

Module Description
Before using any of the functions below please remember to import the module namespace:
import module namespace xqd = "http://www.zorba-xquery.com/modules/xqdoc";

The goal of xqDoc is to provide a simple vendor neutral solution for documenting XQuery modules, as well as tools to generate a user friendly presentation of this documentation and cross referencing information. Therefore, xqDoc proposes a new commenting convention that extends the currently defined XQuery comment style. This convention is modeled after Java's Javadoc commenting style, and provides a simple, uniform way to document XQuery source code. You can find more information about xqDoc on the website of the xqDoc project. This library module provides XQDoc utility functions.

Generating a user friendly presentation of the documentation is accomplished in the following steps:

  1. Module-, variable-, and function declarations need to be commented using the xqDoc commenting conventions. For example, this module contains xqDoc-style comments
  2. A xqDoc-enabled processor can parse such documentation and generate a vendor neutral XML document which stores all the information about the code and the comments. Such a document adheres to the xqDoc Schema.
  3. The information of an XML document generated by the second step, can be transformed into arbitrary presentation formats (e.g. html).

This module implements the first and second step of this process. That is, Zorba can parse XQuery modules which are annotated with xqDoc-style documentation and generate the vendor neutral XML representation.

Author:

Gabriel Petrovay

XQuery version and encoding for this module:

xquery version "3.0" encoding "utf-8";

Zorba version for this module:

The latest version of this module is 2.0. For more information about module versioning in Zorba please check out this resource.

Module Resources
Related Documentation

For more details please also see:

Namespaces
an http://www.zorba-xquery.com/annotations
err http://www.w3.org/2005/xqt-errors
ver http://www.zorba-xquery.com/options/versioning
xqd http://www.zorba-xquery.com/modules/xqdoc
zerr http://www.zorba-xquery.com/errors
Function Summary
Nondeterministic External xqdoc ( $module-uri as xs:string ) as element(*) external
Generated an XQDoc XML document for the module located at the URI provided as parameter to this function.
External xqdoc-content ( $module as xs:string ) as element(*) external
Generated the an XQDoc XML document for the module provided as parameter to this function.
Functions
Nondeterministic External xqdoc back to 'Function Summary'
declare %an:nondeterministic function xqd:xqdoc (
            $module-uri as xs:string 
 ) as element(*) external

Generated an XQDoc XML document for the module located at the URI provided as parameter to this function.

Parameters:
Returns:
Errors:

External xqdoc-content back to 'Function Summary'
declare function xqd:xqdoc-content (
            $module as xs:string 
 ) as element(*) external

Generated the an XQDoc XML document for the module provided as parameter to this function.

Parameters:
Returns:
Errors:

blog comments powered by Disqus