Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
no edit summary
|-
| width='120' | '''Signatures'''
|{{Func|inspect:module|$input uri as xs:string|element(module)}}
|-
| '''Summary'''
|Retrieves the resource addressed by located at the specified {{Code|$inputuri}}, parses it as XQuery module, and generates an element that describes the module's structure.
|-
| '''Errors'''
|-
| width='120' | '''Signatures'''
|{{Func|inspect:xqdoc|$input uri as xs:string|element(xqdoc:xqdoc)}}
|-
| '''Summary'''
|Retrieves the resource addressed by located at the specified {{Code|$inputuri}}, parses it as XQuery module, and generates an xqDoc element.<br/>[http://xqdoc.org xqDoc] provides a simple vendor-neutral solution for generating 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.
