Changes

Jump to navigation Jump to search
30 bytes added ,  15:12, 2 July 2015
m
Minor clarifications
|-
|'''Examples'''
|Invokes the declared functions and returns its their values:<br/>
<pre class="brush:xquery">
declare %private function local:one() { 12 };
|-
| '''Summary'''
|Retrieves the string from resource addressed by the specified {{Code|$input}}, parses it as XQuery module, and generates an element that describes its the module's structure.
|-
| '''Errors'''
|-
| '''Summary'''
|Retrieves the string from resource addressed by the specified {{Code|$input}}, parses it as XQuery module, and generates an xqDoc element.<br/>[http://xqdoc.org xqDoc] provides a simple vendor -neutral solution for generating a documentation from XQuery modules. The documentation conventions have been inspired by the JavaDoc standard. Documentation comments begin with {{Code|(:~}} and end with {{Code|:)}}, and tags start with {{Code|@}}. xqDoc comments can be specified for main and library modules and variable and function declarations.<br/>
We have slightly extended the xqDoc conventions to do justice to the current status of XQuery (Schema: [http://files.basex.org/etc/xqdoc-1.1.30052013.xsd xqdoc-1.1.30052013.xsd]):<br/>
* an {{Code|<xqdoc:annotations/>}} node is added to each variable or function that uses annotations. The xqdoc:annotation child nodes may have additional {{Code|xqdoc:literal}} elements with {{Code|type}} attributes (xs:string, xs:integer, xs:decimal, xs:double) and values.
* a single {{Code|<xqdoc:namespaces/>}} node is added to the root element, which summarizes all prefixes and namespace URIs used or declared in the module.
* name and type elements are added to variables.
|-
| '''Errors'''
administrator, editor
41

edits

Navigation menu