XQuery Function Documentation

Search and Browse

http://exist-db.org/xquery/xqdoc

java:org.exist.xqdoc.xquery.XQDocModule

XQDoc integration module.

xqdm:scan

xqdm:scan($uri as xs:anyURI) as node()*

Scan and extract function documentation from an external XQuery function module according to theXQDoc specification. The single argument URI may either point to an XQuery module stored in the db (URI starts with xmldb:exist:...) or a module in the file system. A file system module is searched in the same way as if it were loaded through an "import module" statement. Static mappings defined in conf.xml are searched first.

Parameters:
$uri The URI from which to load the function module
Returns:
node()* : the function docs.

xqdm:scan

xqdm:scan($data as xs:base64Binary, $name as xs:string) as node()*

Scan and extract function documentation from an external XQuery function module according to the XQDoc specification. The two parameter version of the function expects to get the source code of the module in the first argument and a name for the module in the second.

Parameters:
$data The base64 encoded source data of the module
$name The name of the module
Returns:
node()* : the function docs.