oc.1.9.4.source-code.xqdoc-1.0.12022018.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xqdoc Show documentation
Show all versions of xqdoc Show documentation
An Antlr4 implementation of xqDoc for XQuery
Simple type for defining the uris associated
with things such as library modules associated
with functions, variables, imports, etc.
Simple type for defining the type associated
with things such as global variables, function
parameters, and function return types etc.
Complex type for function parameters
Complex type for an individual function parameter
Complex type for the return value from a function
Simple type used for definging the number of occurrences for a global variable, function parameter
or function return type
Simple type for defining the names associated
with things such as functions, paramters, module name, etc.
Complex type used for defining the functions
invoked from within a particular function.
Complex type used for defining a custom comment type.
The type attribute allows the differentiation of the custom
comment types. If the custom comment is @example, then the
value in the 'tag' attribute would be 'example'.
Complex type used for defining the comments associated
with a library module, imports, variables, or functions.
The follow xqdoc 'directives' map to the equivalent
elements defined below ... with the exception of description
where there is no directive.
@author ...... author
@version ..... version
@param ....... param
@return ...... return
@error ....... error
@deprecated .. deprecated
@since ....... since
@see ......... see
Complex type used for comment text to allow the inclusion
of embedded HTML markup within comments.
Complex type used for defining information about the package
version (and date) used to generate the internal xqdoc XML.
Date should be the date when the XML xqdoc file is genearted.
Version should either be the version of the XQDoc conversion package
used to generate the XML or 'n/a' if the XML is generated from
some other mechanism (i.e. scripts from XHTML for MarkLogic).
Complex type used for defining the module URI and any
high-level comments associated with the module.
Complex type used for defining the namespaces defined within
the library module.
Complex type used for defining the variable names defined within
the library module and any comments associated with the variables.
Complex type used for defining the annotations defined for
a variable or function.
Complex type used for defining the imported modules within the
the library module and any comments associated with the imports.
Complex type used for defining the functions contained within the
the library module and any comments associated with the functions.
Any 'invoked' functions associated with this function should also
be defined.
Complex type used for defining the global root element of xqdoc.
There should be '1' xqdoc xml file for each library module.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy