{ "ns" : "http://zorba.io/modules/xqdoc", "description" : " <p xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">\n The goal of xqDoc is to provide a simple vendor neutral solution for\n documenting XQuery modules, as well as tools to generate a user friendly\n presentation of this documentation and cross referencing information.\n Therefore, xqDoc proposes a new commenting convention that extends the\n currently defined XQuery comment style. This convention is modeled\n after Java's Javadoc commenting style, and provides a simple, uniform\n way to document XQuery source code. You can find more information about\n xqDoc on the website of the <a href=\"http://xqdoc.org/\">xqDoc project</a>.\n This library module provides XQDoc utility functions.\n </p>\n <p xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">\n Generating a user friendly presentation of the documentation is\n accomplished in the following steps:\n <ol>\n  <li>Module, variable, function, collection, and index declarations need\n      to be commented using the xqDoc commenting conventions. For example,\n      this module contains xqDoc-style comments</li>\n  <li>A xqDoc-enabled processor can parse such documentation and generate\n      a vendor neutral XML document which stores all the information about\n      the code and the comments. Such a document adheres to the xqDoc\n      Schema.</li>\n  <li>The information of an XML document generated by the second step,\n      can be transformed into arbitrary presentation formats\n      (e.g. html).</li>\n </ol>\n </p>\n <p xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">\n This module implements the first and second step of this process.\n That is, Zorba can parse XQuery modules which are annotated with\n xqDoc-style documentation and generate the vendor neutral\n XML representation.\n </p>\n", "sees" : [ "<xqdoc:see xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"><a href=\"http://xqdoc.org/\" target=\"_blank\">xqDoc specification</a></xqdoc:see>" ], "authors" : [ "<xqdoc:author xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">Gabriel Petrovay</xqdoc:author>" ], "version" : null, "encoding" : "utf-8", "namespaces" : [ { "uri" : "http://zorba.io/annotations", "prefix" : "an" }, { "uri" : "http://www.w3.org/2005/xqt-errors", "prefix" : "err" }, { "uri" : "http://zorba.io/modules/fetch", "prefix" : "fetch" }, { "uri" : "http://zorba.io/modules/xqdoc-options", "prefix" : "opt" }, { "uri" : "http://zorba.io/modules/schema", "prefix" : "schema" }, { "uri" : "http://zorba.io/options/versioning", "prefix" : "ver" }, { "uri" : "http://zorba.io/modules/xqdoc", "prefix" : "xqd" }, { "uri" : "http://zorba.io/errors", "prefix" : "zerr" } ], "functions" : [ { "arity" : 1, "name" : "xqdoc-content", "qname" : "xqd:xqdoc-content", "signature" : "($module as xs:string) as element(*)", "description" : " Generated the an XQDoc XML document for the module provided\n as parameter to this function.\n", "summary" : "<p> Generated the an XQDoc XML document for the module provided\n as parameter to this function.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "module", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The module (as string) for which to generate the XQDoc documentation.</div>" } ], "returns" : { "type" : "element(*)", "description" : "An element according to the xqdoc schema (<tt xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">http://zorba.io/modules/xqdoc.xsd</tt>)." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr::ZXQD0002 if the xqdoc comments in the module contain invalid XML</xqdoc:error>" ] }, { "arity" : 2, "name" : "xqdoc-content", "qname" : "xqd:xqdoc-content", "signature" : "($module as xs:string, $options as element(opt:enable)) as element(*)", "description" : " Generated the an XQDoc XML document for the module provided\n as parameter to this function.\n In comparison to the single parameter version, this function does not\n generate XQDoc for all language components. By default, the\n following components are deactivated: XQuery comments, import\n statements, variable declarations, function declarations, collection\n declarations,  and index declarations. The second parameter is used to\n enable the XQDoc generation of those components.\n", "summary" : "<p> Generated the an XQDoc XML document for the module provided\n as parameter to this function.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "module", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The module (as string) for which to generate the XQDoc documentation.</div>" }, { "name" : "options", "type" : "element(opt:enable)", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> XQDoc generation options, e.g.: <pre> &lt;enable xmlns=\"http://zorba.io/modules/xqdoc-options\" comments=\"true\" functions=\"true\" indexes=\"true\" &gt; </pre></div>" } ], "returns" : { "type" : "element(*)", "description" : "An element according to the xqdoc schema (<tt xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">http://zorba.io/modules/xqdoc.xsd</tt>)." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr::ZXQD0002 if the xqdoc comments in the module contain invalid XML</xqdoc:error>" ] }, { "arity" : 1, "name" : "xqdoc", "qname" : "xqd:xqdoc", "signature" : "($module-uri as xs:string) as element(*)", "description" : " Generates an XQDoc XML document for the module located\n at the URI provided as parameter to this function.\n", "summary" : "<p> Generates an XQDoc XML document for the module located\n at the URI provided as parameter to this function.</p>", "annotation_str" : " %an:nondeterministic", "annotations" : [ { "prefix" : "an", "ns" : "http://zorba.io/annotations", "name" : "nondeterministic", "value" : "" } ], "updating" : false, "parameters" : [ { "name" : "module-uri", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The URL of the module for which to generate XQDoc.</div>" } ], "returns" : { "type" : "element(*)", "description" : "An element according to the xqdoc schema (<tt xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">http://zorba.io/modules/xqdoc.xsd</tt>)." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr::ZXQD0002 if the xqdoc comments in the module contain invalid XML</xqdoc:error>" ] }, { "arity" : 2, "name" : "xqdoc", "qname" : "xqd:xqdoc", "signature" : "($module-uri as xs:string, $options as element(opt:enable)) as element(*)", "description" : " Generates an XQDoc XML document for the module located\n at the URI provided as parameter to this function.\n In comparison to the single parameter version, this function does not\n generate XQDoc for all language components. By default, the\n following components are deactivated: XQuery comments, import\n statements, variable declarations, function declarations, collection\n declarations,  and index declarations. The second parameter is used to\n enable the XQDoc generation of those components.\n", "summary" : "<p> Generates an XQDoc XML document for the module located\n at the URI provided as parameter to this function.</p>", "annotation_str" : "", "annotations" : [  ], "updating" : false, "parameters" : [ { "name" : "module-uri", "type" : "xs:string", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> The URL of the module for which to generate XQDoc.</div>" }, { "name" : "options", "type" : "element(opt:enable)", "occurence" : null, "description" : "<div xmlns:xqdoc=\"http://www.xqdoc.org/1.0\"> XQDoc generation options, e.g.: <pre> &lt;enable xmlns=\"http://zorba.io/modules/xqdoc-options\" comments=\"true\" functions=\"true\" indexes=\"true\" /&gt; </pre></div>" } ], "returns" : { "type" : "element(*)", "description" : "An element according to the xqdoc schema (<tt xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">http://zorba.io/modules/xqdoc.xsd</tt>)." }, "errors" : [ "<xqdoc:error xmlns:xqdoc=\"http://www.xqdoc.org/1.0\">zerr::ZXQD0002 if the xqdoc comments in the module contain invalid XML</xqdoc:error>" ] } ], "variables" : [  ] }