Changes

Jump to navigation Jump to search
40 bytes added ,  09:11, 31 May 2013
no edit summary
This [[Module Library|XQuery Module]] contains functions for generating xqDoc files from XQuery modules. =Introduction= [http://xqdoc.org xqDoc] provides a simple vendor neutral solution for generating a documentation from XQuery extracting internal information on 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. We have slightly extended the conventions and updated the [http://files.basex.org/etc/xqdoc-1.1.30052013.xsd xqDoc schema]: * an {{Code|<xqdoc:namespaces/>}} node lists all namespaces of a module* if annotations are attached to variables or functions, an {{Code|<xqdoc:annotations/>}} node is added* variables now have a name and a type. An [[#Example|example]] is shown belowgenerating documentation.
=Conventions=
All functions in this module are assigned to the {{Code|http://basex.org/modules/xqdocinspect}} namespace, which is statically bound to the {{Code|xqdocinspect}} prefix.<br/>
All errors are assigned to the {{Code|http://basex.org/errors}} namespace, which is statically bound to the {{Code|bxerr}} prefix.
=Functions=
==inspect:xqdoc:parse==
{| width='100%'
|-
| width='90' | '''Signatures'''
|{{Func|inspect:xqdoc:parse|$input uri as xs:string|element(xqdoc:xqdoc)}}
|-
| '''Summary'''
|Parses the specified {{Code|$input}} and generates an xqDoc element.<br/>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. We have slightly extended the conventions and updated the [http://files.basex.org/etc/xqdoc-1.1.30052013.xsd xqDoc schema]:<br/>* an {{Code|<xqdoc:namespaces/>}} node lists all namespaces of a module* if annotations are attached to variables or functions, an {{Code|<xqdoc:annotations/>}} node is added* variables now have a name and a type.|-| '''Example'''|An example is [[#Example|shown below]].
|}
Bureaucrats, editor, reviewer, Administrators
12,947

edits

Navigation menu