XQDoc Parser requires leading colons in doc-comment for @token documentation
Hello,
when using inspect:xqdoc#1 on a module, where the lines of doc comments do not start with a leading colon, as shown by the following example:
(:~ Description
@comment-token :)
the output will be missing the element for the @comment-tokens (i.e.:xqdoc:function/xqdoc:comment/xqdoc:param). They only get provided, if the leading colons are set, as in:
(:~ : Description : : @comment-token :)
Since I dislike to add the leading colons I opened up an issue at [1], but according to Loren Cahlander the parser does not seem to require them. Therefore I assume, that this could be implementation dependent.
The spec does not require the leading ':', but it seems, that BaseX does. Could the lack of leading colons be tolerated? That would be nice! Thank you.
Hi Andreas,
You can now omit the colon in comments. A new snapshot is available [1].
Hope this helps, Christian
Quoted text · Andreas Mixich · 37 lines
On Mon, Aug 24, 2020 at 4:41 PM Andreas Mixich <mixich.andreas at gmail.com> wrote: > > Hello, > > when using `inspect:xqdoc#1` on a module, where the lines of doc comments > do not start with a leading colon, as shown by the following example: > > (:~ > Description > > @comment-token > :) > > the output will be missing the element for the @comment-tokens > (i.e.:`xqdoc:function/xqdoc:comment/xqdoc:param`). They only > get provided, if the leading colons are set, as in: > > (:~ > : Description > : > : @comment-token > :) > > Since I dislike to add the leading colons I opened up an issue at [1], > but according to Loren Cahlander the parser does not seem to require > them. Therefore I assume, that this could be implementation dependent. > > The spec does not require the leading ':', but it seems, that BaseX does. > Could the lack of leading colons be tolerated? That would be nice! > Thank you. > > [1]: https://github.com/xqdoc/xqdoc/issues/4 > > -- > Goody Bye, Minden jót, Mit freundlichen Grüßen, > Andreas Mixich >
Quoted text · Christian Grün · 9 lines
Am 25.08.2020 um 09:26 schrieb Christian Grün: > Hi Andreas, > > You can now omit the colon in comments. A new snapshot is available [1]. > > Hope this helps, > Christian > > [1] https://files.basex.org/releases/latest/
Thank you, very much.
Written for BaseX 9.4. BaseX may have changed since: please check the current documentation.