Hello Reece,

The reworked xqDoc handles Markdown in the comments. Please read the style guide here https://www.dropbox.com/s/7hckvowggp463j4/XQuery-Style-Guide.pdf?dl=0 https://www.dropbox.com/s/7hckvowggp463j4/XQuery-Style-Guide.pdf?dl=0

The processing of an xqDoc comment is handled by the following code: https://github.com/xqdoc/xqdoc/blob/master/src/main/java/org/xqdoc/XQDocComm... https://github.com/xqdoc/xqdoc/blob/master/src/main/java/org/xqdoc/XQDocComment.java

I have created some Polymer 3 based client side code for displaying xqDoc with hyperlinks to other function documents. It is located here: https://github.com/lcahlander/xqDoc-eXist-db/tree/master/src/main/polymer https://github.com/lcahlander/xqDoc-eXist-db/tree/master/src/main/polymer And the RestXQ code for eXist-db is here: https://github.com/lcahlander/xqDoc-eXist-db/blob/master/src/main/xquery/mod... https://github.com/lcahlander/xqDoc-eXist-db/blob/master/src/main/xquery/modules/xqdoc-lib.xqy

Regards, Loren

On Nov 5, 2019, at 4:41 PM, Reece Dunn msclrhd@googlemail.com wrote:

On Tue, 5 Nov 2019 at 19:56, Loren Cahlander <loren.cahlander@gmail.com mailto:loren.cahlander@gmail.com> wrote:

Hello folks,

June of 2018, I updated the xqDoc codebase to be able to handle the additions to the language for XQuery 3.1 and most of the vendor specific language extensions. I updated the parser to Antlr 4.

Darin McBeath, the creator of xqDoc, asked me if I wanted to take over the domain. I accepted. I will be updating the website http://xqDoc.org http://xqdoc.org/ and would like to get the community’s input.

What changes would people like to see in the website?

Not specifically related to the website, but the xqDoc specification, here are some of my thoughts:

1. It would be nice to use Markdown in addition to HTML for the comments (maybe via a `@format [html|markdown]` file-level annotation).
2. Support for grouping signatures, like for https://www.w3.org/TR/xpath-functions-31/#func-data https://www.w3.org/TR/xpath-functions-31/#func-data to avoid repeating documentation.
3. Support for grouping related APIs like the accessors, trigonometric functions, etc. in the W3C spec.
4. Providing a way to support the documentation style from the W3C specs (arguments described in place, custom sections -- summary, signatures, properties, rules, error conditions, notes, examples).
5. Reference a parameter in the documentation text.
6. More annotation options for more complex documentation (maybe aligning with some of the Doxygen functionality? -- http://www.doxygen.nl/manual/commands.html http://www.doxygen.nl/manual/commands.html).

Kind regards, Reece

xqDoc’s GitHub is officially at http://github.com/xqdoc http://github.com/xqdoc

Thank you,

Loren Cahlander