Difference between revisions of "Inspection Module"
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...") |
|||
| Line 3: | Line 3: | ||
=Introduction= | =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 | + | [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= | =Conventions= | ||
Revision as of 00:03, 31 May 2013
This XQuery Module contains functions for generating xqDoc files from XQuery modules.
Introduction
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 (:~ and end with :).
Conventions
All functions in this module are assigned to the http://basex.org/modules/xqdoc namespace, which is statically bound to the xqdoc prefix.
All errors are assigned to the http://basex.org/errors namespace, which is statically bound to the bxerr prefix.
Functions
xqdoc:parse
| Signatures | xqdoc:parse($input as xs:string) as element(xqdoc:xqdoc)
|
| Summary | Parses the specified $input and generates an xqDoc element.
|
Changelog
This module was introduced with Version 7.7.
