Changes

Jump to navigation Jump to search
14 bytes added ,  16:05, 1 June 2013
| '''Summary'''
|Retrieves the string from 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 updated extended the xqDoc schema 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 when it uses annotations
* a single {{Code|<xqdoc:namespaces/>}} node is added to the root element, which summarizes all prefixes used or declared in the module
Bureaucrats, editor, reviewer, Administrators
12,951

edits

Navigation menu