- All Modules
- All Functions
-
www.w3.org
- 2005
- XDM
- store
- introspection
- reflection
- external
-
xqdoc
-
project_xqdoc
-
xqdoc
(E)
- xqdoc2xhtml
-
project_xqdoc
- data processing
- expath.org
- www.functx.com
- error
http://www.zorba-xquery.com/modules/xqdoc
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:
- Module-, variable-, and function declarations need to be commented using the xqDoc commenting conventions. For example, this module contains xqDoc-style comments
- 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.
- 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.
Gabriel Petrovay
xquery version "3.0" encoding "utf-8";
- the XQuery module can be found here.
For more details please also see:
ann | 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 |
![]() ![]() |
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. |
![]() |
xqdoc-content
(
$module as xs:string
) as element(*) external Generated the an XQDoc XML document for the module provided as parameter to this function. |
declare %ann: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.
- $module-uri The URL of the module for which to generate XQDoc.
- An element according to the xqdoc schema (http://www.zorba-xquery.com/modules/xqdoc.xsd).
- zerr::ZXQD0002 if the xqdoc comments in the module contain invalid XML
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.
- $module The module (as string) for which to generate the XQDoc documentation.
- An element according to the xqdoc schema (http://www.zorba-xquery.com/modules/xqdoc.xsd).
- zerr::ZXQD0002 if the xqdoc comments in the module contain invalid XML