Bureaucrats, editor, reviewer, Administrators
13,551
edits
Changes
Jump to navigation
Jump to search
Created page with "This XQuery Module contains functions for generating xqDoc files from XQuery modules. =Introduction= [http://xqdoc.org xqDoc] provides a simple vendor neutra..."
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 documentation from XQuery modules. The documentation conventions have been inspired from Java’s JavaDoc standard. Documentation comments begin with {{Code|(:~}} and end with {{Code||:)}}.
=Conventions=
All functions in this module are assigned to the {{Code|http://basex.org/modules/xqdoc}} namespace, which is statically bound to the {{Code|xqdoc}} prefix.<br/>
All errors are assigned to the {{Code|http://basex.org/errors}} namespace, which is statically bound to the {{Code|bxerr}} prefix.
=Functions=
==xqdoc:parse==
{| width='100%'
|-
| width='90' | '''Signatures'''
|{{Func|xqdoc:parse|$input as xs:string|element(xqdoc:xqdoc)}}
|-
| '''Summary'''
|Parses the specified {{Code|$input}} and generates an xqDoc element.
|}
=Changelog=
This module was introduced with Version 7.7.
[[Category:XQuery]]
=Introduction=
[http://xqdoc.org xqDoc] provides a simple vendor neutral solution for generating documentation from XQuery modules. The documentation conventions have been inspired from Java’s JavaDoc standard. Documentation comments begin with {{Code|(:~}} and end with {{Code||:)}}.
=Conventions=
All functions in this module are assigned to the {{Code|http://basex.org/modules/xqdoc}} namespace, which is statically bound to the {{Code|xqdoc}} prefix.<br/>
All errors are assigned to the {{Code|http://basex.org/errors}} namespace, which is statically bound to the {{Code|bxerr}} prefix.
=Functions=
==xqdoc:parse==
{| width='100%'
|-
| width='90' | '''Signatures'''
|{{Func|xqdoc:parse|$input as xs:string|element(xqdoc:xqdoc)}}
|-
| '''Summary'''
|Parses the specified {{Code|$input}} and generates an xqDoc element.
|}
=Changelog=
This module was introduced with Version 7.7.
[[Category:XQuery]]
