Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

xqDoc annotations #2

Open
christianforster opened this issue Oct 17, 2013 · 1 comment
Open

xqDoc annotations #2

christianforster opened this issue Oct 17, 2013 · 1 comment
Labels

Comments

@christianforster
Copy link

In the master branch, commit 7ba4f551eedf82ed75357992bf6bd1aecf638839, some xqDoc annotation functionality seems to be broken:
In the code below, @see is not working as I expect. The following code produces the attached documentation, where @see is omitted.

(:~
 : This module …
 : 
 : @see http://www.example.org/
 : @author Christian Forster
 : @version 0.1
 :)

xquery function documentation 2013-10-17 13-25-47

Other issues occur in the functx documentation. The comment in its source code contains an email address and everything from the "@" part on does not appear in the generated documentation.
Also, within that module @author, @version, and @see annotations in function comments are ignored.

@joewiz joewiz added the bug label Mar 17, 2017
@duncdrum
Copy link
Contributor

duncdrum commented Mar 28, 2017

yup ran into this as well with in eXist 3.1.1, Java 8, macOS 10.12.4

(:~
: this …
: @return taxonomy[@type = "sexa"]
:)

becomes:

 <returns type="item()" cardinality="zero or more"> taxonomy[</returns>

according to inspect:inspect-module($module)

workaround:

(:~
: this …
: @return <taxonomy type = "sexa">…</taxonomy>
:)

exist-db main ticket is at eXist-db/exist#1386

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants