Try xquerydoc, which can extract XQDoc comments and style them in HTML and 
markdown. It's written in pure XQuery 1.0, with a small amount of XProc to 
drive the initial execution.

https://github.com/xquery/xquerydoc

John

On 24 Apr 2013, at 13:40, Jakob Fix <[email protected]>
 wrote:

> Hi,
> 
> I'm looking for ways to generate API documentation from our Xquery code. Of 
> course, there is Xqdoc, but I'm looking to get something that is a) a bit 
> better-looking and more importantly, b) usable by the developer who wants to 
> try out the API.
> 
> I've been looking at Swagger [1] which seems to do what I want. It expects a 
> JSON file that would need to be generated from the Xquery code. I think I 
> remember Adam Retter giving a talk on how to use 3.0 annotations for defining 
> the API in Prague a couple of years ago.
> 
> Are there already efforts underway to get something like this going?
> 
> I would be most interested,
> Jakob.
> 
> [1] https://developers.helloreverb.com/swagger/
> 
> _______________________________________________
> [email protected]
> http://x-query.com/mailman/listinfo/talk


_______________________________________________
[email protected]
http://x-query.com/mailman/listinfo/talk

Reply via email to