Skip to content
This repository has been archived by the owner on Sep 3, 2020. It is now read-only.

Commit

Permalink
tweak
Browse files Browse the repository at this point in the history
  • Loading branch information
@xquery
xquery committed Feb 21, 2012
1 parent 7f7e587 commit f324b5c
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,11 @@ xquerydoc will recursively search through for .xq, .xqy, .xqm and .xql
files and will generate html documentation placing the results in a default directory
named *xqdocs*. Your XQuery most follow xqDoc [coding conventions](https://github.com/xquery/xquerydoc/wiki/xqDoc-comment-style-example).

Note many people try to run xquerydoc on xquerydoc ... which is good
but realise that there are some *HUGE* parser files written in xquery
which will take a long time to generate docs for; suggest you test on
your own xquery.

Alternately you can supply xquerydoc with options, to specify the
directory containing XQuery, where you want to output documentation as
well as format of documentation.
Expand Down

0 comments on commit f324b5c

Please sign in to comment.